xref: /freebsd/usr.sbin/apm/apm.8 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
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 enable
24.Op Fl e Ar enable
25.Op Fl h Ar enable
26.Op Fl r Ar delta
27.Pp
28.Nm zzz
29.Sh DESCRIPTION
30.Nm Apm
31controls the Intel / Microsoft APM (Advanced Power Management) BIOS and
32displays the current status of APM on laptop PCs.
33.Nm Zzz
34suspends the system by controlling APM.
35.Pp
36The following options are available for
37.Nm apm
38(no options are available for
39.Nm zzz
40).
41If no options are specified,
42.Nm apm
43displays information and current status of APM in verbose mode.
44If multiple display options are given, the values are displayed one
45per line in the order given here.
46.Bl -tag -width indent
47.It Fl a
48Display the current AC-line status as an integer value.  The values
490 and 1 correspond to the
50.Dq off-line
51state or
52.Dq on-line
53state, respectively.
54.It Fl b
55Display an integer value reflecting the current battery status.
56The values 0, 1, 2, 3, correspond to the
57.Dq high
58status,
59.Dq low
60status,
61.Dq critical
62status,
63.Dq charging
64status respectively.
65.It Fl d Ar enable
66Disable/enable suspending of the display separately from a normal suspend
67using the boolean value for
68.Ar enable .
69This feature seems to not work on many different laptops,
70including the Libretto 30CT and 50CT.
71.It Fl e Ar enable
72Enable or disable APM functions of the computer,
73depending on the boolean
74.Ar enable
75argument.
76.It Fl h Ar enable
77Depending on the boolean value of
78.Ar enable ,
79enable or disable the HLT instruction in the kernel context switch routine.
80These options are not necessary for almost all APM implementations,
81but for some implementations whose
82.Dq Pa Idle CPU
83call executes both CPU clock slowdown and HLT instruction,
84.Fl t
85is necessary to prevent the system from reducing its peak performance.
86See
87.Xr apm 4
88for details.
89.It Fl l
90Display the remaining battery percentage.  If your laptop does not
91support this function, 255 is displayed.
92.It Fl r
93Enable the resume wakeup timer, if the laptop supports it.  This
94doesn't actually suspend the laptop, but if the laptop is suspended,
95and it supports resume from suspend, then it will be resume after
96.Ar delta
97seconds (from when you run this command, not from when you suspend).
98.It Fl s
99Display the status of the APM support as an integer value.  The values
1000 and 1 correspond to the
101.Dq disabled
102state or
103.Dq enabled
104state respectively.
105.It Fl t
106Display the estimated remaining battery lifetime in seconds.  If
107it is unknown, -1 is displayed.
108.It Fl Z
109Transition the system into standby mode.  This mode uses less power than
110full power mode, but more than suspend mode.  Some laptops support
111resuming from this state on timer or Ring Indicator events.  The
112output of apm tells what your laptop claims to support.
113.It Fl z
114Suspend the system.
115It is equivalent to
116.Nm zzz .
117.El
118.Sh BUGS
119Some APM implementations do not support parameters needed by
120.Nm apm .
121On such systems,
122.Nm apm
123displays them as unknown.
124.Pp
125Some APM implementations cannot handle events such as pushing the
126power button or closing the cover.  On such implementations, the system
127.Ar must
128be suspended
129.Ar only
130by using
131.Nm apm
132or
133.Nm zzz .
134.Sh NOTES
135.Xr apmconf 8
136has been merged in
137.Xr apm 8
138and thus
139.Xr apm 8
140replaces all of its functionality.
141.Sh SEE ALSO
142.Xr apm 4
143.Sh AUTHORS
144.An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org
145