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