wmthrottle/doc/wmthrottle.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 WMTHROTTLE 1 "November 7, 2003"
   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 wmthrottle \- A dockapp to change throttle/performance state of cpu via ACPI
  20 .SH SYNOPSIS
  21 .B wmthrottle [options]
  22 .SH DESCRIPTION
  23 This manual page documents briefly the
  24 .B wmthrottle
  25 command.
  26 .PP
  27 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  28 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  29 .\" respectively.
  30 \fBwmthrottle\fP is a program to throttle cpu via ACPI. It is a dockapp that is supported by X window managers such as Window Maker, AfterStep, BlackBox, and
  31 Enlightenment.
  32
  33 The top half of the app shows the 8 levels of throttling that can be selected
  34 (0 = 100% CPU use). The bottom shows the current percentage of CPU allowed to be
  35 used as well as a green,yellow,red indicator and graph indicator to further
  36 indicate how much of the cpu is throttled.
  37
  38
  39 .SH OPTIONS
  40 This program follows the usual GNU command line syntax, with long options
  41 starting with two dashes (`\-'). A summary of options is included below.
  42 .TP
  43 .B \-d,  \-\-display <string>
  44 Attempt to open a window on the named X display. In the absence of  this option,
  45 the  display  specified  by the
  46 .B DISPLAY
  47 environment variable is used.
  48 .TP
  49 .B \-bl, \-\-backlight
  50 turn on back-light
  51 .TP
  52 .B \-lc, \-\-light\-color <color>
  53 back-light color (rgb:6E/C6/3B is default)
  54 .TP
  55 .B \-i,  \-\-interval <number>
  56 number of secs between updates (1 is default)
  57 .TP
  58 .B \-h,  \-\-help
  59 show help text and exit
  60 .TP
  61 .B \-v,  \-\-version
  62 show program version and exit
  63 .TP
  64 .B \-w,  \-\-windowed
  65 run the application in windowed mode
  66 .TP
  67 .B \-bw, \-\-broken\-wm
  68 activate broken window manager fix (use this if you have problems running it in your window manager)
  69 .TP
  70 .B \-p, \-\-performance
  71 use acpi performance instead of throttling
  72 .TP
  73 .B \-t, \-\-temperature
  74 temperature threshold to start downclocking (to avoid fan noise)
  75 .TP
  76 .B \-e
  77 temperature difference that will cause a state transition (default: 1)\n
  78 .TP
  79
  80
  81 .SH AUTHOR
  82 wmthrottle was assembled by Anthony Peacock <bratag44@hotmail.com>
  83 It is largely based on WMMemMon and WMCPULoad by Seiichi SATO <ssato@sh.rim.or.jp>, WMMemLoad by Mark Staggs <me@markstaggs.net> and wmapm by Chris D. Faulhaber
  84 <jedgar@speck.ml.org> Michael G. Henderson <mghenderson@lanl.gov>, and wmapmload by Thomas Nemeth <tnemeth@free.fr>