wmacpi/wmacpi.1

   1 .TH WMACPI 1 "July 13 2007"
   2 .SH NAME
   3 wmacpi \- Battery status monitor for systems supporting ACPI
   4 .SH NAME
   5 wmacpi-cli \- Query battery status for systems supporting ACPI
   6 .SH SYNOPSIS
   7 .B wmacpi
   8 [
   9 .RI -c
  10 value ]
  11 [
  12 .RI -d
  13 display ]
  14 [
  15 .RI -m
  16 battery no ]
  17 [
  18 .RI -s
  19 sample rate ]
  20 [
  21 .RI -f
  22 ]
  23 [
  24 .RI -v
  25 ]
  26 [
  27 .RI -n
  28 ]
  29 [
  30 .RI -x
  31 ]
  32 [
  33 .RI -a
  34 samples ]
  35 [
  36 .RI -v
  37 ]
  38 [
  39 .RI -h
  40 ]
  41 .PP
  42 .B wmacpi-cli
  43 [
  44 .RI -a
  45 samples ]
  46 [
  47 .RI -V
  48 ]
  49 [
  50 .RI -v
  51 ]
  52 ]
  53 .RI -b
  54 ]
  55 [
  56 .RI -r
  57 ]
  58 [
  59 .RI -h
  60 ]
  61 .SH DESCRIPTION
  62 This manual page documents briefly the
  63 .B wmacpi
  64 command.
  65 .PP
  66 .B wmacpi
  67 is a program that displays the current battery status in a WindowMaker
  68 dock app, on systems that support Intel's Advanced Configuration and
  69 Power Interface specification (ACPI).
  70 .PP
  71 The program monitors a battery, displaying its current percentage
  72 charge via a bar and a numeric value. It also displays the current
  73 power status for the system, the time remaining (calculated based on
  74 the remaining battery capacity and the current rate of power usage),
  75 and a scrolling message with some hopefully useful information.
  76 .PP
  77 Clicking on the window cycles through the batteries that the ACPI
  78 system knows about.
  79 .PP
  80 .B wmacpi-cli
  81 queries the battery status from the command line. It prints the power
  82 status, the percentage remaining for each battery found, and the time
  83 remaining if the system is on battery, or the time remaining for each
  84 battery to reach full charge if the batteries are charging.
  85 .SH OPTIONS
  86 .B wmacpi
  87 .TP
  88 .B \-c, --critical=percentage
  89 Set critical low alarm at <percentage>% (default: 10%).
  90 .TP
  91 .B \-d, --display=display
  92 Set the X display to open the window on.
  93 .TP
  94 .B \-m, --battery=battery number
  95 Set the battery to monitor initially.
  96 .TP
  97 .B \-s, --sample-rate=sample rate
  98 Set the rate at which to sample the ACPI data, in number of times per
  99 minute. Minimum is 1, ie once a minute, default is 20, maximum is 600.
 100 .TP
 101 .B \-n, --no-blink
 102 Disable blinking power glyph when charging. Note that it still blinks when
 103 the battery reports its capacity state as critical.
 104 .TP
 105 .B \-f, --force-capacity-mode
 106 Force the use of capacity mode for calculating time remaining. By defalt
 107 .B wmacpi
 108 will use the reported values of remaining capacity and present rate to
 109 calculate the time remaining on battery. This flag will force the use
 110 of the remaining capacity and time samples to calculate the present
 111 rate of drain, and from there the time remaining. Note that this mode
 112 of calculation generally underreports the time remaining. This mode
 113 works around certain buggy ACPI BIOSes that fail to report the current
 114 rate.
 115 .TP
 116 .B \-x, --cmdline
 117 Run wmacpi in command line mode - this operates identically to
 118 .B wmacpi-cli\&.
 119 .TP
 120 .B \-a, --samples=samples
 121 Average the time remaining over num samples. This greatly improves the
 122 accuracy of the reported time remaining.
 123 .TP
 124 .B \-V, --verbosity=num
 125 Increase the verbosity of the program. Setting this to 1 will print extra
 126 error information; 2 will produce informational output; 3 will produce
 127 copious debugging output.
 128 .TP
 129 .B \-v, --version
 130 Print the version information.
 131 .TP
 132 .B \-r, --no-scroll
 133 Disable scrolling message.
 134 .TP
 135 .B \-h, --help
 136 Display help.
 137 .TP
 138 .B wmacpi-cli
 139 .TP
 140 .B \-a num
 141 Average the time remaining over num samples. This greatly improves the
 142 accuracy of the reported time remaining.
 143 .TP
 144 .B \-V
 145 Increase the verbosity of the program. If repeated, the result is the
 146 same as setting
 147 .B \--verbosity
 148 for
 149 .B wmacpi
 150 to the number of repetitions.
 151 .TP
 152 .B \-v
 153 Print the version information.
 154 .TP
 155 .B \-h
 156 Display help.
 157 .SH AUTHOR
 158 .B wmacpi
 159 was originally written by Tim Copperfield <timecop@japan.co.jp>, then
 160 completely rewritten after 1.34 by Simon Fowler <simon@himi.org>.
 161 .PP
 162 This manual page was originally written by Simon Richter
 163 <sjr@debian.org> for the Debian GNU/Linux system, and then updated by
 164 Simon Fowler.
 165 .br
 166 Last modification by Simon Fowler <simon@himi.org>, 2007-07-13.