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