wmcpuload/README

   1 WMCPULoad - A dockapp to monitor CPU usage
   2
   3 General Information
   4 ===================
   5 WMCPULoad is a program to monitor CPU usage. It is a dockapp that is supported
   6 by X window managers such as Window Maker, AfterStep, BlackBox, and
   7 Enlightenment.
   8
   9 It displays the current usage, expressed as a percentile and a chart, and has an
  10 LCD look-alike user interface. The back-light may be turned on/off by clicking
  11 the mouse button over the application. If the CPU usage hits a certain
  12 threshold, an alarm-mode will alert you by turning back-light on.
  13
  14 It runs on GNU/Linux / FreeBSD / OpenBSD / NetBSD / BSDi / Solaris / Cygwin /
  15 IRIX / Darwin .
  16
  17 Installation
  18 ============
  19 See the file 'INSTALL' for instructions.
  20
  21
  22 Copyright
  23 =========
  24 - GPL applies all portions of the code I wrote. Please see COPYING file.
  25
  26
  27 Usage
  28 =====
  29 $ wmcpuload [OPTIONS]
  30  -d,  --display <string>        display to use
  31  -t,  --title <string>          application title name
  32  -bl, --backlight               turn on back-light
  33  -lc, --light-color <color>     back-light color (rgb:6E/C6/3B is default)
  34  -i,  --interval <number>       number of secs between updates (1 is default)
  35  -c,  --cpu <number>            which CPU is monitored (0, 1, ...)
  36  -n,  --ignore-nice             ignore a nice value
  37  -p,  --ignore-proc <name><...> ignore all processes specified by command name
  38  -h,  --help                    show this help text and exit
  39  -v,  --version                 show program version and exit
  40  -w,  --windowed                run the application in windowed mode
  41  -wp, --windowed-withpanel      run the application in windowed mode
  42                                 with background panel
  43  -bw, --broken-wm               activate broken window manager fix
  44  -a,  --alarm <percentage>      activate alarm mode. <percentage> is threshold
  45                                 of percentage from 0 to 100 (90 is default)
  46
  47 NOTES:
  48 - '-n, --ignore-nice' option is activated under GNU/Linux / {Free,Open,Net}BSD.
  49 - '-p, --ignore-proc' option is activated under GNU/Linux.
  50 - '-c,  --cpu'        option is activated under GNU/Linux / IRIX.
  51
  52
  53 For AfterStep users
  54 ===================
  55 Add this line to your ~/GNUstep/Library/AfterStep/wharf:
  56
  57   *Wharf wmcpuload - Swallow "wmcpuload" wmcpuload -w &
  58
  59
  60 For GNOME users
  61 ===============
  62 If you want to run wmcpuload as swallowed application inside the GNOME panel,
  63 open 'Create swallow Applet' dialog and enter the values as below.
  64
  65   1. Title application to swallow: <title name> - specified with '-t' option
  66   2. Command (optional): wmcpuload -w -t <title name>
  67   3. width: 62
  68   4. height: 62
  69
  70 NOTE: GNOME2 does not support the swallowed application.
  71
  72
  73 For Enlightenment users
  74 =======================
  75 Use '-bw, --broken-wm' option.
  76
  77
  78 For Golem users
  79 ===============
  80 Add following entry to your ~/.golem/plugins/pier/rc
  81
  82   param "item" "dock" {
  83           param "cmd" "exec wmcpuload";
  84           param "class" "wmcpuload.DockApp";
  85   }
  86
  87
  88 Frequently Asked Questions
  89 ==========================
  90
  91 Q) Which window managers do support dockapps?
  92 A) - Window Maker  http://www.windowmaker.org/
  93    - AfterStep     http://www.afterstep.org/
  94    - Blackbox      http://blackboxwm.sourceforge.net/
  95    - Enlightenment http://www.enlightenment.org/
  96    - Fluxbox       http://fluxbox.sourceforge.net/
  97    - Waimea        http://waimea.sourceforge.net/
  98    - PWM           http://www.students.tut.fi/~tuomov/pwm/
  99    - Golem         http://golem.sourceforge.net/
 100
 101 Q) Can I set the initial size?
 102 A) No. As far as I know, there is no dockapp which can be set the size.
 103
 104 Q) (How) Does WMCPULoad support SMP system?
 105 A) WMCPULoad will probably work fine on an SMP system. However, it only displays
 106    the usage statistics for the all CPUs. I may add the new command line option
 107    (e.g. '--cpu <number>') to specify the CPU number. but this feature is the
 108    bottom of my TODO list, since I do not have an SMP system.
 109    -----------------------------------------------------------------------------
 110    NOTE: WMCPULoad has '-c, --cpu' option since version 0.8.0. but it only works
 111          on GNU/Linux. (Thanks to Laurent Raufaste for beta test)
 112    -----------------------------------------------------------------------------
 113
 114 Q) Why is kamp-idled spending many CPU time on my GNU/Linux box?
 115 A) kapm-idled executes HLT instructions to save power.
 116
 117    Stephen Rothwell (GNU/Linux APM maintainer) said:
 118    "kapm-idled may do quite a lot more than just execute HLT instructions
 119    depending on how smart the BIOS is about saving power.  Unfortunately, some
 120    BIOSs are pretty dumb and in some cases more power is consumed by having
 121    CONFIG_APM_CPU_IDLE defined in your kernel build than by not."
 122                                               -- from debian-devel mailing lists
 123
 124    '-p, --ignore-proc' option will help you. (e.g., wmcpuload -p kapm-idled)
 125
 126
 127 Bug reports
 128 ===========
 129 Please send e-mail to wmaker-dev@lists.windowmaker.org.
 130
 131
 132 URL
 133 ===
 134 http://dockapps.net/wmcpuload
 135