wmclockmon: update change-log
[dockapps.git] / wmfsm / wmfsm / wmfsm.1
blobde691fffd53ec68609e959f6ad1df4b3569b4b49
1 .TH "WMFSM" "1"
2 .SH "NAME"
3 wmfsm \(em shows the amount of disk space available
4 .SH "SYNOPSIS"
5 .PP
6 \fBwmfsm\fP [\fB\-\-normal, \-n  \fP]  [\fB\-\-fire, \-f \fP]  [\fB\-\-blink, \-b \fP]  [\fB\-\-noblink \fP]  [\fB\-display \fP]  [\fB\-d, \-\-delay \fP]  [\fB\-h, \-\-help \fP]
7 .SH "DESCRIPTION"
8 .PP
9 \fBwmfsm\fP is a WindowMaker dock
10 application that shows the amount of disk space available on mounted
11 file systems with colored bars.
12 .SH "OPTIONS"
13 .PP
14 This program follows the usual GNU command line syntax,
15 with long options starting with two dashes (`\-').  A summary of
16 options is included below.
18 .IP "\fB\-h\fP, \fB\-\-help\fP         " 10
19 Show summary of options.
20 .IP "\fB\-v\fP, \fB\-\-version\fP         " 10
21 Show version of program.
22 .IP "\fB\-n\fP, \fB\-\-normal\fP        " 10
23 Show the entire bars in the same color.
24 .IP "\fB\-f\fP, \fB\-\-fire\fP  " 10
25 Render the bars as gradients.  You may switch between
26 the normal and fire modes by mouse clicks anywhere on
27 wmfsm.
28 .IP "\fB\-b\fP, \fB\-\-blink\fP         " 10
29 Blink the bars if the filesystem is 95% full.
30 .IP "\fB\-\-noblink\fP  " 10
31 Do not blink if the filesystem is 95% full.
32 .IP "\fB\-display\fP    " 10
33 Draw on the specified display.
34 .IP "\fB\-d\fP, \fB\-\-delay\fP         " 10
35 Wait the specified number of milliseconds to redraw
36 the window.
37 .IP "\fB\-a\fP, \fB\-\-appearance\fP    " 10
38 Select an appearance file.  Note that these files may be found in the wmfsm
39 data directory, likely /usr/local/share/wmfsm or /usr/share/wmfsm.
40 .SH "FILES"
41 .PP
42 You may exclude filesystems from being show by wmfsm
43 by listing them in the ~/.wmfsmrc file.  It should have as its
44 first line either [include] or [exclude].
45 The next lines are filesystems that are either explicitly included
46 or excluded respectively.
48 Note: the format of the  ~/.wmfsmrc file is very strict. Make sure
49 there are no whitespaces at the beginning or at the end of lines.
50 No comments (#) are allowed. Here is an example:
52 [exclude]
53 .br
54 /proc
55 .br
56 /dev/pts
57 .br
58 /floppy
59 .br
60 /cdrom
62 .SH "SEE ALSO"
63 .PP
64 X (1x), wmaker (1), df (1).
65 .SH "AUTHOR"
66 .PP
67 This manual page was written by Chris Gray
68 <cgray4@po-box.mcgill.ca>.