1 .\" Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
2 .\" Copyright (c) 1999 KOIE Hidetaka <koie@suri.co.jp>
3 .\" Copyright (c) 1999 Yoshihiko SARUMARU <mistral@imasy.or.jp>
4 .\" Copyright (c) 1999 Norihiro Kumagai <kuma@nk.rim.or.jp>
5 .\" All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)apmd.8 1.1 (FreeBSD) 6/28/99
36 .Nd Advanced Power Management monitor daemon
47 monitors the occurrence of the specified Advanced Power Management
49 events and, if one of the events occurs, it executes the sequence of
50 commands corresponding to the event.
51 Only the events specified in the
52 configuration file are notified to
54 all other events are ignored.
55 For each event posted by the APM BIOS,
57 invokes the sequence of commands specified in the configuration file.
60 is running with monitoring suspend/standby requests,
61 the kernel will not process those requests.
62 Therefore, if you wish action to be taken when these events
63 occur, you need to explicitly configure the appropriate commands or
64 built-in functions in the configuration file.
68 utility recognizes the following runtime options:
69 .Bl -tag -width -f_file
74 to execute in the foreground instead of in daemon mode.
76 Specifies a different configuration file
78 to be used in place of the default
83 to simulate a POWERSTATECHANGE event when a power state change is detected
84 (AC_POWER_STATE) but the bios of the laptop does not report it.
85 This enables you to do things like dimming the LCD backlight when you unplug
93 starts, it reads the configuration file
96 and notifies the set of events to be monitored to the APM device driver.
97 When it terminates, the APM device driver automatically cancels
104 it will reread its configuration file and
105 notify the APM device driver of any changes to its configuration.
109 utility uses the device
113 requests for monitoring events and for controlling the APM system.
114 This device file is opened exclusively, so only a single
116 process can be running at any time.
120 receives an APM event, it forks a child process to execute the
121 commands specified in the configuration file and then continues
122 listening for more events.
123 The child process executes the commands
124 specified, one at a time and in the order that they are listed.
128 is processing the command list for SUSPEND/STANDBY requests, the APM kernel
129 device driver issues notifications to APM BIOS once per second so that the
130 BIOS knows that there are still some commands pending, and that it should not
131 complete the request just yet.
135 utility creates the file
136 .Pa /var/run/apmd.pid ,
137 and stores its process
139 This can be used to kill or reconfigure
141 .Sh CONFIGURATION FILE
144 configuration file is quite simple.
147 apm_event SUSPENDREQ {
148 exec "sync && sync && sync";
156 to receive the APM event
158 (which may be posted by an LCD close), run the
160 command 3 times and wait for a while, then execute
161 .Nm zzz ( Ns Nm apm Fl z )
162 to put the system in the suspend state.
165 The apm_event keyword
166 .Bd -ragged -offset indent
168 is the keyword which indicates the start of configuration for
173 .Bd -ragged -offset indent
174 If you wish to execute the same commands for different events, the
175 event names should be delimited by a comma.
180 - Events ignored by the kernel if
184 .Bl -tag -width USERSUSPENDREQ -compact -offset indent
188 should include sync in the command list,
190 should include sync in the command list,
192 only zzz should be specified in the command list.
197 after kernel handling:
199 .Bl -tag -width USERSUSPENDREQ -compact -offset indent
205 .It CAPABILITIESCHANGE
208 Other events will not be sent to
214 .Bd -ragged -offset indent
215 In the example above, the three lines beginning with
217 are commands for the event.
218 Each line should be terminated with a semicolon.
219 The command list for the event should be enclosed by
227 for double-quotation enclosed command execution, just as with
229 Each command is executed in order until the end of
230 the list is reached or a command finishes with a non-zero status code.
233 utility will report any failed command's status code via
235 and will then reject the request event posted by the APM BIOS.
239 .Bd -ragged -offset indent
242 built-in functions instead of command lines.
243 A built-in function name should be terminated with a semicolon,
244 just as with a command line.
245 The following built-in functions are currently supported:
249 .Bd -ragged -offset indent
250 Reject last request posted by APM BIOS.
251 This can be used to reject
252 a SUSPEND request when the LCD is closed and put the system in a
253 STANDBY state instead.
259 .Bl -tag -width /etc/apmd.conf -compact
260 .It Pa /etc/apmd.conf
262 .It Pa /var/run/apmd.pid
265 Sample configuration commands include:
267 apm_event SUSPENDREQ {
268 exec "/etc/rc.suspend apm suspend";
271 apm_event USERSUSPENDREQ {
272 exec "sync && sync && sync";
277 apm_event NORMRESUME {
278 exec "/etc/rc.resume apm suspend";
281 apm_event STANDBYRESUME {
282 exec "/etc/rc.resume apm standby";
285 # resume event configuration for serial mouse users by
286 # reinitializing a moused(8) connected to a serial port.
288 #apm_event NORMRESUME {
289 # exec "kill -HUP `cat /var/run/moused.pid`";
292 # suspend request event configuration for ATA HDD users:
293 # execute standby instead of suspend.
295 #apm_event SUSPENDREQ {
297 # exec "sync && sync && sync";
311 .An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org
312 .An KOIE Hidetaka Aq koie@suri.co.jp
315 Some contributions made by
316 .An Warner Losh Aq imp@FreeBSD.org ,
317 .An Hiroshi Yamashita Aq bluemoon@msj.biglobe.ne.jp ,
318 .An Yoshihiko SARUMARU Aq mistral@imasy.or.jp ,
319 .An Norihiro Kumagai Aq kuma@nk.rim.or.jp ,
320 .An NAKAGAWA Yoshihisa Aq nakagawa@jp.FreeBSD.org ,
322 .An Nick Hilliard Aq nick@foobar.org .