wmlongrun/doc/wmlongrun.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 WMLONGRUN 1 "March 13, 2002"
   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 wmlongrun \- A dockapp to monitor the LongRun(tm) status on Crusoe(tm)
  20 processors.
  21 .SH SYNOPSIS
  22 .B wmlongrun [options]
  23 .SH DESCRIPTION
  24 This manual page documents briefly the
  25 .B wmlongrun
  26 command.
  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 \fBWMLongRun\fP is a program to monitor for LongRun(tm). It displays the current
  32 LongRun(tm) settings and status: the frequency, the LongRun(tm) flags
  33 (performance or economy), and the performance level (expressed as a percentile).
  34
  35 It is a dockapp (dockable application) that is supported by X window managers
  36 such as Window Maker, AfterStep, BlackBox, and Enlightenment. It has two user
  37 interfaces: an LCD look-alike user interface and an LED-interface.  If you
  38 select the LCD-interfaces, the back-light may be turned on/off by clicking the
  39 mouse button over the application.
  40
  41 .SH OPTIONS
  42 This program follows the usual GNU command line syntax, with long options
  43 starting with two dashes (`\-'). A summary of options is included below.
  44 .TP
  45 .B \-d,  \-\-display <string>
  46 Attempt to open a window on the named X display. In the absence of  this option,
  47 the  display  specified  by the
  48 .B DISPLAY
  49 environment variable is used.
  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 \-cd,  \-\-cpuid\-device <device>
  61 specify Linux CPUID device ('/dev/cpu/0/cpuid' is default)
  62 .TP
  63 .B \-md,  \-\-msr\-device <device>
  64 specify Linux MSR device ('/dev/cpu/0/msr' is default)
  65 .TP
  66 .B \-l,  \-\-led
  67 run the application with LED interface
  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
  81 .SH AUTHOR
  82 Seiichi SATO <ssato@sh.rim.or.jp>.