http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / swirl.man
1 .TH XScreenSaver 1 "13-May-97" "X Version 11"
2 .SH NAME
3 swirl - draws swirly color-cycling patterns
4 .SH SYNOPSIS
5 .B swirl
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8 [\-visual \fIvisual\fP]
9 [\-ncolors \fIinteger\fP]
10 [\-delay \fImicroseconds\fP]
11 [\-count \fIinteger\fP]
12
13 [\-fps]
14 .SH DESCRIPTION
15 The \fIswirl\fP program draws swirly color-cycling patterns.
16 .SH OPTIONS
17 .I swirl
18 accepts the following options:
19 .TP 8
20 .B \-window
21 Draw on a newly-created window.  This is the default.
22 .TP 8
23 .B \-root
24 Draw on the root window.
25 .TP 8
26 .B \-mono 
27 If on a color display, pretend we're on a monochrome display.
28 .TP 8
29 .B \-install
30 Install a private colormap for the window.
31 .TP 8
32 .B \-visual \fIvisual\fP
33 Specify which visual to use.  Legal values are the name of a visual class,
34 or the id number (decimal or hex) of a specific visual.
35 .TP 8
36 .B \-ncolors \fIinteger\fP
37 How many colors should be used (if possible).  Default 200.
38 .TP 8
39 .B \-count \fIinteger\fP
40
41 .TP 8
42 .B \-fps
43 Display the current frame rate and CPU load.
44 .SH ENVIRONMENT
45 .PP
46 .TP 8
47 .B DISPLAY
48 to get the default host and display number.
49 .TP 8
50 .B XENVIRONMENT
51 to get the name of a resource file that overrides the global resources
52 stored in the RESOURCE_MANAGER property.
53 .SH SEE ALSO
54 .BR X (1),
55 .BR xscreensaver (1),
56 .BR xlock (1)
57 .SH COPYRIGHT
58 Copyright \(co 1994 M. Dobie.
59
60 Permission to use, copy, modify, and distribute this software and its
61 documentation for any purpose and without fee is hereby granted,
62 provided that the above copyright notice appear in all copies and that
63 both that copyright notice and this permission notice appear in
64 supporting documentation. 
65
66 .SH AUTHOR
67 M.Dobie <mrd@ecs.soton.ac.uk>, 1994.
68
69 Ability to run standalone or with \fIxscreensaver\fP added by 
70 Jamie Zawinski <jwz@jwz.org>, 13-May-97.