wmacpiload/doc/wmacpiload.1

   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 WMACPILOAD 1 "March 26, 2003"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   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)
  18 .SH NAME
  19 wmacpiload \- A dockapp to monitor acpi battery status and cpu temp
  20 .SH SYNOPSIS
  21 .B wmapmload [options]
  22 .SH DESCRIPTION
  23 This manual page documents briefly the
  24 .B wmapmload
  25 command.
  26 .PP
  27 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  28 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  29 .\" respectively.
  30 \fBWMacpiLoad\fP is a program to monitor battery and cpu temp. It is a dockapp
  31 that is supported by X window managers such as Window Maker, AfterStep, BlackBox, and
  32 Enlightenment.
  33
  34 The CPU temperature is displayed in the top half.  The battery load percentage
  35 is in the bottom half in two manner : number and graphic. Next to percentage
  36 number are the on-line/on-battery and on-charge status. It has an LCD
  37 look-alike user interface.
  38 The back-light may be turned on/off by clicking the mouse button 1 (left)
  39 over the application. If battery status is below a critical level, an
  40 alarm-mode will alert you by turning on and off back-light. This can be
  41 stopped (and restarted) by clicking the mouse button 3 (right) over the
  42 application. An application can be launched when alarm is on to notify
  43 user that level is too low.
  44 By clicking with mouse button 2 (middle), the computer can be put in
  45 STANDBY (default) or SUSPEND mode (with CONTROL key).
  46
  47 .SH OPTIONS
  48 This program follows the usual GNU command line syntax, with long options
  49 starting with two dashes (`\-'). A summary of options is included below.
  50 .TP
  51 .B \-d,  \-\-display <string>
  52 Attempt to open a window on the named X display. In the absence of  this option,
  53 the  display  specified  by the
  54 .B DISPLAY
  55 environment variable is used.
  56 .TP
  57 .B \-bl, \-\-backlight
  58 turn on back-light
  59 .TP
  60 .B \-lc, \-\-light\-color <color>
  61 back-light color (rgb:6E/C6/3B is default)
  62 .TP
  63 .B \-i,  \-\-interval <number>
  64 number of secs between updates (1 is default)
  65 .TP
  66 .B \-a,  \-\-alarm <number>
  67 low battery level when to raise alarm (20 is default)
  68 .TP
  69 .B \-h,  \-\-help
  70 show help text and exit
  71 .TP
  72 .B \-v,  \-\-version
  73 show program version and exit
  74 .TP
  75 .B \-w,  \-\-windowed
  76 run the application in windowed mode
  77 .TP
  78 .B \-bw, \-\-broken\-wm
  79 activate broken window manager fix
  80 .TP
  81 .B \-n,  \-\-notify <string>
  82 command to launch each time there is alarm
  83 .TP
  84 .B \-s,  \-\-suspend <string>
  85 set command for acpi suspend
  86 .TP
  87 .B \-S,  \-\-standby <string>
  88 set command for acpi standby
  89
  90
  91 .SH AUTHOR
  92 WMACPILoad was assembled by Anthony Peacock <bratag44@hotmail.com> It is massively based on code by
  93 Thomas Nemeth <tnemeth@free.fr>.  It is largely based on WMMemMon and WMCPULoad by Seiichi
  94 SATO <ssato@sh.rim.or.jp>, WMMemLoad by Mark Staggs <me@markstaggs.net> and wmapm by Chris D.
  95 Faulhaber <jedgar@speck.ml.org> Michael G. Henderson <mghenderson@lanl.gov>.