wmshutdown: Add support for suspend and hibernate.
[dockapps.git] / wmtop / README
blob9caecf7e7e5afb274e49cc90494ffc5c793b1a3f
1 Introduction
2 ------------
4 Wmtop maintains a view of the 3 top CPU (or memory) consuming
5 processes displaying the amount of CPU used as a horizontal bar.
6 Very useful for spotting those rogue Netscape processes!
8 To compile:
9 Type 'autoreconf -fvi', './configure', and 'make'.
11 (Note that in previous versions, you had to indicate 'make linux' or 'make
12 freebsd' -- this is now taken care of by ./configure.)
14 To install:
15 If you are superuser type 'make install'
17 Instructions
18 ------------
20 Invoke wmtop using the command 'wmtop'
22 Use -display and -geometry options in the usual way.
24 Use the command line option '-s <time in milliseconds>' to control the
25 frequency of sampling of the processes and '-r <time in milliseconds>' to
26 control how often the display is updated.
28 Use -U to watch only your own processes rather than all of them. While
29 running, a middle mouse click changes between the display of user processes
30 and all processes.
32 Use -x <regexp> to exclude processes whose name matches a given pattern
33 from the list.
35 Use -m to display physical memory usage instead of CPU, but is currently
36 only supported under Linux. While running, a left mouse click changes
37 between cpu and memory display.
39 Use -c 'command' to have a command executed when you right click on wmtop.
40 For example you could launch a window with the real 'top' command for a closer
41 look at a rogue process.
43 Use -a <1..X> to choose a theme for wmtop.
45 Example
46 -------
48 wmtop -U -x '^wm' -c "xterm -e top"
50 Means list my own processes that are not dockapps. Launch top on a right
51 click.
53 Caveats
54 -------
55 As far as I know this only works under Linux or FreeBSD with a
56 /proc filesystem. Tested by me under Linux 2.2.5 and FreeBSD 3.2
57 (PAO) and FreeBSD 4.0 on a Sony Vaio 505TX. Reportedly works also
58 on other platforms including various combnations of Linux and
59 FreeBSD on Intel and Alpha CPU machines. See TODO file for information
60 about porting progress.
62 Credits
63 -------
65 I have liberally borrowed code from wmsysmon by Dave Clark. Thanks!
67 Thanks to Cyrille Mars (mailto:cmars@club-internet.fr) for some
68 new pixmaps and beta testing.
69 Thanks to Thomas C Sobczyns for beta testing (mailto:tcs@mit.edu).
70 Thanks to Brian Servis (mailto:servis@purdue.edu) for improvements to the
71 Makefile (that I have since ruined...).
72 Thanks to Alan Swanson (mailto:swanson@uklinux.net) for some bugfixes and
73 improvements.