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 .Dd April 6, 2009
  34 .Dt BATTD 8
  35 .Os
  36 .Sh NAME
  37 .Nm battd
  38 .Nd Battery status monitoring daemon
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl dEhT
  42 .Op Fl c Ar seconds
  43 .Op Fl e Ar command
  44 .Op Fl f Ar device
  45 .Op Fl p Ar percent
  46 .Op Fl s Ar status
  47 .Op Fl t Ar minutes
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 daemon monitors the status of the battery or batteries present in the system.
  52 The daemon will alert all users on the system and may execute a supplied
  53 command once a particular criterion has been met.
  54 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.
  61 Default is
  62 .Ar 30
  63 seconds.
  64 .It Fl d
  65 Start in debug mode (works when
  66 .Nm
  67 is compiled with
  68 .Fl DDEBUG ) .
  69 .It Fl e Ar command
  70 Execute
  71 .Ar command
  72 once condition has been met.
  73 .It Fl E
  74 Execute command only once after a condition has been met.
  75 .It Fl f Ar device
  76 Specifies a different device path to be used.
  77 Default is
  78 .Pa /dev/apm .
  79 .It Fl h
  80 Print
  81 .Nm
  82 command line usage and exit.
  83 .It Fl p Ar percent
  84 Alert users when the remaining battery life has reached approximately
  85 .Ar percent .
  86 Default is
  87 .Ar 10 .
  88 A value of
  89 .Ar 0
  90 turns this alert off.
  91 .It Fl s Ar status
  92 Alert users when the remaining battery has reached a given status.
  93 The status specified can either be
  94 .Ar high ,
  95 .Ar low
  96 or
  97 .Ar critical .
  98 .It Fl t Ar minutes
  99 Alert users when the remaining battery time has reached approximately
 100 .Ar minutes .
 101 .It Fl T
 102 Alert users when the system has approximately 10 minutes remaining battery time,
 103 but don't execute command
 104 .Pq Fl e
 105 on this alert.
 106 .El
 107 .Sh EXAMPLES
 108 .Dl "battd -p 50 -s low"
 109 Alert users when the battery percentage has reached 50% and
 110 once again when the status reaches
 111 .Ar low .
 112 .Pp
 113 .Dl "battd -t 15 -c 10"
 114 Alert users when the battery has 15 minutes worth of power remaining
 115 and once again when battery percentage has reached 10%.
 116 Decrease the interval between checking the battery to 10 seconds.
 117 .Pp
 118 .Dl "battd -Tt4 -p0 -Ee \*q/sbin/shutdown -p +2 Battery_Low\*q"
 119 Alert users when the battery has 10 minutes worth power remaining and
 120 alert again when 4 minutes is remaining and then execute the given
 121 .Xr shutdown 8
 122 command once.
 123 (User will have to
 124 .Xr kill 1
 125 the
 126 .Xr shutdown 8
 127 process, if AC power is connected to system and shutdown isn't wanted.)
 128 .Sh SEE ALSO
 129 .Xr viapm 4 ,
 130 .Xr apm 8 ,
 131 .Xr apmd 8 ,
 132 .Xr syslogd 8 ,
 133 .Xr zzz 8
 134 .Sh HISTORY
 135 The
 136 .Nm
 137 command first appeared in
 138 .Dx 1.1 .
 139 .Sh AUTHORS
 140 .An Liam J. Foy Aq Mt liamfoy@dragonflybsd.org
 141 .Pp
 142 Man page contributions by:
 143 .An Maxime Labelle Aq Mt mlabelle@vt220.com
 144 .An Sarunas Vancevicius Aq Mt svan@redbrick.dcu.ie