- Large cleanup/changes to man page.
authorLiam J. Foy <liamfoy@dragonflybsd.org>
Tue, 1 Feb 2005 18:43:15 +0000 (18:43 +0000)
committerLiam J. Foy <liamfoy@dragonflybsd.org>
Tue, 1 Feb 2005 18:43:15 +0000 (18:43 +0000)
Submitted by: Maxime Labelle <mlabelle@vt220.com>

usr.sbin/battd/battd.1
usr.sbin/battd/battd.8

index 5477a33..47491aa 100644 (file)
-.\" Copyright (c) 2005 The DragonFly Project.  All rights reserved.\r
-.\"\r
-.\" This code is derived from software contributed to The DragonFly Project\r
-.\" by Sarunas Vancevicius and Maxime Labelle. \r
-.\" \r
-.\" Redistribution and use in source and binary forms, with or without\r
-.\" modification, are permitted provided that the following conditions\r
-.\" are met:\r
-.\" \r
-.\" 1. Redistributions of source code must retain the above copyright\r
-.\"    notice, this list of conditions and the following disclaimer.\r
-.\" 2. Redistributions in binary form must reproduce the above copyright\r
-.\"    notice, this list of conditions and the following disclaimer in\r
-.\"    the documentation and/or other materials provided with the\r
-.\"    distribution.\r
-.\" 3. Neither the name of The DragonFly Project nor the names of its\r
-.\"    contributors may be used to endorse or promote products derived\r
-.\"    from this software without specific, prior written permission.\r
-.\"\r
-.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
-.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
-.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\r
-.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE\r
-.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
-.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,\r
-.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
-.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED\r
-.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT\r
-.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
-.\" SUCH DAMAGE.\r
-.\" \r
-.\" $DragonFly: src/usr.sbin/battd/Attic/battd.1,v 1.1 2005/02/01 17:16:36 liamfoy Exp $\r
\r
-.Dd January 1, 2005\r
-.Dt BATTD 1\r
-.Os\r
-.Sh NAME\r
-.Nm battd\r
-.Nd Battery status monitoring daemon \r
-.Sh SYNOPSIS\r
-.Nm\r
-.Op Fl dEhT\r
-.Op Fl p Ar percentage\r
-.Op Fl t Ar minutes\r
-.Op Fl s Ar status\r
-.Op Fl f Ar device\r
-.Op Fl c Ar seconds\r
-.Sh DESCRIPTION\r
-The\r
-.Nm\r
-daemon monitors the status of the battery or batteries present in the system.\r
-The daemon will alert all users on the system\r
-and may execute a supplied command once a particular criteria has  been\r
-met.   The  criterias  are  based on the percentage remaining, the time\r
-remaining and the status of the battery.\r
-.Pp\r
-The options are as follows:\r
-.Bl -tag -width indent\r
-.It Fl c Ar seconds\r
-Interval in seconds for checking the battery status, default is\r
-.Ar 30 .\r
-.It Fl d\r
-Start\r
-.Nm\r
-in debug mode.\r
-.It Fl e Ar command\r
-Execute\r
-.Ar command\r
-once condition has been met.\r
-.It Fl E\r
-Do not continue executing after a condition has been met.\r
-.It Fl f Ar device\r
-Specifies a different device path to be used in place of the default\r
-.It Fl h \r
-Print\r
-.Nm \r
-usage.\r
-.It Fl p Ar percent\r
-Alert the user when the remaining battery life has reached approximately\r
-.Ar percent .\r
-.It Fl s Ar status\r
-Alert the user when the remaining battery status has reached High, Low or\r
-.It Fl t Ar minutes\r
-Alert the user when the remaining battery time has reached approximately\r
-.Ar minutes.\r
-.It Fl T\r
-Use as default along with percentage default alert. This will alert you once\r
-the system has roughly 10 minutes remaining.\r
-.El\r
-.Pp\r
-By default,\r
-.Nm\r
-will alert users once the battery or batteries have roughly 10% of power remaining.\r
-.Sh EXAMPLES\r
-.Bl -tag -width indent\r
-.It Li "battd -p 50 -s low"\r
-Alert users when the battery percentage has reached 50% and once again when the status\r
-reaches low.\r
-.It Li "battd -t 15"\r
-Alert users when the battery has 15 minutes worth of power remaining.\r
-.It Li "battd -p 30 -e program -c 10"\r
-Alert users when the battery percentage has reached 50% and execute the command 'program'.\r
-Increase the interval between checking the battery to 10 seconds.\r
-.El\r
-.Sh SEE ALSO\r
-.Xr apm 8 ,\r
-.Xr apmd 8 ,\r
-.Xr syslogd 8\r
-.Sh HISTORY\r
-The\r
-.Nm\r
-command first appeared in DragonFly.\r
-.Sh AUTHORS\r
-.An Liam J. Foy Aq liamfoy@dragonflybsd.org\r
-.Pp\r
-Man page contributions by:\r
-.An Maxime Labelle Aq mlabelle@vt220.com\r
-.An Sarunas Vancevicius Aq svan@redbrick.dcu.ie\r
+.\" Copyright (c) 2005 The DragonFly Project.  All rights reserved.
+.\"
+.\" This code is derived from software contributed to The DragonFly Project
+.\" by Maxime Labelle. 
+.\" 
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\" 3. Neither the name of The DragonFly Project nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific, prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $DragonFly: src/usr.sbin/battd/Attic/battd.1,v 1.2 2005/02/01 18:43:15 liamfoy Exp $ 
+
+.Dd January 31, 2005
+.Dt BATTD 1
+.Os
+.Sh NAME
+.Nm battd
+.Nd Battery status monitoring daemon 
+.Sh SYNOPSIS
+.Nm
+.Op Fl hEdT
+.Op Fl p Ar percentage
+.Op Fl t Ar minutes
+.Op Fl s Ar status
+.Op Fl f Ar device
+.Op Fl c Ar seconds
+.Sh DESCRIPTION
+The
+.Nm
+daemon monitors the status of the battery or batteries present in the system.
+The daemon will alert all users on the system and may execute a supplied
+command once a particular criteria has been met. The criterias are based
+on the percentage remaining, the time remaining and the status of the battery. 
+.Pp
+The options are as follows:
+.Bl -tag -width indent
+.It Fl c Ar seconds
+Interval in seconds for checking the battery status. Default is
+.Ar 30
+seconds.
+.It Fl d
+Start
+.Nm
+in debug mode.
+.It Fl e Ar command
+Execute
+.Ar command
+once condition has been met.
+.It Fl E 
+Execute command only once after a condition has been met.
+.It Fl f Ar device
+Specifies a different device path to be used. Default is 
+.Ar /dev/apm .
+.It Fl h 
+Print
+.Nm 
+command line usage and exit.
+.It Fl p Ar percent
+Alert the user when the remaining battery life has reached approximately
+.Ar percent .
+.It Fl s Ar status
+Alert the user when the remaining battery has reached a given status. The status specified can either be 
+.Ar high
+, 
+.Ar low
+or 
+.Ar critical .
+.It Fl t Ar minutes
+Alert the user when the remaining battery time has reached approximately
+.Ar minutes.
+.It Fl T
+Use as default along with percentage default alert. This will alert you once
+the system has roughly 10 minutes remaining.
+.El
+.Pp
+By default,
+.Nm
+will alert users once the battery or batteries have roughly 10% of power remaining.
+.Pp
+.Sh EXAMPLES
+.Bl -tag -width indent
+.It Li "battd -p 50 -s low"
+Alert users when the battery percentage has reached 50% and once again when the status
+reaches low.
+.It Li "battd -t 15"
+Alert users when the battery has 15 minutes worth of power remaining.
+.It Li "battd -p 30 -e program -c 10"
+Alert users when the battery percentage has reached 50% and execute the command 'program'.
+Increase the interval between checking the battery to 10 seconds.
+.El
+.Sh SEE ALSO
+.Xr zzz 4 ,
+.Xr viapm 4 ,
+.Xr apm 8 ,
+.Xr apmd 8 ,
+.Xr syslogd 8
+.Sh HISTORY
+The
+.Nm
+command first appeared in DragonFly.
+.Sh AUTHORS
+.An Liam J. Foy Aq liamfoy@dragonflybsd.org
+.Pp
+Man page contributions by:
+.An Maxime Labelle Aq mlabelle@vt220.com
+.An Sarunas Vancevicius Aq svan@redbrick.dcu.ie
index 60c6b1c..d0d47d9 100644 (file)
-.\" Copyright (c) 2005 The DragonFly Project.  All rights reserved.\r
-.\"\r
-.\" This code is derived from software contributed to The DragonFly Project\r
-.\" by Sarunas Vancevicius and Maxime Labelle. \r
-.\" \r
-.\" Redistribution and use in source and binary forms, with or without\r
-.\" modification, are permitted provided that the following conditions\r
-.\" are met:\r
-.\" \r
-.\" 1. Redistributions of source code must retain the above copyright\r
-.\"    notice, this list of conditions and the following disclaimer.\r
-.\" 2. Redistributions in binary form must reproduce the above copyright\r
-.\"    notice, this list of conditions and the following disclaimer in\r
-.\"    the documentation and/or other materials provided with the\r
-.\"    distribution.\r
-.\" 3. Neither the name of The DragonFly Project nor the names of its\r
-.\"    contributors may be used to endorse or promote products derived\r
-.\"    from this software without specific, prior written permission.\r
-.\"\r
-.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
-.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
-.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\r
-.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE\r
-.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
-.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,\r
-.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
-.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED\r
-.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT\r
-.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
-.\" SUCH DAMAGE.\r
-.\" \r
-.\" $DragonFly: src/usr.sbin/battd/battd.8,v 1.1 2005/02/01 17:16:36 liamfoy Exp $\r
\r
-.Dd January 1, 2005\r
-.Dt BATTD 1\r
-.Os\r
-.Sh NAME\r
-.Nm battd\r
-.Nd Battery status monitoring daemon \r
-.Sh SYNOPSIS\r
-.Nm\r
-.Op Fl dEhT\r
-.Op Fl p Ar percentage\r
-.Op Fl t Ar minutes\r
-.Op Fl s Ar status\r
-.Op Fl f Ar device\r
-.Op Fl c Ar seconds\r
-.Sh DESCRIPTION\r
-The\r
-.Nm\r
-daemon monitors the status of the battery or batteries present in the system.\r
-The daemon will alert all users on the system\r
-and may execute a supplied command once a particular criteria has  been\r
-met.   The  criterias  are  based on the percentage remaining, the time\r
-remaining and the status of the battery.\r
-.Pp\r
-The options are as follows:\r
-.Bl -tag -width indent\r
-.It Fl c Ar seconds\r
-Interval in seconds for checking the battery status, default is\r
-.Ar 30 .\r
-.It Fl d\r
-Start\r
-.Nm\r
-in debug mode.\r
-.It Fl e Ar command\r
-Execute\r
-.Ar command\r
-once condition has been met.\r
-.It Fl E\r
-Do not continue executing after a condition has been met.\r
-.It Fl f Ar device\r
-Specifies a different device path to be used in place of the default\r
-.It Fl h \r
-Print\r
-.Nm \r
-usage.\r
-.It Fl p Ar percent\r
-Alert the user when the remaining battery life has reached approximately\r
-.Ar percent .\r
-.It Fl s Ar status\r
-Alert the user when the remaining battery status has reached High, Low or\r
-.It Fl t Ar minutes\r
-Alert the user when the remaining battery time has reached approximately\r
-.Ar minutes.\r
-.It Fl T\r
-Use as default along with percentage default alert. This will alert you once\r
-the system has roughly 10 minutes remaining.\r
-.El\r
-.Pp\r
-By default,\r
-.Nm\r
-will alert users once the battery or batteries have roughly 10% of power remaining.\r
-.Sh EXAMPLES\r
-.Bl -tag -width indent\r
-.It Li "battd -p 50 -s low"\r
-Alert users when the battery percentage has reached 50% and once again when the status\r
-reaches low.\r
-.It Li "battd -t 15"\r
-Alert users when the battery has 15 minutes worth of power remaining.\r
-.It Li "battd -p 30 -e program -c 10"\r
-Alert users when the battery percentage has reached 50% and execute the command 'program'.\r
-Increase the interval between checking the battery to 10 seconds.\r
-.El\r
-.Sh SEE ALSO\r
-.Xr apm 8 ,\r
-.Xr apmd 8 ,\r
-.Xr syslogd 8\r
-.Sh HISTORY\r
-The\r
-.Nm\r
-command first appeared in DragonFly.\r
-.Sh AUTHORS\r
-.An Liam J. Foy Aq liamfoy@dragonflybsd.org\r
-.Pp\r
-Man page contributions by:\r
-.An Maxime Labelle Aq mlabelle@vt220.com\r
-.An Sarunas Vancevicius Aq svan@redbrick.dcu.ie\r
+.\" Copyright (c) 2005 The DragonFly Project.  All rights reserved.
+.\"
+.\" This code is derived from software contributed to The DragonFly Project
+.\" by Maxime Labelle. 
+.\" 
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\" 3. Neither the name of The DragonFly Project nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific, prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $DragonFly: src/usr.sbin/battd/battd.8,v 1.2 2005/02/01 18:43:15 liamfoy Exp $ 
+
+.Dd January 31, 2005
+.Dt BATTD 1
+.Os
+.Sh NAME
+.Nm battd
+.Nd Battery status monitoring daemon 
+.Sh SYNOPSIS
+.Nm
+.Op Fl hEdT
+.Op Fl p Ar percentage
+.Op Fl t Ar minutes
+.Op Fl s Ar status
+.Op Fl f Ar device
+.Op Fl c Ar seconds
+.Sh DESCRIPTION
+The
+.Nm
+daemon monitors the status of the battery or batteries present in the system.
+The daemon will alert all users on the system and may execute a supplied
+command once a particular criteria has been met. The criterias are based
+on the percentage remaining, the time remaining and the status of the battery. 
+.Pp
+The options are as follows:
+.Bl -tag -width indent
+.It Fl c Ar seconds
+Interval in seconds for checking the battery status. Default is
+.Ar 30
+seconds.
+.It Fl d
+Start
+.Nm
+in debug mode.
+.It Fl e Ar command
+Execute
+.Ar command
+once condition has been met.
+.It Fl E 
+Execute command only once after a condition has been met.
+.It Fl f Ar device
+Specifies a different device path to be used. Default is 
+.Ar /dev/apm .
+.It Fl h 
+Print
+.Nm 
+command line usage and exit.
+.It Fl p Ar percent
+Alert the user when the remaining battery life has reached approximately
+.Ar percent .
+.It Fl s Ar status
+Alert the user when the remaining battery has reached a given status. The status specified can either be 
+.Ar high
+, 
+.Ar low
+or 
+.Ar critical .
+.It Fl t Ar minutes
+Alert the user when the remaining battery time has reached approximately
+.Ar minutes.
+.It Fl T
+Use as default along with percentage default alert. This will alert you once
+the system has roughly 10 minutes remaining.
+.El
+.Pp
+By default,
+.Nm
+will alert users once the battery or batteries have roughly 10% of power remaining.
+.Pp
+.Sh EXAMPLES
+.Bl -tag -width indent
+.It Li "battd -p 50 -s low"
+Alert users when the battery percentage has reached 50% and once again when the status
+reaches low.
+.It Li "battd -t 15"
+Alert users when the battery has 15 minutes worth of power remaining.
+.It Li "battd -p 30 -e program -c 10"
+Alert users when the battery percentage has reached 50% and execute the command 'program'.
+Increase the interval between checking the battery to 10 seconds.
+.El
+.Sh SEE ALSO
+.Xr zzz 4 ,
+.Xr viapm 4 ,
+.Xr apm 8 ,
+.Xr apmd 8 ,
+.Xr syslogd 8
+.Sh HISTORY
+The
+.Nm
+command first appeared in DragonFly.
+.Sh AUTHORS
+.An Liam J. Foy Aq liamfoy@dragonflybsd.org
+.Pp
+Man page contributions by:
+.An Maxime Labelle Aq mlabelle@vt220.com
+.An Sarunas Vancevicius Aq svan@redbrick.dcu.ie