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