wmmon/wmmon/wmmon.1

   1 '\" t
   2 .\" Man page for wmmon
   3 .\" Copyright (c) 2003  Software in the Public Interest, Inc.
   4 .\"
   5 .\" This program is free software; you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation; either version 2 of the License, or (at
   8 .\" your option) any later version.
   9 .\"
  10 .\" This program is distributed in the hope that it will be useful, but
  11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 .\" General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License
  16 .\" along with this program; if not, write to the Free Software
  17 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 .\"
  19 .TH wmmon 1 "May 1998" "WMMON 1.0b2"
  20
  21 .SH NAME
  22 wmmon \- Window Maker dockapp for monitoring system information
  23
  24 .SH SYNOPSIS
  25
  26 .B wmmon
  27 [
  28 .I OPTION
  29 ]
  30
  31 .SH DESCRIPTION
  32
  33 .B WMMon
  34 monitors the realtime CPU load as well as the average system load,
  35 and gives you some nice additional features too. It is intended for
  36 docking in Window Maker.
  37
  38 It currently provides:
  39
  40 .IP \(bu 4
  41 a realtime CPU stress meter;
  42 .IP \(bu
  43 an auto-scaled average system load meter, like
  44 .B xload
  45 and
  46 .BR wmavgload ;
  47 .IP \(bu
  48 a realtime disk I/O stress meter;
  49 .IP \(bu
  50 auto-scaled disk I/O load meter;
  51 .IP \(bu
  52 realtime memory and swap usage meters;
  53 .IP \(bu
  54 a display for system uptime;
  55 .IP \(bu
  56 three user-defined commands to launch.
  57
  58 .SH OPTIONS
  59
  60 .TP
  61 .BI \-display \ display
  62 This option specifies the X server to contact; see
  63 .IR X(7x) .
  64
  65 .TP
  66 .BI \-geometry \ geometry
  67 This option specifies the preferred position of clock; see
  68 .IR X(7x) .
  69
  70 .TP
  71 .BR \-l
  72 Lock the mode, so that it cannot be cycled by clicking on the upper-left
  73 widget.  You can use this to open multiple copies of
  74 .BR WMMon ,
  75 each set to a different mode.
  76
  77 .TP
  78 .BR \-i
  79 Start in disk I/O mode, which displays instantaneous disk usage and
  80 average disk load.
  81
  82 .TP
  83 .BR \-b
  84 Include buffers and cache in memory usage calculations. The trend in
  85 recent years has been to not include this in memory load monitors, but it
  86 can be useful information.
  87
  88 .TP
  89 .BR \-s
  90 Start in system information mode, which displays memory usage, swap usage,
  91 and uptime.
  92
  93 .TP
  94 .B \-h
  95 Show help information.
  96
  97 .TP
  98 .B \-v
  99 Print the version number.
 100
 101 .SH USAGE
 102 The
 103 .B WMMon
 104 display can be cycled between CPU, disk I/O, and system
 105 information displays by clicking on the upper-left widget.  This
 106 displays CPU information by default.
 107
 108 WMMon can also be used to launch programs.  You may click either left,
 109 middle, or right mouse buttons in the average-load section of the
 110 window.  The pre-configured program will be launched according to the
 111 mouse button clicked.  (see
 112 .B CONFIGURATION FILE
 113 below.)
 114
 115 In order to move
 116 .BR WMMon ,
 117 drag on the outer edges.  These are not sensitive to mouse clicks.
 118
 119 .SH "DOCKING IN WINDOW MANAGERS"
 120
 121 .TP
 122 Window Maker
 123
 124 Window Maker users should drag and drop the
 125 .B WMMon
 126 window on the Dock.  Then, right-click on the border of the window and
 127 select \*(lqSettings...\*(rq.  Check \*(lqStart when Window Maker
 128 is started\*(rq.
 129
 130 .TP
 131 AfterStep
 132
 133 AfterStep users should put the following in their
 134 .I $HOME/.steprc
 135
 136 .RS 16
 137 Wharf wmmon \- MaxSwallow "wmmon" wmmon &
 138 .RE
 139
 140 .TP
 141 Other window managers
 142
 143 .B WMMon
 144 runs nicely as a 64x64 shaped icon on your desktop.
 145
 146 .SH "CONFIGURATION FILE"
 147
 148 .B WMMon
 149 can launch three user-defined commands, triggered by left, middle and
 150 right mouse button clicks.  You can define the commands to launch in
 151 .I $HOME/.wmmonrc
 152
 153 .RS
 154 .PD 0
 155 left: xterm
 156 .PP
 157 middle: xload
 158 .PP
 159 right: xcalc
 160 .PP
 161 .PD
 162 .RE
 163
 164 If
 165 .B WMMon
 166 detects a
 167 .I $HOME/.wmmonrc
 168 file, it will launch the appropriate command when you click on the clock.
 169
 170 The system administrator can define default commands in
 171 .IR /etc/wmmonrc .
 172 The administrator may also choose to \*(lqfix\*(rq particular commands,
 173 making it impossible for users to change.  These commands can be defined in
 174 .IR /etc/wmmonrc.fixed ,
 175 although this isn't a nice thing to do.
 176
 177 .SH FILES
 178
 179 .I /etc/wmmonrc
 180 .br
 181 .I $HOME/.wmmonrc
 182 .br
 183 .I /etc/wmmonrc.fixed
 184
 185 .SH AUTHORS
 186
 187 .B WMMon
 188 was written by Martijn Pieterse and Antoine Nulle.
 189
 190 This manual page was written by Simon Law <sfllaw@debian.org> for the
 191 .B Debian
 192 system (but may be used by others). It is based on the documentation provided
 193 by the original program.
 194
 195 This manual is free software; you can redistribute it and/or modify
 196 it under the terms of the GNU General Public License as published by
 197 the Free Software Foundation; either version 2 of the License, or (at
 198 your option) any later version.