freebsd-dev/usr.sbin/apm/apm.8

.\" LP (Laptop Package)
.\" 
.\" Copyright (c) 1994 by Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org>
.\" 
.\" This software may be used, modified, copied, and distributed, in
.\" both source and binary form provided that the above copyright and
.\" these terms are retained. Under no circumstances is the author 
.\" responsible for the proper functioning of this software, nor does 
.\" the author assume any responsibility for damages incurred with its 
.\" use.
.Dd November 1, 1994
.Dt APM 8
.Os
.Sh NAME
.Nm apm, zzz
.Nd control the APM BIOS and display its information
.Sh SYNOPSIS
.Nm apm
.Op Fl ablstz
.Op Fl d Ar 1|0
.Pp
.Nm zzz
.Sh DESCRIPTION
.Nm Apm
controls the Intel / Microsoft APM (Advanced Power Management) BIOS and 
displays the current status of APM on laptop PCs.
.Nm Zzz 
suspends the system by controlling APM.
.Pp
The following options are available for 
.Nm apm
(no options are available for
.Nm zzz
).
If no options are specified,
.Nm apm
displays information and current status of APM in verbose mode.
If multiple display options are given, the values are displayed one
per line in the order given here.
.Bl -tag -width indent
.It Fl a
Display the current AC-line status as an integer value.  The values
0 and 1 correspond to the 
.Dq off-line
state or
.Dq on-line
state, respectively.
.It Fl b
Display an integer value reflecting the current battery status.
The values 0, 1, 2, 3, correspond to the 
.Dq high
status, 
.Dq low
status, 
.Dq critical
status,
.Dq charging
status respectively.
.It Fl d
Disable/enable suspending of the display separately from a normal suspend
using the values
.Ar 1
or
.Ar 0
respectively.
.It Fl l
Display the remaining battery percentage.  If your laptop does not 
support this function, 255 is displayed.
.It Fl s
Display the status of the APM support as an integer value.  The values
0 and 1 correspond to the
.Dq disabled
state or
.Dq enabled
state respectively.
.It Fl t
Display the estimated remaining battery lifetime in seconds.  If
it is unknown, -1 is displayed.
.It Fl z
Suspend the system. It is equivalent to
.Nm zzz .
.El
.Sh BUGS
Some APM implementations do not support parameters needed by
.Nm apm .
On such systems,
.Nm apm
displays them as unknown.
.Pp
Some APM implementations cannot handle events such as pushing the 
power button or closing the cover.  On such implementations, the system
.Ar must
be suspended
.Ar only
by using
.Nm apm
or 
.Nm zzz .
.Sh SEE ALSO
.Xr apm 4 ,
.Xr apmconf 8
.Sh AUTHORS
.An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.\" LP (Laptop Package)`
			`.\"`
Updated my e-mail addresses. 1998-02-20 07:17:48 +00:00			`.\" Copyright (c) 1994 by Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org>`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.\"`
			`.\" This software may be used, modified, copied, and distributed, in`
			`.\" both source and binary form provided that the above copyright and`
			`.\" these terms are retained. Under no circumstances is the author`
			`.\" responsible for the proper functioning of this software, nor does`
			`.\" the author assume any responsibility for damages incurred with its`
			`.\" use.`
			`.Dd November 1, 1994`
			`.Dt APM 8`
			`.Os`
			`.Sh NAME`
			`.Nm apm, zzz`
			`.Nd control the APM BIOS and display its information`
			`.Sh SYNOPSIS`
			`.Nm apm`
Output the estimated battery lifetime as "hh:mm:ss" along with everything else. Add a "-t" option for outputting it in raw form. Define and document the order in which raw values are printed when more than one is requested on the command line. 1997-11-12 04:16:23 +00:00			`.Op Fl ablstz`
Re-write the driver to use getopt(), add the new display suspend function of the kernel, and other assorted misc. cleanups. Submitted by: nate & HOSOKAWA, Tatsumi <hosokawa@jp.FreeBSD.org> 1997-01-06 06:04:42 +00:00			`.Op Fl d Ar 1\|0`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.Pp`
			`.Nm zzz`
			`.Sh DESCRIPTION`
Use err(3). Typo in man page. 1997-09-02 06:36:39 +00:00			`.Nm Apm`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`controls the Intel / Microsoft APM (Advanced Power Management) BIOS and`
			`displays the current status of APM on laptop PCs.`
Use err(3). Typo in man page. 1997-09-02 06:36:39 +00:00			`.Nm Zzz`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`suspends the system by controlling APM.`
			`.Pp`
			`The following options are available for`
			`.Nm apm`
			`(no options are available for`
Use err(3). Typo in man page. 1997-09-02 06:36:39 +00:00			`.Nm zzz`
			`).`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`If no options are specified,`
			`.Nm apm`
			`displays information and current status of APM in verbose mode.`
Output the estimated battery lifetime as "hh:mm:ss" along with everything else. Add a "-t" option for outputting it in raw form. Define and document the order in which raw values are printed when more than one is requested on the command line. 1997-11-12 04:16:23 +00:00			`If multiple display options are given, the values are displayed one`
			`per line in the order given here.`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.Bl -tag -width indent`
