xref: /freebsd/usr.sbin/apm/apm.8 (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
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 ablsz
20.Op Fl d Ar 1|0
21.Pp
22.Nm zzz
23.Sh DESCRIPTION
24.Nm Apm
25controls the Intel / Microsoft APM (Advanced Power Management) BIOS and
26displays the current status of APM on laptop PCs.
27.Nm Zzz
28suspends the system by controlling APM.
29.Pp
30The following options are available for
31.Nm apm
32(no options are available for
33.Nm zzz
34).
35If no options are specified,
36.Nm apm
37displays information and current status of APM in verbose mode.
38.Bl -tag -width indent
39.It Fl a
40Display the current AC-line status as an integer value.  The values
410 and 1 correspond to the
42.Dq off-line
43state or
44.Dq on-line
45state, respectively.
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.It Fl d
58Disable/enable suspending of the display separately from a normal suspend
59using using the values
60.Ar 1
61or
62.Ar 0
63respectively.
64.It Fl l
65Display the remaining battery percentage.  If your laptop does not
66support this function, 255 is displayed.
67.It Fl s
68Display the status of the APM support as an integer value.  The values
690 and 1 correspond to the
70.Dq disabled
71state or
72.Dq enabled
73state respectively.
74.It Fl z
75Suspend the system. It is equivalent to
76.Nm zzz.
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