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
29 .\" $FreeBSD: src/usr.sbin/apmd/apmd.8,v 1.7.2.7 2003/03/11 21:13:47 trhodes Exp $
36 .Nd Advanced Power Management monitor daemon
46 monitors the occurrence of the specified Advanced Power Management
48 events and, if one of the events occurs, it executes the sequence of
49 commands corresponding to the event. Only the events specified in the
50 configuration file are notified to
52 all other events are ignored. For each event posted by the APM BIOS,
54 invokes the sequence of commands specified in the configuration file.
57 is running with monitoring suspend/standby requests,
58 the kernel will not process those requests.
59 Therefore, if you wish action to be taken when these events
60 occur, you need to explicitly configure the appropriate commands or
61 built-in functions in the configuration file.
65 utility recognizes the following runtime options:
66 .Bl -tag -width ".Fl f Ar file"
68 Starts in debug mode. This causes
70 to execute in the foreground instead of in daemon mode.
72 Specifies a different configuration file
74 to be used in place of the default
82 starts, it reads the configuration file
85 and notifies the set of events to be monitored to the APM device driver.
86 When it terminates, the APM device driver automatically cancels
93 it will reread its configuration file and
94 notify the APM device driver of any changes to its configuration.
98 utility uses the device
102 requests for monitoring events and for controlling the APM system.
103 This device file is opened exclusively, so only a single
105 process can be running at any time.
109 receives an APM event, it forks a child process to execute the
110 commands specified in the configuration file and then continues
111 listening for more events. The child process executes the commands
112 specified, one at a time and in the order that they are listed.
116 is processing the command list for SUSPEND/STANDBY requests, the APM kernel
117 device driver issues notifications to APM BIOS once per second so that the
118 BIOS knows that there are still some commands pending, and that it should not
119 complete the request just yet.
123 utility creates the file
124 .Pa /var/run/apmd.pid ,
125 and stores its process
127 This can be used to kill or reconfigure
129 .Sh CONFIGURATION FILE
132 configuration file is quite simple. For example:
134 apm_event SUSPENDREQ {
135 exec "sync && sync && sync";
143 to receive the APM event
145 (which may be posted by an LCD close), run the
147 command 3 times and wait for a while, then execute
148 .Nm zzz ( Ns Nm apm Fl z )
149 to put the system in the suspend state.
152 The apm_event keyword
153 .Bd -ragged -offset indent
155 is the keyword which indicates the start of configuration for
160 .Bd -ragged -offset indent
161 If you wish to execute the same commands for different events, the
162 event names should be delimited by a comma. The following are
166 - Events ignored by the kernel if
170 .Bl -tag -width USERSUSPENDREQ -compact -offset indent
174 should include sync in the command list,
176 should include sync in the command list,
178 only zzz should be specified in the command list.
183 after kernel handling:
185 .Bl -tag -width USERSUSPENDREQ -compact -offset indent
191 .It CAPABILITIESCHANGE
194 Other events will not be sent to
200 .Bd -ragged -offset indent
201 In the example above, the three lines beginning with
203 are commands for the event.
204 Each line should be terminated with a semicolon.
205 The command list for the event should be enclosed by
213 for double-quotation enclosed command execution, just as with
215 Each command is executed in order until the end of
216 the list is reached or a command finishes with a non-zero status code.
219 utility will report any failed command's status code via
221 and will then reject the request event posted by the APM BIOS.
225 .Bd -ragged -offset indent
228 built-in functions instead of command lines.
229 A built-in function name should be terminated with a semicolon,
230 just as with a command line.
231 The following built-in functions are currently supported:
232 .Bl -tag -width "- reject:"
234 Reject last request posted by APM BIOS. This can be used to reject
235 a SUSPEND request when the LCD is closed and put the system in a
236 STANDBY state instead.
241 .Bl -tag -width /etc/apmd.conf -compact
242 .It Pa /etc/apmd.conf
244 .It Pa /var/run/apmd.pid
247 Sample configuration commands include:
249 apm_event SUSPENDREQ {
250 exec "/etc/rc.suspend";
253 apm_event USERSUSPENDREQ {
254 exec "sync && sync && sync";
259 apm_event NORMRESUME, STANDBYRESUME {
260 exec "/etc/rc.resume";
263 # resume event configuration for serial mouse users by
264 # reinitializing a moused(8) connected to a serial port.
266 #apm_event NORMRESUME {
267 # exec "kill -HUP `cat /var/run/moused.pid`";
270 # suspend request event configuration for ATA HDD users:
271 # execute standby instead of suspend.
273 #apm_event SUSPENDREQ {
275 # exec "sync && sync && sync";
289 .An Mitsuru IWASAKI Aq Mt iwasaki@FreeBSD.org
290 .An KOIE Hidetaka Aq Mt koie@suri.co.jp
293 Some contributions made by
294 .An Warner Losh Aq Mt imp@FreeBSD.org ,
295 .An Hiroshi Yamashita Aq Mt bluemoon@msj.biglobe.ne.jp ,
296 .An Yoshihiko SARUMARU Aq Mt mistral@imasy.or.jp ,
297 .An Norihiro Kumagai Aq Mt kuma@nk.rim.or.jp ,
298 .An NAKAGAWA Yoshihisa Aq Mt nakagawa@jp.FreeBSD.org ,
300 .An Nick Hilliard Aq Mt nick@foobar.org .