wmmemload/doc/wmmemload.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 WMMEMLOAD 1 "April 3, 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 wmmemload \- A dockapp to monitor memory/swap usages
  20 .SH SYNOPSIS
  21 .B wmmemload [options]
  22 .SH DESCRIPTION
  23 This manual page documents briefly the
  24 .B wmmemload
  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 \fBWMMemLoad\fP is a program to monitor memory/swap usages. It is a dockapp that is supported by X window managers such as Window Maker, AfterStep, BlackBox, and
  31 Enlightenment.
  32
  33 The current memory usage is displayed in the top half.  The swap usage
  34 is in the bottom half. It has an LCD look-alike user interface.
  35 The back-light may be turned on/off by clicking the mouse button over the
  36 appliacation. If the usage hits a certain threshold, an alarm-mode will alert
  37 you by turning on back-light.
  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 \-b,  \-\-ignore\-buffers
  59 ignore buffers. (GNU/Linux)
  60 .TP
  61 .B \-c,  \-\-ignore\-cached
  62 ignore cached pages. (GNU/Linux / FreeBSD)
  63 .TP
  64 .B \-wr,  \-\-ignore\-wired
  65 ignore wired pages. (FreeBSD)
  66 .TP
  67 .B \-h,  \-\-help
  68 show help text and exit.
  69 .TP
  70 .B \-v,  \-\-version
  71 show program version and exit.
  72 .TP
  73 .B \-w,  \-\-windowed
  74 run the application in windowed mode
  75 .TP
  76 .B \-bw, \-\-broken\-wm
  77 activate broken window manager fix
  78 .TP
  79 .B \-am,  \-\-alarm\-mem <percentage>
  80 activate alarm mode of memory. <percentage> is threshold of percentage from 0
  81 to 100.(90 is default)
  82 .TP
  83 .B \-as,  \-\-alarm\-swap <percentage>
  84 activate alarm mode of swap. <percentage> is threshold of percentage from 0 to
  85 100.(50 is default)
  86
  87 .SH AUTHOR
  88 WMMemLoad was assembled by Mark Staggs <me@markstaggs.net>.  It is largely based
  89 on WMMemMon and WMCPULoad by Seiichi SATO <ssato@sh.rim.or.jp>.