d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a41801c68a
freebsd-skq/usr.sbin/apm/apm.8

145 lines
3.8 KiB
Groff
Raw Normal View History

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
Add $Id$, to make it simpler for members of the translation teams to track. The Id line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 20:12:29 +00:00
.\"
$Id$ -> $FreeBSD$
1999-08-28 01:35:59 +00:00
.\" $FreeBSD$
Add $Id$, to make it simpler for members of the translation teams to track. The Id line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 20:12:29 +00:00
.\"
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
.\" 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
Import the apmconf function descriptions as per modified patch from green.
2000-01-22 18:28:23 +00:00
.Op Fl ablstzZ
.Op Fl d Ar enable
.Op Fl e Ar enable
.Op Fl h Ar enable
o Enable standby mode in apm utility. You need a newer kernel for this functionality to work (however, the kernel changes were committed to current at 1998/07/05 23:29:11 PDT). o Enable setting of a timer for later wakeup. Note, not all APM BIOSes support this for all modes (mine doesn't support waking up on a timer from standby mode). o Print out the APM capabilities, as reported by the BIOS. o Report wake on ring indication. No way to enable/disable this, but it is reported. o update man page with above o The output of this command has changed, so if you have a script that parses its output, then you may need to rewrite it slightly. o The code attempts to deal with older kernels than July 5, 1998, but that part of the code isn't well tested.
1998-09-04 16:08:54 +00:00
.Op Fl r Ar delta
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.
Import the apmconf function descriptions as per modified patch from green.
2000-01-22 18:28:23 +00:00
.It Fl d Ar enable
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
Disable/enable suspending of the display separately from a normal suspend
Import the apmconf function descriptions as per modified patch from green.
2000-01-22 18:28:23 +00:00
using the boolean value for
.Ar enable .
This feature seems to not work on many different laptops,
including the Libretto 30CT and 50CT.
.It Fl e Ar enable
Enable or disable APM functions of the computer,
depending on the boolean
.Ar enable
argument.
.It Fl h Ar enable
Depending on the boolean value of
.Ar enable ,
enable or disable the HLT instruction in the kernel context switch routine.
These options are not necessary for almost all APM implementations,
but for some implementations whose
.Dq Pa Idle CPU
call executes both CPU clock slowdown and HLT instruction,
.Fl t
is necessary to prevent the system from reducing its peak performance.
See
.Xr apm 4
for details.
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 missing "delta" argument to description headline of "apm" -r option to be consistent with descriptions of other options which take arguments.
2000-11-12 15:40:41 +00:00
.It Fl r Ar delta
o Enable standby mode in apm utility. You need a newer kernel for this functionality to work (however, the kernel changes were committed to current at 1998/07/05 23:29:11 PDT). o Enable setting of a timer for later wakeup. Note, not all APM BIOSes support this for all modes (mine doesn't support waking up on a timer from standby mode). o Print out the APM capabilities, as reported by the BIOS. o Report wake on ring indication. No way to enable/disable this, but it is reported. o update man page with above o The output of this command has changed, so if you have a script that parses its output, then you may need to rewrite it slightly. o The code attempts to deal with older kernels than July 5, 1998, but that part of the code isn't well tested.
1998-09-04 16:08:54 +00:00
Enable the resume wakeup timer, if the laptop supports it. This
doesn't actually suspend the laptop, but if the laptop is suspended,
and it supports resume from suspend, then it will be resume after
.Ar delta
seconds (from when you run this command, not from when you suspend).
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.
o Enable standby mode in apm utility. You need a newer kernel for this functionality to work (however, the kernel changes were committed to current at 1998/07/05 23:29:11 PDT). o Enable setting of a timer for later wakeup. Note, not all APM BIOSes support this for all modes (mine doesn't support waking up on a timer from standby mode). o Print out the APM capabilities, as reported by the BIOS. o Report wake on ring indication. No way to enable/disable this, but it is reported. o update man page with above o The output of this command has changed, so if you have a script that parses its output, then you may need to rewrite it slightly. o The code attempts to deal with older kernels than July 5, 1998, but that part of the code isn't well tested.
1998-09-04 16:08:54 +00:00
.It Fl Z
Transition the system into standby mode. This mode uses less power than
full power mode, but more than suspend mode. Some laptops support
resuming from this state on timer or Ring Indicator events. The
output of apm tells what your laptop claims to support.
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
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc.
2000-03-01 14:09:25 +00:00
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 .
Reflect that apmconf(8) has been absorbed by apm(8). Suggested by: msmith
2000-01-23 09:59:31 +00:00
.Sh NOTES
.Xr apmconf 8
has been merged in
.Xr apm 8
and thus
.Xr apm 8
replaces all of its functionality.
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
Import the apmconf function descriptions as per modified patch from green.
2000-01-22 18:28:23 +00:00
.Xr apm 4
.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
Reference in New Issue Copy Permalink