wmacpi: Bump to wmacpi-ng version 0.90.
[dockapps.git] / wmacpi / debian / wmacpi-ng.1
blob9744b6d9564215e6f29174add16be0c25e4e9de6
1 .TH WMACPI-NG 1 "July 11, 2003"
2 .SH NAME
3 wmacpi-ng \- Battery status monitor for systems supporting ACPI
4 .SH NAME
5 acpi-ng \- Query battery status for systems supporting ACPI
6 .SH SYNOPSIS
7 .B wmacpi-ng
9 .RI -b
12 .RI -c
13 value ]
15 .RI -d
16 display ]
18 .RI -m
19 battery no ]
21 .RI -v
24 .RI -n
27 .RI -V
30 .RI -h
32 .PP
33 .B acpi-ng
35 .RI -a
36 samples ]
38 .RI -v 
41 .RI -V
44 .RI -h
46 .SH DESCRIPTION
47 This manual page documents briefly the
48 .B wmacpi-ng
49 command.
50 .PP
51 .B wmacpi-ng
52 is a program that displays the current battery status in a WindowMaker
53 dock app, on systems that support Intel's Advanced Configuration and
54 Power Interface specification (ACPI).
55 .PP
56 The program monitors a battery, displaying its current percentage
57 charge via a bar and a numeric value. It also displays the current
58 power status for the system, the time remaining (calculated based on
59 the remaining battery capacity and the current rate of power usage),
60 and a scrolling message with some hopefully useful information.
61 .PP
62 Clicking on the window cycles through the batteries that the ACPI
63 system knows about.
64 .PP
65 .B acpi-ng
66 queries the battery status from the command line. It prints the power
67 status, the percentage remaining for each battery found, and the time
68 remaining if the system is on battery, or the time remaining for each
69 battery to reach full charge if the batteries are charging.
70 .SH OPTIONS
71 .B wmacpi-ng
72 .TP
73 .B \-b
74 Make noise when battery is critical low (beep).
75 .TP
76 .B \-c value
77 Set critical low alarm at <value>% (default: 10%).
78 .TP
79 .B \-d
80 Set the X display to open the window on.
81 .TP
82 .B \-m
83 Set the battery to monitor initially.
84 .TP
85 .B \-n
86 Disable blinking power glyph when charging. Note that it still blinks when 
87 the battery reports its capacity state as critical.
88 .B \-v
89 Increase the verbosity of the program. Can be used more than once -
90 each successive use increases the verbosity.
91 .TP
92 .B \-V
93 Print the version information.
94 .TP
95 .B \-h
96 Display help.
97 .TP
98 .B acpi-ng
99 .TP
100 .B \-a num
101 Average the time remaining over num samples. This greatly improves the
102 accuracy of the reported time remaining.
104 .B \-v
105 Increase the verbosity of the program, as for
106 .B wmacpi-ng
108 .B \-V
109 Print the version information.
111 .B \-h
112 Display help.
114 .SH SEE ALSO
115 .BR wmapm (1)
117 .SH AUTHOR
118 .B wmacpi
119 as written by Tim Copperfield <timecop@japan.co.jp>. 
120 .B wmacpi-ng 
121 is a reworking of 
122 .B wmacpi 1.34
123 to support recent kernel versions, performed by Simon Fowler
124 <simon@dreamcraft.com.au>. 
126 This manual page was originally written by Simon Richter
127 <sjr@debian.org> for the Debian GNU/Linux system, and then updated for 
128 .B wmacpi-ng
129 by Simon Fowler.
131 Last modification by Simon Fowler <simon@dreamcraft.com.au>, 2003-07-11.