Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wmbattery(1x) [debian man page]

WMBATTERY(1x)															     WMBATTERY(1x)

NAME

       wmbattery - dockable battery monitor

SYNOPSIS

       wmbattery [options]

DESCRIPTION

       wmbattery is a battery monitor.	It is used to visually display the system's battery status.

       wmbattery can get battery information using HAL, APM, ACPI, or the SPIC controller in some Sony laptops. You need to build your kernel with
       support for at least one of these for the program to work.  wmbattery is dockable using WindowMaker and AfterStep  window  managers;  under
       other window managers wmbattery appears as a nicely-sized 64x64 application.

       wmbattery displays the status of your laptop's battery in a small icon.	This includes if it is plugged in, if the battery is charging, how
       many minutes of battery life remain, battery life remaining (with both a percentage and a graph), and battery status (high - green,  low  -
       yellow, or critical - red).

ELEMENTS OF THE DISPLAY

       The wmbattery display consists of these elements:

       dial   The large dial at the top of the display shows battery life remaining.

       time display
	      The time display, right under and in the middle of the dial, shows how many hours and minutes of battery life is estimated to remain
	      at the current rate of use.

	      If ACPI is used and battery is charging, the time display will instead show a countdown (starting with a minus  sign)  of  how  many
	      hours and minutes it is estimated to take until the battery is fully charged.

       power cord
	      The small icon of a power cord plug, in the bottom left, tells if the laptop is plugged into wall power. If so, it will be lit.

       charging indicator
	      The  lightning bolt icon, to the right of the plug, tells if the battery is being charged. If so it will be lit and will connect the
	      plug to the battery.

       battery icon
	      The battery icon, to the right of the lighting bolt, shows the percentage of battery time. If the battery is removed the	icon  will
	      be dimmed. If the computer is low on power the battery will turn yellow; if the computer is critically low on power and about to die
	      because of it, it will turn red.

OPTIONS

       -h     Display list of command-line options.

       -w secs
	      Pause this many seconds between updates.

       -d display
	      Use the designated X display.

       -g +x+y
	      Specify geometry. This specifies position, not size.

       -b battnum
	      Display the given battery. Only of use with the HAL or ACPI interfaces on systems with more than one battery. The default is to dis-
	      play the first battery found.

       -l percent
	      Set the percentage at which the battery is considered to be running low. By default, this percentage is determined automaticall, and
	      you shouldn't need to set it. If you set this, you should probably also set the -c switch.

       -c percent
	      Set the percentage at which the battery is considered to be critically low.  By default, this  percentage  is  determined  automati-
	      cally, and you shouldn't need to set it. If you set this, you should probably also set the -l switch.

       -e     wmbattery contains code for estimating the time remaining before discharge, and until full charge, and this code is used if no other
	      source of this informaton is available. This switch makes wmbattery use its time estimation code even  if  some  other  estimate	is
	      available.

       -s granularity
	      Ignore fluctuations less than the specified granularity percent when estimating time. (Implies -e)

       -a file.au
	      Play the specified au file (by sending it to /dev/audio) when the battery is low.

AUTHOR

       Joey Hess <joey@kitenet.net>

																     WMBATTERY(1x)

Check Out this Related Man Page

XAPM(1)                                                                                                                                    XAPM(1)

NAME

       xapm - display Advanced Power Management (APM) BIOS information

SYNOPSIS

       xapm [ ... ]

DESCRIPTION

       xapm  puts up an X window that displays the remaining battery life.  The left side of the window contains a printed time or percentage; the
       right side of the window contains a bar indicating the percentage.  Clicking on the left side of the window will toggle the display between
       time and percentage.

OPTIONS AND RESOURCES

       In addition to standard Xt options, the following options are available:

       -V     Print the program version number and exit.

       -highcolor color
              The color of the bar when the battery percentage is above highvalue.  Defaults to "green". (*highColor)

       -lowcolor color
              The color of the bar when the battery percentage is between lowvalue and highvalue.  Defaults to "yellow". (*lowColor)

       -criticalcolor color
              The  color  of  the  bar  when  the  battery percentage is below lowvalue.  Defaults to "red".  This color is also used to flash the
              alphanumeric part of the display when the power status is critical. (*criticalCOlor)

       -highvalue highvalue
              Set highvalue.  The default is 50. (*highValue)

       -lowvalue lowvalue
              Set lowvalue.  The default is 10. (*lowValue)

       -chargingcolor color
              The color of the printed display when charging.  The default is "blue".  Use -foreground to change the color used  when  on  battery
              power. (*chargingColor)

       -delay delay
              Sets the number of seconds delay between each update.  The default is 1. (*delay)

       -percent
              Display percentage on startup, instead of time remaining. (*percent, boolean)

       -percentauto
              Swap  automatically  between  displaying percentage and displaying the time remaining. When on ac power, display percentage, when on
              battery power, display the time remaining.

BUGS

       There is no way to inhibit the alphanumeric display or the bar display.  When the battery percentage is low, using a bright color  to  warn
       you  of  impending  doom  may be futile because the bar is too short.  Because of the form widget's desire to maintain proportions, dynamic
       resizing of the window may not do what you want it to do.

FILES

       /proc/apm

AUTHOR

       This program was written by Rik Faith (faith@cs.unc.edu) and may be freely distributed under the terms of the GNU General  Public  License.
       There is ABSOLUTELY NO WARRANTY for this program.  The current maintainer is Avery Pennarun (apenwarr@worldvisions.ca).

SEE ALSO

       apm(1), apmd(8).

                                                                   January 2004                                                            XAPM(1)
Man Page