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