1WMACPI(1) General Commands Manual WMACPI(1)
2
6 wmacpi - Battery status monitor for systems supporting ACPI
7
9 wmacpi-cli - Query battery status for systems supporting ACPI
10
12 wmacpi [ -c value ] [ -d display ] [ -m battery no ] [ -s sample rate ]
13 [ -f ] [ -v ] [ -n ] [ -x ] [ -a samples ] [ -v ] [ -h ]
14 wmacpi-cli [ -a samples ] [ -V ] [ -v ] ] -b ] [ -r ] [ -h ]
16
18 This manual page documents briefly the wmacpi command.
19 wmacpi is a program that displays the current battery status in a Win‐
21 dowMaker dock app, on systems that support Intel's Advanced Configura‐
22 tion and Power Interface specification (ACPI).
23 The program monitors a battery, displaying its current percentage
25 charge via a bar and a numeric value. It also displays the current
26 power status for the system, the time remaining (calculated based on
27 the remaining battery capacity and the current rate of power usage),
28 and a scrolling message with some hopefully useful information.
29 Clicking on the window cycles through the batteries that the ACPI sys‐
31 tem knows about.
32 wmacpi-cli queries the battery status from the command line. It prints
34 the power status, the percentage remaining for each battery found, and
35 the time remaining if the system is on battery, or the time remaining
36 for each battery to reach full charge if the batteries are charging.
37
39 wmacpi
40 -c, --critical=percentage
42 Set critical low alarm at <percentage>% (default: 10%).
43 -d, --display=display
45 Set the X display to open the window on.
46 -m, --battery=battery number
48 Set the battery to monitor initially.
49 -s, --sample-rate=sample rate
51 Set the rate at which to sample the ACPI data, in number of
52 times per minute. Minimum is 1, ie once a minute, default is 20,
53 maximum is 600.
54 -n, --no-blink
56 Disable blinking power glyph when charging. Note that it still
57 blinks when the battery reports its capacity state as critical.
58 -f, --force-capacity-mode
60 Force the use of capacity mode for calculating time remaining.
61 By defalt wmacpi will use the reported values of remaining
62 capacity and present rate to calculate the time remaining on
63 battery. This flag will force the use of the remaining capacity
64 and time samples to calculate the present rate of drain, and
65 from there the time remaining. Note that this mode of calcula‐
66 tion generally underreports the time remaining. This mode works
67 around certain buggy ACPI BIOSes that fail to report the current
68 rate.
69 -x, --cmdline
71 Run wmacpi in command line mode - this operates identically to
72 wmacpi-cli.
73 -a, --samples=samples
75 Average the time remaining over num samples. This greatly
76 improves the accuracy of the reported time remaining.
77 -V, --verbosity=num
79 Increase the verbosity of the program. Setting this to 1 will
80 print extra error information; 2 will produce informational out‐
81 put; 3 will produce copious debugging output.
82 -v, --version
84 Print the version information.
85 -r, --no-scroll
87 Disable scrolling message.
88 -h, --help
90 Display help.
91 wmacpi-cli
93 -a num Average the time remaining over num samples. This greatly
95 improves the accuracy of the reported time remaining.
96 -V Increase the verbosity of the program. If repeated, the result
98 is the same as setting --verbosity for wmacpi to the number of
99 repetitions.
100 -v Print the version information.
102 -h Display help.
104
106 wmacpi was originally written by Tim Copperfield <timecop@japan.co.jp>,
107 then completely rewritten after 1.34 by Simon Fowler <simon@himi.org>.
108 This manual page was originally written by Simon Richter
110 <sjr@debian.org> for the Debian GNU/Linux system, and then updated by
111 Simon Fowler.
112 Last modification by Simon Fowler <simon@himi.org>, 2007-07-13.
113 July 13 2007 WMACPI(1)