xref: /freebsd/usr.sbin/apm/apm.8 (revision f9bc005b8ef3b507a5ecbc2d7fe4411ef70eff38)
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.\" use.
11.\"
12.Dd September 30, 2026
13.Dt APM 8 i386
14.Os
15.Sh NAME
16.Nm apm
17.Nd display power management status
18.Sh SYNOPSIS
19.Nm
20.Op Fl abltzZ
21.Sh DESCRIPTION
22The
23.Nm
24utility reports power management status.
25.Pp
26The options are as follows:
27.Bl -tag -width indent
28.It Fl a
29Display the current AC-line status as an integer value.
30The values
310, 1 and 2 correspond to the
32.Dq off-line
33state,
34.Dq on-line
35state or
36.Dq backup power
37state, respectively.
38.It Fl b
39Display an integer value reflecting the current battery status.
40The values 0, 1, 2, 3, correspond to the
41.Dq high
42status,
43.Dq low
44status,
45.Dq critical
46status,
47.Dq charging
48status respectively.
49.It Fl l
50Display the remaining battery percentage.
51If your laptop does not
52support this function, 255 is displayed.
53.It Fl t
54Display the estimated remaining battery lifetime in seconds.
55If
56it is unknown, -1 is displayed.
57.It Fl Z
58Transition the system into standby mode.
59This mode uses less power than
60full power mode, but more than suspend mode.
61.It Fl z
62Suspend the system.
63.El
64.Pp
65If no options are specified,
66.Nm
67displays information and current status of APM in verbose mode.
68If multiple display options are given, the values are displayed one
69per line in the order given here.
70.Sh SEE ALSO
71.Xr acpiconf 8 ,
72.Xr acpi 4 ,
73.Xr apm 4 ,
74.Xr zzz 8
75.Sh HISTORY
76The
77.Nm
78utility originally controlled the Advanced Power Management (APM) BIOS
79extension on i386,
80now it interfaces with ACPI.
81.Sh AUTHORS
82.An Tatsumi Hosokawa Aq Mt hosokawa@jp.FreeBSD.org
83