wmcpuload/doc/wmcpuload.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 WMCPULOAD 1 "June 30, 2001"
   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 wmcpuload \- A dockapp to display CPU usage
  20 .SH SYNOPSIS
  21 .B wmcpuload [options]
  22 .SH DESCRIPTION
  23 This manual page documents briefly the
  24 .B wmcpuload
  25 command.
  26 This manual page was written for the Debian GNU/Linux distribution.
  27 .PP
  28 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  29 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  30 .\" respectively.
  31 \fBWMCPULoad\fP is a dockapp that is supported by X window managers such as
  32 Window Maker, AfterStep, BlackBox, and Enlightenment. It displays the current
  33 CPU usage, expressed as a percentile and a chart, and has an LCD look-alike
  34 user interface. The back-light may be turned on/off by clicking the mouse
  35 button over the application. If the CPU usage hits a certain threshold, an
  36 alarm-mode will alert you by turning on back-light.
  37
  38 .SH OPTIONS
  39 This program follows the usual GNU command line syntax, with long options
  40 starting with two dashes (`\-'). A summary of options is included below.
  41 .TP
  42 .B \-d,  \-\-display <string>
  43 Attempt to open a window on the named X display. In the absence of  this option,
  44 the  display  specified  by the
  45 .B DISPLAY
  46 environment variable is used.
  47 .TP
  48 .B \-t,  \-\-title <string>
  49 specify title name
  50 .TP
  51 .B \-bl, \-\-backlight
  52 turn on back-light.
  53 .TP
  54 .B \-lc, \-\-light-color <color>
  55 back-light color (rgb:6E/C6/3B is default)
  56 .TP
  57 .B \-i,  \-\-interval <number>
  58 number of secs between updates (1 is default)
  59 .TP
  60 .B \-c,  \-\-cpu <number> (GNU/Linux / IRIX)
  61 CPU number to monitor (Counting starts with 0).
  62 .TP
  63 .B \-n,  \-\-ignore\-nice (GNU/Linux / FreeBSD / OpenBSD / NetBSD)
  64 ignore a nice value
  65 .TP
  66 .B \-h,  \-\-help
  67 show help text and exit
  68 .TP
  69 .B \-v,  \-\-version
  70 show program version and exit
  71 .TP
  72 .B \-w,  \-\-windowed
  73 run the application in windowed mode
  74 .TP
  75 .B \-wp, \-\-windowed-withpanel
  76 run the application in windowed mode with background panel
  77 .TP
  78 .B \-bw, \-\-broken\-wm
  79 activate broken window manager fix
  80 .TP
  81 .B \-a,  \-\-alarm <percentage>
  82 activate alarm mode. <percentage> is threshold of percentage from 0 to 100.(90 is default)
  83
  84 .SH AUTHOR
  85 WMCPULoad was written by Seiichi SATO <ssato@sh.rim.or.jp>.
  86
  87 This manual page was written by Gordon Fraser <gordon@freakzone.net>,
  88 for the Debian GNU/Linux system (but may be used by others).