1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH WMBATTERIES 1 "November 10, 2003"
6 .\" Please adjust this date whenever revising the manpage.
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
19 wmbatteries \- A dockapp to monitor status of up to 2 batteries and cpu temp
21 This manual page documents briefly the
25 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
26 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
28 \fBwmbatteries\fP is a program to monitor status of two batteries and cpu temp using
29 ACPI (http://acpi.sf.net). It is a dockapp
30 that is supported by X window managers such as Window Maker, AfterStep, BlackBox, Fluxbox and
33 In the top half the sum of the remaining time of all existing batteries ist
34 displayed when the system runs in battery mode. Otherwise, the time
35 is displayed, until the currently charging battery is complete charged.
36 When on AC and the batteries are not charging, 00:00 is displayed.
37 Below, current capacity of availible batteries is displayed in percent and in form of bars.
39 In the bottom half, there are 4 indicators: The left is shown when on AC.
40 The two battery symbols in the middle are shown when the corresponding
41 battery is discharging, and animated if it is charging.
42 The animation speed may be set with the -s option.
43 On the right there is an indicator which is displayed when the remaining capacity
44 of all batteries is less than a certain (default:20) percentage of the
45 maximum capacity of all batteries.
47 The last line may be used to display either CPU temperature or the current power consumption.
48 The mode of the last line may be set with the -m option. when -m s is given, the display
49 switches between cpu temperature and power consumption in a certain time (option -ts).
50 That line may also be switched manually by rightclicking in the dockapp.
52 The back-light may be turned on/off by clicking the mouse button 1 (left)
53 over the application. If battery status is below a critical level, an
54 alarm-mode will alert you by turning on and off back-light.
59 This program follows the usual GNU command line syntax, with long options
60 starting with two dashes (`\-'). A summary of options is included below.
62 .B \-d, \-\-display <string>
63 Attempt to open a window on the named X display. In the absence of this option,
64 the display specified by the
66 environment variable is used.
68 .B \-bl, \-\-backlight
71 .B \-lc, \-\-light\-color <color>
72 back-light color (rgb:6E/C6/3B is default)
74 .B \-i, \-\-interval <number>
75 number of secs between updates (1 is default)
77 .B \-c, \-\-config <string>
78 config file to use, otherwise $HOME/.wmbatteriesrc or /etc/wmbatteries will
81 .B \-a, \-\-alarm <number>
82 low battery level when to raise alarm (20 is default)
85 show help text and exit
88 show program version and exit
91 run the application in windowed mode
93 .B \-bw, \-\-broken\-wm
94 activate broken window manager fix
96 .B \-n, \-\-notify <string>
97 command to launch each time there is alarm
99 .B \-s, \-\-suspend <string>
100 set command for acpi suspend
102 .B \-S, \-\-standby <string>
103 set command for acpi standby
105 .B \-m, \-\-mode [t|r|s]
106 set mode for the lower row ,
107 t=temperature,r=current rate,s=toggle
109 .B \-ts, \-\-togglespeed <integer>
110 set togglespeed in seconds
112 .B \-as, \-\-animationspeed <integer>
113 set speed for charging animation in msec
115 .B \-hs, \-\-historysize <integer>
116 set size of history for calculating average power consumption rate
118 wmbatteries was assembled by Florian Krohs <florian.krohs@informatik.uni-oldenburg.de>