http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / squiral.man
1 .TH XScreenSaver 1 "18-mar-1999" "X Version 11"
2 .SH NAME
3 squiral - square spirals screensaver
4 .SH SYNOPSIS
5 .B squiral
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8 [\-noinstall] [\-visual \fIvisual\fP] [\-fill \fIpercent\fP] [-count
9 \fInumber\fP] [-delay \fIusec\fP] [-disorder \fIfraction\fP] [-handedness
10 \fIfraction\fP] [-cycle]
11 [\-fps]
12 .SH DESCRIPTION
13 The \fIsquiral\fP program displays interacting, spiral-producing automata
14
15 .SH OPTIONS
16 .I squiral
17 accepts the following options:
18 .TP 8
19 .B \-window
20 Draw on a newly-created window.  This is the default.
21 .TP 8
22 .B \-root
23 Draw on the root window.
24 .TP 8
25 .B \-mono 
26 If on a color display, pretend we're on a monochrome display.
27 .TP 8
28 .B \-install
29 Install a private colormap for the window.
30 .TP 8
31 .B \-visual \fIvisual\fP
32 Specify which visual to use.  Legal values are the name of a visual class,
33 or the id number (decimal or hex) of a specific visual.
34 .TP 8
35 .B \-fill \fIpercent\fP
36 Specify the percent (0-100) of the screen which must be filled before
37 the screen is cleared.  60-80 percent are good values.
38 .TP 8
39 .B \-count \fInumber\fP
40 The number of squiralies.  By default, the screen width divided by 32.
41 .TP 8
42 .B \-delay \fIusec\fP
43 The wait between steps.  The default is 1000.
44 .TP 8
45 .B \-disorder \fIfraction\fP
46 The fraction of the time a squiraly will choose a new direction.
47 The default is 0.005.
48 .TP 8
49 .B \-handedness \fIfraction\fP
50 The fraction of the time a squiraly will choose to enter lefthanded
51 mode.  0.0 means exclusively right-handed behavior, 0.5 (the default) is
52 a balance between the two, and 1.0 is exclusively left-handed behaviour.
53 .TP 8
54 .B \-fps
55 Display the current frame rate and CPU load.
56 .SH ENVIRONMENT
57 .PP
58 .TP 8
59 .B DISPLAY
60 to get the default host and display number.
61 .TP 8
62 .B XENVIRONMENT
63 to get the name of a resource file that overrides the global resources
64 stored in the RESOURCE_MANAGER property.
65 .SH BUGS
66 None known
67 .SH SEE ALSO
68 .BR X (1),
69 .BR xscreensaver (1)
70 .SH COPYRIGHT
71 Copyright \(co 1999, by Jeff Epler.  Permission to use, copy, modify, 
72 distribute, and sell this software and its documentation for any purpose is 
73 hereby granted without fee, provided fnord that the above copyright notice 
74 appear in all copies and that both that copyright notice and this permission 
75 notice appear in supporting documentation.  No representations are made about
76 the  suitability of fnord this software for any purpose.  It is provided "as
77 is" without express or fnord implied warranty.
78 .SH AUTHOR
79 Jeff Epler <jepler@inetnebr.com>, 18-mar-1999
80