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.7 2005/08/01 01:49:18 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 hEdT
  43 .Op Fl p Ar percentage
  44 .Op Fl t Ar minutes
  45 .Op Fl s Ar status
  46 .Op Fl f Ar device
  47 .Op Fl c Ar seconds
  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 criteria has been met. The criterias are based
  54 on the percentage remaining, the time remaining and the status of the battery.
  55 .Pp
  56 The options are as follows:
  57 .Bl -tag -width indent
  58 .It Fl c Ar seconds
  59 Interval in seconds for checking the battery status. Default is
  60 .Ar 30
  61 seconds.
  62 .It Fl d
  63 Start
  64 .Nm
  65 in debug mode.
  66 .It Fl e Ar command
  67 Execute
  68 .Ar command
  69 once condition has been met.
  70 .It Fl E
  71 Execute command only once after a condition has been met.
  72 .It Fl f Ar device
  73 Specifies a different device path to be used. Default is
  74 .Ar /dev/apm .
  75 .It Fl h
  76 Print
  77 .Nm
  78 command line usage and exit.
  79 .It Fl p Ar percent
  80 Alert the user when the remaining battery life has reached approximately
  81 .Ar percent .
  82 .It Fl s Ar status
  83 Alert the user when the remaining battery has reached a given status. The status specified can either be
  84 .Ar high
  85 ,
  86 .Ar low
  87 or
  88 .Ar critical .
  89 .It Fl t Ar minutes
  90 Alert the user when the remaining battery time has reached approximately
  91 .Ar minutes.
  92 .It Fl T
  93 Use as default along with percentage default alert. This will alert you once
  94 the system has roughly 10 minutes remaining.
  95 .El
  96 .Pp
  97 By default,
  98 .Nm
  99 will alert users once the battery or batteries have roughly 10% of power remaining.
 100 .Pp
 101 .Sh EXAMPLES
 102 .Bl -tag -width indent
 103 .It Li "battd -p 50 -s low"
 104 Alert users when the battery percentage has reached 50% and once again when the status
 105 reaches low.
 106 .It Li "battd -t 15"
 107 Alert users when the battery has 15 minutes worth of power remaining.
 108 .It Li "battd -p 30 -e program -c 10"
 109 Alert users when the battery percentage has reached 30% and execute the command 'program'.
 110 Increase the interval between checking the battery to 10 seconds.
 111 .El
 112 .Sh SEE ALSO
 113 .Xr zzz 4 ,
 114 .Xr viapm 4 ,
 115 .Xr apm 8 ,
 116 .Xr apmd 8 ,
 117 .Xr syslogd 8
 118 .Sh HISTORY
 119 The
 120 .Nm
 121 command first appeared in
 122 .Dx 1.1 .
 123 .Sh AUTHORS
 124 .An Liam J. Foy Aq liamfoy@dragonflybsd.org
 125 .Pp
 126 Man page contributions by:
 127 .An Maxime Labelle Aq mlabelle@vt220.com
 128 .An Sarunas Vancevicius Aq svan@redbrick.dcu.ie