Re-write the driver to use getopt(), add the new display suspend function of the kernel, and other assorted misc. cleanups. Submitted by: nate & HOSOKAWA, Tatsumi <hosokawa@jp.FreeBSD.org> 1997-01-06 06:04:42 +00:00			`.It Fl a`
			`Display the current AC-line status as an integer value. The values`
			`0 and 1 correspond to the`
			`.Dq off-line`
			`state or`
			`.Dq on-line`
			`state, respectively.`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.It Fl b`
			`Display an integer value reflecting the current battery status.`
			`The values 0, 1, 2, 3, correspond to the`
			`.Dq high`
			`status,`
			`.Dq low`
			`status,`
			`.Dq critical`
			`status,`
			`.Dq charging`
			`status respectively.`
Re-write the driver to use getopt(), add the new display suspend function of the kernel, and other assorted misc. cleanups. Submitted by: nate & HOSOKAWA, Tatsumi <hosokawa@jp.FreeBSD.org> 1997-01-06 06:04:42 +00:00			`.It Fl d`
			`Disable/enable suspending of the display separately from a normal suspend`
Fix a couple of typos. PR: 5561 Submitted by: Kazuo Horikawa <k-horik@yk.rim.or.jp> 1998-01-25 16:22:22 +00:00			`using the values`
Re-write the driver to use getopt(), add the new display suspend function of the kernel, and other assorted misc. cleanups. Submitted by: nate & HOSOKAWA, Tatsumi <hosokawa@jp.FreeBSD.org> 1997-01-06 06:04:42 +00:00			`.Ar 1`
			`or`
			`.Ar 0`
			`respectively.`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.It Fl l`
			`Display the remaining battery percentage. If your laptop does not`
			`support this function, 255 is displayed.`
Add the '-s' flag to apm which returns the status of the APM support (enable/disabled) now that the APM_GETINFO ioctl returns the necessary information. Also, print out the status along with the other information as the default behavior. 1996-03-13 00:48:06 +00:00			`.It Fl s`
			`Display the status of the APM support as an integer value. The values`
			`0 and 1 correspond to the`
			`.Dq disabled`
Correct the description of the output from the "-s" option. It was backward. 1997-09-29 17:43:11 +00:00			`state or`
			`.Dq enabled`
Use err(3). Typo in man page. 1997-09-02 06:36:39 +00:00			`state respectively.`
Output the estimated battery lifetime as "hh:mm:ss" along with everything else. Add a "-t" option for outputting it in raw form. Define and document the order in which raw values are printed when more than one is requested on the command line. 1997-11-12 04:16:23 +00:00			`.It Fl t`
			`Display the estimated remaining battery lifetime in seconds. If`
			`it is unknown, -1 is displayed.`
Re-write the driver to use getopt(), add the new display suspend function of the kernel, and other assorted misc. cleanups. Submitted by: nate & HOSOKAWA, Tatsumi <hosokawa@jp.FreeBSD.org> 1997-01-06 06:04:42 +00:00			`.It Fl z`
			`Suspend the system. It is equivalent to`
Fix a couple of typos. PR: 5561 Submitted by: Kazuo Horikawa <k-horik@yk.rim.or.jp> 1998-01-25 16:22:22 +00:00			`.Nm zzz .`
			`.El`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.Sh BUGS`
			`Some APM implementations do not support parameters needed by`
Fix a couple of typos. PR: 5561 Submitted by: Kazuo Horikawa <k-horik@yk.rim.or.jp> 1998-01-25 16:22:22 +00:00			`.Nm apm .`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`On such systems,`
			`.Nm apm`
			`displays them as unknown.`
			`.Pp`
			`Some APM implementations cannot handle events such as pushing the`
			`power button or closing the cover. On such implementations, the system`
			`.Ar must`
			`be suspended`
			`.Ar only`
			`by using`
			`.Nm apm`
			`or`
Fix a couple of typos. PR: 5561 Submitted by: Kazuo Horikawa <k-horik@yk.rim.or.jp> 1998-01-25 16:22:22 +00:00			`.Nm zzz .`
The latest user-land changes from the author. I added a big warning to the apm.4 man-page. I also hope the Makefiles make sense now. Submitted by: HOSOKAWA Tatsumi 1994-11-01 22:46:40 +00:00			`.Sh SEE ALSO`
			`.Xr apm 4 ,`
			`.Xr apmconf 8`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.Sh AUTHORS`
			`.An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org`