xref: /freebsd/usr.sbin/apm/apm.8 (revision 2ccbe549bc31256115b4b70a58ffccf9bb8aede5)
119a41dfcSPoul-Henning Kamp.\" LP (Laptop Package)
219a41dfcSPoul-Henning Kamp.\"
319a41dfcSPoul-Henning Kamp.\" Copyright (c) 1994 by HOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp>
419a41dfcSPoul-Henning Kamp.\"
519a41dfcSPoul-Henning Kamp.\" This software may be used, modified, copied, and distributed, in
619a41dfcSPoul-Henning Kamp.\" both source and binary form provided that the above copyright and
719a41dfcSPoul-Henning Kamp.\" these terms are retained. Under no circumstances is the author
819a41dfcSPoul-Henning Kamp.\" responsible for the proper functioning of this software, nor does
919a41dfcSPoul-Henning Kamp.\" the author assume any responsibility for damages incurred with its
1019a41dfcSPoul-Henning Kamp.\" use.
1119a41dfcSPoul-Henning Kamp.Dd November 1, 1994
1219a41dfcSPoul-Henning Kamp.Dt APM 8
1319a41dfcSPoul-Henning Kamp.Os
1419a41dfcSPoul-Henning Kamp.Sh NAME
1519a41dfcSPoul-Henning Kamp.Nm apm, zzz
1619a41dfcSPoul-Henning Kamp.Nd control the APM BIOS and display its information
1719a41dfcSPoul-Henning Kamp.Sh SYNOPSIS
1819a41dfcSPoul-Henning Kamp.Nm apm
19ec8f6ad7SJohn Polstra.Op Fl ablstz
20e46ea891SNate Williams.Op Fl d Ar 1|0
2119a41dfcSPoul-Henning Kamp.Pp
2219a41dfcSPoul-Henning Kamp.Nm zzz
2319a41dfcSPoul-Henning Kamp.Sh DESCRIPTION
24afe83a1cSPhilippe Charnier.Nm Apm
2519a41dfcSPoul-Henning Kampcontrols the Intel / Microsoft APM (Advanced Power Management) BIOS and
2619a41dfcSPoul-Henning Kampdisplays the current status of APM on laptop PCs.
27afe83a1cSPhilippe Charnier.Nm Zzz
2819a41dfcSPoul-Henning Kampsuspends the system by controlling APM.
2919a41dfcSPoul-Henning Kamp.Pp
3019a41dfcSPoul-Henning KampThe following options are available for
3119a41dfcSPoul-Henning Kamp.Nm apm
3219a41dfcSPoul-Henning Kamp(no options are available for
33afe83a1cSPhilippe Charnier.Nm zzz
34afe83a1cSPhilippe Charnier).
3519a41dfcSPoul-Henning KampIf no options are specified,
3619a41dfcSPoul-Henning Kamp.Nm apm
3719a41dfcSPoul-Henning Kampdisplays information and current status of APM in verbose mode.
38ec8f6ad7SJohn PolstraIf multiple display options are given, the values are displayed one
39ec8f6ad7SJohn Polstraper line in the order given here.
4019a41dfcSPoul-Henning Kamp.Bl -tag -width indent
41e46ea891SNate Williams.It Fl a
42e46ea891SNate WilliamsDisplay the current AC-line status as an integer value.  The values
43e46ea891SNate Williams0 and 1 correspond to the
44e46ea891SNate Williams.Dq off-line
45e46ea891SNate Williamsstate or
46e46ea891SNate Williams.Dq on-line
47e46ea891SNate Williamsstate, respectively.
4819a41dfcSPoul-Henning Kamp.It Fl b
4919a41dfcSPoul-Henning KampDisplay an integer value reflecting the current battery status.
5019a41dfcSPoul-Henning KampThe values 0, 1, 2, 3, correspond to the
5119a41dfcSPoul-Henning Kamp.Dq high
5219a41dfcSPoul-Henning Kampstatus,
5319a41dfcSPoul-Henning Kamp.Dq low
5419a41dfcSPoul-Henning Kampstatus,
5519a41dfcSPoul-Henning Kamp.Dq critical
5619a41dfcSPoul-Henning Kampstatus,
5719a41dfcSPoul-Henning Kamp.Dq charging
5819a41dfcSPoul-Henning Kampstatus respectively.
59e46ea891SNate Williams.It Fl d
60e46ea891SNate WilliamsDisable/enable suspending of the display separately from a normal suspend
612ccbe549SSteve Priceusing the values
62e46ea891SNate Williams.Ar 1
63e46ea891SNate Williamsor
64e46ea891SNate Williams.Ar 0
65e46ea891SNate Williamsrespectively.
6619a41dfcSPoul-Henning Kamp.It Fl l
6719a41dfcSPoul-Henning KampDisplay the remaining battery percentage.  If your laptop does not
6819a41dfcSPoul-Henning Kampsupport this function, 255 is displayed.
69b8d133e0SNate Williams.It Fl s
70b8d133e0SNate WilliamsDisplay the status of the APM support as an integer value.  The values
71b8d133e0SNate Williams0 and 1 correspond to the
72b8d133e0SNate Williams.Dq disabled
737a6b5d25SJohn Polstrastate or
747a6b5d25SJohn Polstra.Dq enabled
75afe83a1cSPhilippe Charnierstate respectively.
76ec8f6ad7SJohn Polstra.It Fl t
77ec8f6ad7SJohn PolstraDisplay the estimated remaining battery lifetime in seconds.  If
78ec8f6ad7SJohn Polstrait is unknown, -1 is displayed.
79e46ea891SNate Williams.It Fl z
80e46ea891SNate WilliamsSuspend the system. It is equivalent to
81e46ea891SNate Williams.Nm zzz .
822ccbe549SSteve Price.El
8319a41dfcSPoul-Henning Kamp.Sh BUGS
8419a41dfcSPoul-Henning KampSome APM implementations do not support parameters needed by
8519a41dfcSPoul-Henning Kamp.Nm apm .
8619a41dfcSPoul-Henning KampOn such systems,
8719a41dfcSPoul-Henning Kamp.Nm apm
8819a41dfcSPoul-Henning Kampdisplays them as unknown.
8919a41dfcSPoul-Henning Kamp.Pp
9019a41dfcSPoul-Henning KampSome APM implementations cannot handle events such as pushing the
9119a41dfcSPoul-Henning Kamppower button or closing the cover.  On such implementations, the system
9219a41dfcSPoul-Henning Kamp.Ar must
9319a41dfcSPoul-Henning Kampbe suspended
9419a41dfcSPoul-Henning Kamp.Ar only
9519a41dfcSPoul-Henning Kampby using
9619a41dfcSPoul-Henning Kamp.Nm apm
9719a41dfcSPoul-Henning Kampor
9819a41dfcSPoul-Henning Kamp.Nm zzz .
9919a41dfcSPoul-Henning Kamp.Sh SEE ALSO
10019a41dfcSPoul-Henning Kamp.Xr apm 4 ,
10119a41dfcSPoul-Henning Kamp.Xr apmconf 8
10219a41dfcSPoul-Henning Kamp.Sh AUTHOR
10319a41dfcSPoul-Henning KampHOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp> (Keio Univ., Japan)
104