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