dockapps/wmfsm/wmfsm/wmfsm.1
Doug Torrance d9d5dd1343 wmfsm: Add -a command line option to select appearance at runtime.
Also update Makefile to install appearance XPMs during "make install".
2015-01-22 11:12:10 +00:00

69 lines
2.1 KiB
Groff

.TH "WMFSM" "1"
.SH "NAME"
wmfsm \(em shows the amount of disk space available
.SH "SYNOPSIS"
.PP
\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]
.SH "DESCRIPTION"
.PP
\fBwmfsm\fP is a WindowMaker dock
application that shows the amount of disk space available on mounted
file systems with colored bars.
.SH "OPTIONS"
.PP
This program follows the usual GNU command line syntax,
with long options starting with two dashes (`\-'). A summary of
options is included below.
.IP "\fB\-h\fP, \fB\-\-help\fP " 10
Show summary of options.
.IP "\fB\-v\fP, \fB\-\-version\fP " 10
Show version of program.
.IP "\fB\-n\fP, \fB\-\-normal\fP " 10
Show the entire bars in the same color.
.IP "\fB\-f\fP, \fB\-\-fire\fP " 10
Render the bars as gradients. You may switch between
the normal and fire modes by mouse clicks anywhere on
wmfsm.
.IP "\fB\-b\fP, \fB\-\-blink\fP " 10
Blink the bars if the filesystem is 95% full.
.IP "\fB\-\-noblink\fP " 10
Do not blink if the filesystem is 95% full.
.IP "\fB\-display\fP " 10
Draw on the specified display.
.IP "\fB\-d\fP, \fB\-\-delay\fP " 10
Wait the specified number of milliseconds to redraw
the window.
.IP "\fB\-a\fP, \fB\-\-appearance\fP " 10
Select an appearance file. Note that these files may be found in the wmfsm
data directory, likely /usr/local/share/wmfsm or /usr/share/wmfsm.
.SH "FILES"
.PP
You may exclude filesystems from being show by wmfsm
by listing them in the ~/.wmfsmrc file. It should have as its
first line either [include] or [exclude].
The next lines are filesystems that are either explicitly included
or excluded respectively.
Note: the format of the ~/.wmfsmrc file is very strict. Make sure
there are no whitespaces at the beginning or at the end of lines.
No comments (#) are allowed. Here is an example:
[exclude]
.br
/proc
.br
/dev/pts
.br
/floppy
.br
/cdrom
.SH "SEE ALSO"
.PP
X (1x), wmaker (1), df (1).
.SH "AUTHOR"
.PP
This manual page was written by Chris Gray
<cgray4@po-box.mcgill.ca>.