xref: /freebsd/usr.sbin/apm/apm.8 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1.\" LP (Laptop Package)
2.\"
3.\" Copyright (c) 1994 by Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org>
4.\"
5.\" This software may be used, modified, copied, and distributed, in
6.\" both source and binary form provided that the above copyright and
7.\" these terms are retained. Under no circumstances is the author
8.\" responsible for the proper functioning of this software, nor does
9.\" the author assume any responsibility for damages incurred with its
10.\" use.
11.Dd November 1, 1994
12.Dt APM 8
13.Os
14.Sh NAME
15.Nm apm, zzz
16.Nd control the APM BIOS and display its information
17.Sh SYNOPSIS
18.Nm apm
19.Op Fl ablstzZ
20.Op Fl d Ar 1|0
21.Op Fl r Ar delta
22.Pp
23.Nm zzz
24.Sh DESCRIPTION
25.Nm Apm
26controls the Intel / Microsoft APM (Advanced Power Management) BIOS and
27displays the current status of APM on laptop PCs.
28.Nm Zzz
29suspends the system by controlling APM.
30.Pp
31The following options are available for
32.Nm apm
33(no options are available for
34.Nm zzz
35).
36If no options are specified,
37.Nm apm
38displays information and current status of APM in verbose mode.
39If multiple display options are given, the values are displayed one
40per line in the order given here.
41.Bl -tag -width indent
42.It Fl a
43Display the current AC-line status as an integer value.  The values
440 and 1 correspond to the
45.Dq off-line
46state or
47.Dq on-line
48state, respectively.
49.It Fl b
50Display an integer value reflecting the current battery status.
51The values 0, 1, 2, 3, correspond to the
52.Dq high
53status,
54.Dq low
55status,
56.Dq critical
57status,
58.Dq charging
59status respectively.
60.It Fl d
61Disable/enable suspending of the display separately from a normal suspend
62using the values
63.Ar 1
64or
65.Ar 0
66respectively.  This argument seems to not work on many different
67laptops, including the Libretto 30CT and 50CT.
68.It Fl l
69Display the remaining battery percentage.  If your laptop does not
70support this function, 255 is displayed.
71.It Fl r
72Enable the resume wakeup timer, if the laptop supports it.  This
73doesn't actually suspend the laptop, but if the laptop is suspended,
74and it supports resume from suspend, then it will be resume after
75.Ar delta
76seconds (from when you run this command, not from when you suspend).
77.It Fl s
78Display the status of the APM support as an integer value.  The values
790 and 1 correspond to the
80.Dq disabled
81state or
82.Dq enabled
83state respectively.
84.It Fl t
85Display the estimated remaining battery lifetime in seconds.  If
86it is unknown, -1 is displayed.
87.It Fl Z
88Transition the system into standby mode.  This mode uses less power than
89full power mode, but more than suspend mode.  Some laptops support
90resuming from this state on timer or Ring Indicator events.  The
91output of apm tells what your laptop claims to support.
92.It Fl z
93Suspend the system. It is equivalent to
94.Nm zzz .
95.El
96.Sh BUGS
97Some APM implementations do not support parameters needed by
98.Nm apm .
99On such systems,
100.Nm apm
101displays them as unknown.
102.Pp
103Some APM implementations cannot handle events such as pushing the
104power button or closing the cover.  On such implementations, the system
105.Ar must
106be suspended
107.Ar only
108by using
109.Nm apm
110or
111.Nm zzz .
112.Sh SEE ALSO
113.Xr apm 4 ,
114.Xr apmconf 8
115.Sh AUTHORS
116.An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org
117