Copyright (c) 1996, 2010 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by John Kohl.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
.Dd March 20, 2010 .Dt APM 8 .Os .Sh NAME .Nm apm , .Nm zzz .Nd Advanced Power Management control program .Sh SYNOPSIS .Nm .Op Fl abdlmsSvz k -words .Op Fl f Ar sockname .Ek .Nm zzz .Op Fl Sz k -words .Op Fl f Ar sockname .Ek .Sh DESCRIPTION The .Nm program communicates with the Advanced Power Management
q Tn APM daemon, .Xr apmd 8 , making requests of the current power status or placing the system either into suspend or stand-by state. The .Nm tool is only installed on supported platforms.
p With no flags, .Nm displays the current power management state in verbose form.
p Available command-line flags are: l -tag -width "-f sockname" -compact t Fl z Put the system into suspend (deep sleep) mode. t Fl S Put the system into stand-by (light sleep) mode. t Fl l Display the estimated battery lifetime in percent. t Fl m Display the estimated battery lifetime in minutes. t Fl b Display the battery status: 0 means high, 1 means low, 2 means critical, 3 means charging, 4 means absent, and 255 means unknown. t Fl a Display the external charger (A/C status): 0 means disconnected, 1 means connected, 2 means backup power source, and 255 means unknown. t Fl s Display if power management is enabled. t Fl v Request more verbose description of the displayed states. t Fl f Ar sockname Set the name of the socket via which to contact .Xr apmd 8 to
a sockname . t Fl d Do not communicate with the APM daemon; attempt instead to manipulate the APM control device directly. .El
p The .Nm zzz variant of this command is an alternative for suspending the system. With no arguments, .Nm zzz places the system into suspend mode. The command line flags serve the same purpose as for the .Nm variant of this command.
p This command does not wait for positive confirmation that the requested mode has been entered; to do so would mean the command does not return until the system resumes from its sleep state. .Sh FILES
a /var/run/apmdev is the default UNIX-domain socket used for communication with .Xr apmd 8 . The .Fl f flag may be used to specify an alternate socket name. The protection modes on this socket govern which users may access the APM functions.
p
a /dev/apmctl is the control device which is used when the .Fl d flag is specified; it must be writable for the .Fl d flag to work successfully.
a /dev/apm is the status device used when the socket is not accessible; it must be readable to provide current APM status. .Sh SEE ALSO .Xr acpi 4 , .Xr apm 4 , .Xr apmd 8 .Rs .%A Intel Corporation .%A Microsoft Corporation .%T Advanced Power Management (APM) BIOS Interface Specification .%N Revision 1.2 .%D February 1996 .Re .Sh HISTORY The .Nm command appeared in .Nx 1.3 .
p The .Tn APM specification first appeared in 1992. The last update to the standard was made in 1996 - the same year when it was superceded by the .Tn ACPI 1.0 standard. Thereafter power management on IBM-compatible personal computers has relied on .Tn ACPI , implemented in .Nx by the .Xr acpi 4 subsystem. The .Xr acpi 4 provides an emulation layer for the legacy .Nm .