wmbattery/wmbattery.1

   1 .TH WMBATTERY 1
   2 .SH NAME
   3 wmbattery \- dockable battery monitor
   4 .SH SYNOPSIS
   5 .B wmbattery
   6 [options]
   7 .SH DESCRIPTION
   8 .PP
   9 .B wmbattery
  10 is a battery monitor.  It is used to visually display the system's battery
  11 status.
  12 .PP
  13 .B wmbattery
  14 can get battery information using upower, HAL, APM, ACPI, or
  15 the SPIC controller in some Sony laptops.
  16 .B wmbattery
  17 is dockable using WindowMaker and AfterStep window managers; under
  18 other window managers
  19 .B wmbattery
  20 appears as a nicely-sized 64x64 application.
  21 .PP
  22 .B wmbattery
  23 displays the status of your laptop's battery in a small icon.  This
  24 includes if it is plugged in, if the battery is charging, how many
  25 minutes of battery life remain, battery life remaining (with both a
  26 percentage and a graph), and battery status (high - green, low -
  27 yellow, or critical - red).
  28 .SH "ELEMENTS OF THE DISPLAY"
  29 The
  30 .B wmbattery
  31 display consists of these elements:
  32 .TP
  33 .B dial
  34 The large dial at the top of the display shows battery life remaining.
  35 .TP
  36 .B time display
  37 The time display, right under and in the middle of the dial, shows how
  38 many hours and minutes of battery life is estimated to remain at the
  39 current rate of use.
  40 .P
  41 .RS
  42 If ACPI is used and battery is charging, the time display will instead show
  43 a countdown (starting with a minus sign) of how many hours and minutes it is
  44 estimated to take until the battery is fully charged.
  45 .RE
  46 .TP
  47 .B power cord
  48 The small icon of a power cord plug, in the bottom left, tells if the
  49 laptop is plugged into wall power. If so, it will be lit.
  50 .TP
  51 .B charging indicator
  52 The lightning bolt icon, to the right of the plug, tells if the
  53 battery is being charged. If so it will be lit and will connect the
  54 plug to the battery.
  55 .TP
  56 .B battery icon
  57 The battery icon, to the right of the lighting bolt, shows the
  58 percentage of battery time. If the battery is removed the icon will be
  59 dimmed. If the computer is low on power the battery will turn yellow;
  60 if the computer is critically low on power and about to die because of
  61 it, it will turn red.
  62 .SH OPTIONS
  63 .TP
  64 .B \-h
  65 Display list of command-line options.
  66 .TP
  67 .B \-w secs
  68 Pause this many seconds between updates.
  69 .TP
  70 .B \-d display
  71 Use the designated X display.
  72 .TP
  73 .B \-g {+-}x{+-}y
  74 Specify geometry. This specifies position, not size.
  75 .TP
  76 .B \-b battnum
  77 Display the given battery. Only of use with the HAL or ACPI interfaces on
  78 systems with more than one battery. The default is to display the first
  79 battery found.
  80 .TP
  81 .B \-l percent
  82 Set the percentage at which the battery is considered to be running low. By
  83 default, this percentage is determined automaticall, and you shouldn't
  84 need to set it. If you set this, you should probably also set the \-c
  85 switch.
  86 .TP
  87 .B \-c percent
  88 Set the percentage at which the battery is considered to be critically low.
  89 By default, this percentage is determined automatically, and you shouldn't
  90 need to set it. If you set this, you should probably also set the \-l
  91 switch.
  92 .TP
  93 .B \-e
  94 wmbattery contains code for estimating the time remaining before discharge,
  95 and until full charge, and this code is used if no other source of this
  96 informaton is available. This switch makes wmbattery use its time
  97 estimation code even if some other estimate is available.
  98 .TP
  99 .B \-s granularity
 100 Ignore fluctuations less than the specified granularity percent when
 101 estimating time. (Implies \-e)
 102 .TP
 103 .B \-a file.au
 104 Play the specified au file (by sending it to /dev/audio) when the battery
 105 is low.
 106 .TP
 107 .B \-x command
 108 Execute the specified command when the battery is below critical. The
 109 strings \fI%percent%\fR, \fI%minutes%\fR and \fI%seconds%\fR will be
 110 translated into the appropriate values.
 111 .TP
 112 .B \-i
 113 Display as icon.
 114 .TP
 115 .B \-n
 116 Disable dial graphic.
 117 .SH EXAMPLE
 118 Start at 10% battery to execute 'echo' including status information:
 119 .RS
 120 wmbattery \-c 10 \-x "echo Status: %percent%% \- %minutes% minutes, %seconds% seconds left"
 121 .RE
 122 .SH AUTHOR
 123 Joey Hess <joey@kitenet.net>