wmail: fixed some typo's.
[dockapps.git] / wmlongrun / README
blob2ee70b2972305e3cbf7d89629a3cee1cf2cdf833
1 WMLongRun - A dockapp to monitor the LongRun(tm) status on Crusoe
3 General Information
4 ===================
5 WMLongRun is a program to monitor for LongRun. It displays the current
6 LongRun(tm) settings and status: the frequency, the LongRun(tm) flags
7 (performance or economy), and the performance level (expressed as a percentile).
9 It is a dockapp (dockable application) that is supported by X window managers
10 such as Window Maker, AfterStep, BlackBox, and Enlightenment. It has two user
11 interfaces: an LCD look-alike user interface and an LED-interface. If you select
12 the LCD-interfaces, the back-light may be turned on/off by clicking the mouse
13 button over the application.
15 It runs on GNU/Linux / FreeBSD.
18 Installation
19 ============
20 See the file 'INSTALL' for instructions.
23 Copyright
24 =========
25 GPL applies all portions of the code I wrote. Please see COPYING file.
28 Usage
29 =====
30 * To turn on/off back-light, click the mouse button over the application.
31 * To see the following help messages, type 'wmlongrun --help'.
33 $ wmlongrun [OPTIONS]
34  -d,  --display <string>        display to use
35  -bl, --backlight               turn on back-light
36  -lc, --light-color <color>     back-light color (rgb:6E/C6/3B is default)
37  -i,  --interval <number>       number of secs between updates (1 is default)
38  -cd, --cpuid-device <device>   CPUID device ('/dev/cpu/0/cpuid' is default)
39  -md, --msr-device <device>     MSR device   ('/dev/cpu/0/msr' is default)
40  -l,  --led                     run the application with LED interface
41  -h,  --help                    show this help text and exit
42  -v,  --version                 show program version and exit
43  -w,  --windowed                run the application in windowed mode
44  -bw, --broken-wm               activate broken window manager fix
46 NOTE:
47 '-cd, --cpuid-device','-md, --msr-device' are options for GNU/Linux.
49 For AfterStep users
50 ===================
51 Add this line to your ~/GNUstep/Library/AfterStep/wharf:
53   *Wharf wmlongrun - Swallow "wmlongrun" wmlongrun -w &
56 For Enlightenment users
57 =======================
58 '-bw, --broken-wm' option will help you.
61 Bug reports
62 ===========
63 Please send e-mail to wmaker-dev@googlegroups.com
66 URL
67 ===
68 http://www.dockapps.net/wmlongrun