xref: /freebsd/usr.sbin/apm/apm.8 (revision e627b39baccd1ec9129690167cf5e6d860509655)
1.\" LP (Laptop Package)
2.\"
3.\" Copyright (c) 1994 by HOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp>
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 z
20.Op Fl b
21.Op Fl a
22.Op Fl l
23.Op Fl s
24.Pp
25.Nm zzz
26.Sh DESCRIPTION
27.Nm apm
28controls the Intel / Microsoft APM (Advanced Power Management) BIOS and
29displays the current status of APM on laptop PCs.
30.Nm zzz
31suspends the system by controlling APM.
32.Pp
33The following options are available for
34.Nm apm
35(no options are available for
36.Nm zzz.
37)
38If no options are specified,
39.Nm apm
40displays information and current status of APM in verbose mode.
41.Bl -tag -width indent
42.It Fl z
43Suspend the system. It is equivalent to
44.Nm zzz.
45.Pp
46.It Fl b
47Display an integer value reflecting the current battery status.
48The values 0, 1, 2, 3, correspond to the
49.Dq high
50status,
51.Dq low
52status,
53.Dq critical
54status,
55.Dq charging
56status respectively.
57.Pp
58.It Fl a
59Display the current AC-line status as an integer value.  The values
600 and 1 correspond to the
61.Dq off-line
62state or
63.Dq on-line
64state, respectively.
65.Pp
66.It Fl l
67Display the remaining battery percentage.  If your laptop does not
68support this function, 255 is displayed.
69.Pp
70.It Fl s
71Display the status of the APM support as an integer value.  The values
720 and 1 correspond to the
73.Dq enabled
74state or
75.Dq disabled
76state respecitively
77.Sh BUGS
78Some APM implementations do not support parameters needed by
79.Nm apm.
80On such systems,
81.Nm apm
82displays them as unknown.
83.Pp
84Some APM implementations cannot handle events such as pushing the
85power button or closing the cover.  On such implementations, the system
86.Ar must
87be suspended
88.Ar only
89by using
90.Nm apm
91or
92.Nm zzz.
93.Sh SEE ALSO
94.Xr apm 4 ,
95.Xr apmconf 8
96.Sh AUTHOR
97HOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp> (Keio Univ., Japan)
98