XBATTBAR(1)

NAME
xbattbar - show battery status in X Window

SYNOPSIS
xbattbar [-a] [-t thickness] [-p interval] [-I color] [-O color] [-i color] [-o color] [top | bottom | left | right]

DESCRIPTION
xbattbar shows the current (laptop) battery status in the X window environment. Battery status is obtained through the APM or ACPI kernel module. The APM and ACPI kernel modules depend on your UNIX platform, therefore, consult your documentation for its detail.

xbattbar shows its battery status in a simple bar indicator. -a option makes the indicator window keep always on top of your screen. The thickness of the indicator is 3 pixels in default and you can set the thickness as a parameter of -t option. This indicator appears in the bottom of the display (by default). The option top, left, or right forces the status indicator to be at the top, left, and right of the display, respectively. Though it's the default, you can also use bottom as the option.

When the AC line is on-line (plugged in), the color of the bar indicator consists of "green" and "olive drab" portions. The "green" portion shows its battery charging level. These colors can be changed by -I and -O options. In the other case (AC line is off-line), the color of the bar indicator consists of "blue" and "red"; the "blue" portion of the bar indicator shows the percentage of its remaining battery level. The color combination for the AC off-line case can be changed by -i and -o options.

xbattbar tries to determine the battery status every 10 seconds (by default). This is achieved by APM or ACPI polling. -p option changes the polling interval (in seconds).

If the mouse cursor enters in the status indicator, the diagnosis window appears in the center of the display, which shows both AC line status and battery remaining level. This diagnosis window disappears if the mouse cursor leaves from the status indicator.

SEE ALSO
xbatt(1) - an official battery status check command on BSD/OS 3.0, (but it's not fancy).

AUTHOR
Suguru Yamaguchi <suguru@wide.ad.jp>, Akira Kato <kato@wide.ad.jp>, Noriyuki Shigechika <nazo@wide.ad.jp>