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 hint lines change color as the system load increases.
  49 .RS
  50 .IP \(bu
  51 green for multiples of 1
  52 .IP \(bu
  53 yellow for multiples of 10
  54 .IP \(bu
  55 red for multiples of 100
  56 .RE
  57 .IP \(bu
  58 a realtime disk I/O stress meter;
  59 .IP \(bu
  60 auto-scaled disk I/O load meter;
  61 .IP \(bu
  62 realtime memory and swap usage meters;
  63 .IP \(bu
  64 a display for system uptime;
  65 .IP \(bu
  66 three user-defined commands to launch.
  67
  68 .SH OPTIONS
  69
  70 .TP
  71 .BI \-display \ display
  72 This option specifies the X server to contact; see
  73 .IR X(7x) .
  74
  75 .TP
  76 .BI \-geometry \ geometry
  77 This option specifies the preferred position of clock; see
  78 .IR X(7x) .
  79
  80 .TP
  81 .BR \-l
  82 Lock the mode, so that it cannot be cycled by clicking on the upper-left
  83 widget.  You can use this to open multiple copies of
  84 .BR WMMon ,
  85 each set to a different mode.
  86
  87 .TP
  88 .BR \-i
  89 Start in disk I/O mode, which displays instantaneous disk usage and
  90 average disk load.
  91
  92 .TP
  93 .BR \-b
  94 Include buffers and cache in memory usage calculations. The trend in
  95 recent years has been to not include this in memory load monitors, but it
  96 can be useful information.
  97
  98 .TP
  99 .BR \-s
 100 Start in system information mode, which displays memory usage, swap usage,
 101 and uptime.
 102
 103 .TP
 104 .B \-h
 105 Show help information.
 106
 107 .TP
 108 .B \-v
 109 Print the version number.
 110
 111 .SH USAGE
 112 The
 113 .B WMMon
 114 display can be cycled between CPU, disk I/O, and system
 115 information displays by clicking on the upper-left widget.  This
 116 displays CPU information by default.
 117
 118 WMMon can also be used to launch programs.  You may click either left,
 119 middle, or right mouse buttons in the average-load section of the
 120 window.  The pre-configured program will be launched according to the
 121 mouse button clicked.  (see
 122 .B CONFIGURATION FILE
 123 below.)
 124
 125 In order to move
 126 .BR WMMon ,
 127 drag on the outer edges.  These are not sensitive to mouse clicks.
 128
 129 .SH "DOCKING IN WINDOW MANAGERS"
 130
 131 .TP
 132 Window Maker
 133
 134 Window Maker users should drag and drop the
 135 .B WMMon
 136 window on the Dock.  Then, right-click on the border of the window and
 137 select \*(lqSettings...\*(rq.  Check \*(lqStart when Window Maker
 138 is started\*(rq.
 139
 140 .TP
 141 AfterStep
 142
 143 AfterStep users should put the following in their
 144 .I $HOME/.steprc
 145
 146 .RS 16
 147 Wharf wmmon \- MaxSwallow "wmmon" wmmon &
 148 .RE
 149
 150 .TP
 151 Other window managers
 152
 153 .B WMMon
 154 runs nicely as a 64x64 shaped icon on your desktop.
 155
 156 .SH "CONFIGURATION FILE"
 157
 158 .B WMMon
 159 can launch three user-defined commands, triggered by left, middle and
 160 right mouse button clicks.  You can define the commands to launch in
 161 .I $HOME/.wmmonrc
 162
 163 .RS
 164 .PD 0
 165 left: xterm
 166 .PP
 167 middle: xload
 168 .PP
 169 right: xcalc
 170 .PP
 171 .PD
 172 .RE
 173
 174 If
 175 .B WMMon
 176 detects a
 177 .I $HOME/.wmmonrc
 178 file, it will launch the appropriate command when you click on the clock.
 179
 180 The system administrator can define default commands in
 181 .IR /etc/wmmonrc .
 182 The administrator may also choose to \*(lqfix\*(rq particular commands,
 183 making it impossible for users to change.  These commands can be defined in
 184 .IR /etc/wmmonrc.fixed ,
 185 although this isn't a nice thing to do.
 186
 187 .SH FILES
 188
 189 .I /etc/wmmonrc
 190 .br
 191 .I $HOME/.wmmonrc
 192 .br
 193 .I /etc/wmmonrc.fixed
 194
 195 .SH AUTHORS
 196
 197 .B WMMon
 198 was written by Martijn Pieterse and Antoine Nulle.
 199
 200 This manual page was written by Simon Law <sfllaw@debian.org> for the
 201 .B Debian
 202 system (but may be used by others). It is based on the documentation provided
 203 by the original program.
 204
 205 This manual is free software; you can redistribute it and/or modify
 206 it under the terms of the GNU General Public License as published by
 207 the Free Software Foundation; either version 2 of the License, or (at
 208 your option) any later version.