wmcpuload/README

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