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 Aq <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
44 monitors the occurrence of the specified Advanced Power Management
46 events and, if one of the events occurs, it executes the sequence of
47 commands corresponding to the event. Only the events specified in the
48 configuration file are notified to
50 all other events are ignored. For each event posted by the APM BIOS,
52 invokes the sequence of commands specified in the configuration file.
55 is running with monitoring suspend/standby requests,
56 the kernel will not process those requests.
57 Therefore, if you wish action to be taken when these events
58 occur, you need to explicitly configure the appropriate commands or
59 built-in functions in the configuration file.
62 recognizes the following runtime options:
63 .Bl -tag -width -f_file
65 Starts in debug mode. This causes
67 to execute in the foreground instead of in daemon mode.
69 Specifies a different configuration file
71 to be used in place of the default
79 starts, it reads the configuration file
82 and notifies the set of events to be monitored to the APM device driver.
83 When it terminates, the APM device driver automatically cancels
88 process receives a SIGHUP, it will reread its configuration file and
89 notify the APM device driver of any changes to its configuration.
96 requests for monitoring events and for controlling the APM system.
97 This device file is opened exclusively, so only a single
99 process can be running at any time.
103 receives an APM event, it forks a child process to execute the
104 commands specified in the configuration file and then continues
105 listening for more events. The child process executes the commands
106 specified, one at a time and in the order that they are listed.
110 is processing the command list for SUSPEND/STANDBY requests, the APM kernel
111 device driver issues notifications to APM BIOS once per second so that the
112 BIOS knows that there are still some commands pending, and that it should not
113 complete the request just yet.
117 daemon creates the file
118 .Pa /var/run/apmd.pid ,
119 and stores its process
121 This can be used to kill or reconfigure
123 .Sh CONFIGURATION FILE
126 configuration file is quite simple. For example:
129 apm_event SUSPENDREQ {
130 exec "sync && sync && sync";
138 to receive the APM event
140 (which may be posted by an LCD close), run the
142 command 3 times and wait for a while, then execute
143 .Nm zzz ( Ns Nm apm Fl z )
144 to put the system in the suspend state.
148 The apm_event keyword
149 .Bd -ragged -offset indent
151 is the keyword which indicates the start of configuration for
156 .Bd -ragged -offset indent
157 If you wish to execute the same commands for different events, the
158 event names should be delimited by a comma. The following are
162 - Events ignored by the kernel if
166 .Bl -tag -width USERSUSPENDREQ -compact -offset indent
170 should include sync in the command list,
172 should include sync in the command list,
174 only zzz should be specified in the command list.
179 after kernel handling:
181 .Bl -tag -width USERSUSPENDREQ -compact -offset indent
187 .It CAPABILITIESCHANGE
190 Other events will not be sent to
196 .Bd -ragged -offset indent
197 In the example above, the three lines begining with
199 are commands for the event.
200 Each line should be terminated with a semicolon.
201 The command list for the event should be enclosed by
208 for double-quotation enclosed command execution, just as with
210 Each command is executed in order until the end of
211 the list is reached or a command finishes with a non-zero status code.
213 will report any failed command's status code via
215 and will then reject the request event posted by the APM BIOS.
219 .Bd -ragged -offset indent
222 built-in functions instead of command lines.
223 A built-in function name should be terminated with a semicolon,
224 just as with a command line.
225 The following built-in functions are currently supported:
229 .Bd -ragged -offset indent
230 Reject last request posted by APM BIOS. This can be used to reject
231 a SUSPEND request when the LCD is closed and put the system in a
232 STANDBY state instead.
238 Sample configuration commands include:
240 apm_event SUSPENDREQ {
241 exec "/etc/rc.suspend";
244 apm_event USERSUSPENDREQ {
245 exec "sync && sync && sync";
250 apm_event NORMRESUME, STANDBYRESUME {
251 exec "/etc/rc.resume";
254 # resume event configuration for serial mouse users by
255 # reinitializing a moused(8) connected to a serial port.
257 #apm_event NORMRESUME {
258 # exec "kill -HUP `cat /var/run/moused.pid`";
261 # suspend request event configuration for ATA HDD users:
262 # execute standby instead of suspend.
264 #apm_event SUSPENDREQ {
266 # exec "sync && sync && sync";
272 .Bl -tag -width /etc/apmd.conf -compact
273 .It Pa /etc/apmd.conf
275 .It Pa /var/run/apmd.pid
281 .An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org
282 .An KOIE Hidetaka Aq koie@suri.co.jp
284 Some contributions made by
285 .An Warner Losh Aq imp@FreeBSD.org ,
286 .An Hiroshi Yamashita Aq bluemoon@msj.biglobe.ne.jp ,
287 .An Yoshihiko SARUMARU Aq mistral@imasy.or.jp ,
288 .An Norihiro Kumagai Aq kuma@nk.rim.or.jp ,
289 .An NAKAGAWA Yoshihisa Aq nakagawa@jp.FreeBSD.org ,
291 .An Nick Hilliard Aq nick@foobar.org .