wmacpi/README

   1 For install instructions, see "INSTALL" file.
   2
   3 Usage:
   4
   5 +-------------+
   6 |battery graph| <- visual percentage battery remaining
   7 |[:][=] [100%]| <- [:] - on AC (blink when charging) [=] - on battery
   8 |[00:00]  [bX]| <- [00:00] time remaining   [bX] battery being monitored.
   9 |status   area| <- messages scroll here
  10 +-------------+
  11
  12 see wmacpi -h for some command line switches
  13
  14 **********************************************************************
  15
  16 wmacpi is a dockapp ACPI battery monitor for modern kernels (ie,
  17 2.4.17 or later, and 2.6 kernels). Basically, it opens various files
  18 under /proc/acpi, reads status information from them, and then
  19 displays summaries.
  20
  21 Version 1.99 and later provides full support for multiple batteries.
  22 You can tell it to monitor a particular battery with the -m option,
  23 which will display the percentage remaining and current status message
  24 for that battery. The time remaining and AC/battery status are global
  25 - the time remaining is calculated based on all batteries found on the
  26 system. When charging, the time displayed is the time remaining until
  27 the battery is fully charged - this only works sensibly if your ACPI
  28 system is implemented properly (far, far too many laptops have
  29 buggered ACPI implementations).
  30
  31 The displayed time is averaged over 50 samples, each taken every three
  32 seconds (by default). This greatly improves the accuracy of the
  33 numbers - on my laptop, the time remaining seems to be overstated by a
  34 good hour or so if you only sample once compared to fifty times.
  35
  36 Some ACPI implementations are stupid enough to block interrupts while
  37 reading status information from the battery over a slow bus - this
  38 means that on such b0rken laptops, running an ACPI battery monitor
  39 could affect interactivity. To provide a workaround for this, current
  40 versions of wmacpi supports setting the sample rate from the command
  41 line. The --sample-rate option specifies the number of times the
  42 battery is sampled every minute - the default is 20, and the maximum
  43 value is 600. Since -s 600 translates to sampling every 0.1 seconds,
  44 you really don't want to do that unless you're just having fun . . .
  45
  46 Also provided is a command line tool to report the battery status. By
  47 default this will only sample once, but with the -a option you can
  48 specify a number. Be aware that it will try to take all those samples
  49 in the space of one second, so if your ACPI implementation is b0rken
  50 this could have adverse effects.
  51
  52 Please report bugs to <wmaker-dev@googlegroups.com>
  53
  54 Simon Fowler, 2007-07-13.