usr.sbin/battd/battd.8

   1 .\" Copyright (c) 2005 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Maxime Labelle.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\" $DragonFly: src/usr.sbin/battd/battd.8,v 1.13 2008/02/22 04:30:34 swildner Exp $
  34 .Dd May 29, 2005
  35 .Dt BATTD 8
  36 .Os
  37 .Sh NAME
  38 .Nm battd
  39 .Nd Battery status monitoring daemon
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl dEhT
  43 .Op Fl c Ar seconds
  44 .Op Fl e Ar command
  45 .Op Fl f Ar device
  46 .Op Fl p Ar percentage
  47 .Op Fl s Ar status
  48 .Op Fl t Ar minutes
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 daemon monitors the status of the battery or batteries present in the system.
  53 The daemon will alert all users on the system and may execute a supplied
  54 command once a particular criterion has been met. The criteria are based
  55 on the percentage remaining, the time remaining and the status of the battery.
  56 .Pp
  57 The options are as follows:
  58 .Bl -tag -width indent
  59 .It Fl c Ar seconds
  60 Interval in seconds for checking the battery status. Default is
  61 .Ar 30
  62 seconds.
  63 .It Fl d
  64 Start in debug mode (works when
  65 .Nm
  66 is compiled with
  67 .Fl DDEBUG ) .
  68 .It Fl e Ar command
  69 Execute
  70 .Ar command
  71 once condition has been met.
  72 .It Fl E
  73 Execute command only once after a condition has been met.
  74 .It Fl f Ar device
  75 Specifies a different device path to be used. Default is
  76 .Pa /dev/apm .
  77 .It Fl h
  78 Print
  79 .Nm
  80 command line usage and exit.
  81 .It Fl p Ar percent
  82 Alert the user when the remaining battery life has reached approximately
  83 .Ar percent .
  84 .It Fl s Ar status
  85 Alert the user when the remaining battery has reached a given status. The status specified can either be
  86 .Ar high
  87 ,
  88 .Ar low
  89 or
  90 .Ar critical .
  91 .It Fl t Ar minutes
  92 Alert the user when the remaining battery time has reached approximately
  93 .Ar minutes .
  94 .It Fl T
  95 Use as default along with percentage default alert. This will alert you once
  96 the system has roughly 10 minutes remaining.
  97 .El
  98 .Pp
  99 By default,
 100 .Nm
 101 will alert users once the battery or batteries have roughly 10% of power remaining.
 102 .Sh EXAMPLES
 103 .Bl -tag -width indent
 104 .It Li "battd -p 50 -s low"
 105 Alert users when the battery percentage has reached 50% and once again when the status
 106 reaches low.
 107 .It Li "battd -t 15"
 108 Alert users when the battery has 15 minutes worth of power remaining.
 109 .It Li "battd -p 30 -e program -c 10"
 110 Alert users when the battery percentage has reached 30% and execute the command 'program'.
 111 Increase the interval between checking the battery to 10 seconds.
 112 .El
 113 .Sh SEE ALSO
 114 .Xr viapm 4 ,
 115 .Xr apm 8 ,
 116 .Xr apmd 8 ,
 117 .Xr syslogd 8 ,
 118 .Xr zzz 8
 119 .Sh HISTORY
 120 The
 121 .Nm
 122 command first appeared in
 123 .Dx 1.1 .
 124 .Sh AUTHORS
 125 .An Liam J. Foy Aq liamfoy@dragonflybsd.org
 126 .Pp
 127 Man page contributions by:
 128 .An Maxime Labelle Aq mlabelle@vt220.com
 129 .An Sarunas Vancevicius Aq svan@redbrick.dcu.ie