http://slackware.bholcomb.com/slackware/slackware-11.0/source/xap/xscreensaver/xscree...
[xscreensaver] / hacks / ifs.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 ifs - draws spinning, colliding iterated-function-system images
4 .SH SYNOPSIS
5 .B ifs
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-no\-db]
11 [\-delay \fInumber\fP]
12 [\-detail \fInumber\fP]
13 [\-colors \fInumber\fP]
14 [\-functions \fInumber\fP]
15 [\-iterate | \-recurse]
16 [\-no\-rotate]
17 [\-no\-scale]
18 [\-no\-translate]
19 .SH DESCRIPTION
20 The \fIifs\fP program draws spinning, colliding iterated-function-system images.
21 .SH OPTIONS
22 .TP 8
23 .B \-visual \fIvisual\fP
24 Specify which visual to use.  Legal values are the name of a visual class,
25 or the id number (decimal or hex) of a specific visual.
26 .TP 8
27 .B \-window
28 Draw on a newly-created window.  This is the default.
29 .TP 8
30 .B \-root
31 Draw on the root window.
32 .TP 8
33 .B \-no\-db
34 Disable double-buffering.
35 .TP 8
36 .B \-delay \fInumber\fP
37 Per-frame delay, in microseconds.  Default: 20000
38 .TP 8
39 .B \-colors \fInumber\fP
40 Number of colours to use. Default: 200
41 .TP 8
42 .B \-detail \fInumber\fP
43 In \fI\-iterate\fP mode, number of times to randomly iterate the
44 functions, in thousands.  In \fI\-recurse\fP mode, number of times
45 to apply functions (recursion depth) before drawing each point.
46 Default: 9
47 .TP 8
48 .B \-functions \fInumber\fP
49 Number of functions to be iterated. Default: 3
50 .TP 8
51 .B \-iterate
52 Calculate by iteratively applying the functions in a random order,
53 usually faster than \fI\-recurse\fP.  This is the default.
54 .TP 8
55 .B \-recurse
56 Calculate by recursively applying all combinations of the functions.
57 This is the historical behavior and may produce neater output than
58 \fI\-iterate\fP.
59 .TP 8
60 .B \-no-rotate
61 Disable the rotation component of the functions.
62 .TP 8
63 .B \-no-scale
64 Disable the scaling component of the functions.
65 .TP 8
66 .B \-no-translate
67 Disable the varying translation component of the functions.
68 .SH ENVIRONMENT
69 .PP
70 .TP 8
71 .B DISPLAY
72 to get the default host and display number.
73 .TP 8
74 .B XENVIRONMENT
75 to get the name of a resource file that overrides the global resources
76 stored in the RESOURCE_MANAGER property.
77 .SH SEE ALSO
78 .BR X (1),
79 .BR xscreensaver (1),
80 .BR ifs (MANSUFFIX)
81 .SH COPYRIGHT
82 Copyright \(co Chris Le Sueur and Robby Griffin, 2005-2006
83
84 Permission is hereby granted, free of charge, to any person obtaining
85 a copy of this software and associated documentation files (the
86 "Software"), to deal in the Software without restriction, including
87 without limitation the rights to use, copy, modify, merge, publish,
88 distribute, sublicense, and/or sell copies of the Software, and to
89 permit persons to whom the Software is furnished to do so, subject to
90 the following conditions:
91
92 The above copyright notice and this permission notice shall be included
93 in all copies or substantial portions of the Software.
94
95 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
96 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
97 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
98 IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
99 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
100 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
101 OTHER DEALINGS IN THE SOFTWARE.
102 .SH AUTHOR
103 This version by Chris Le Sueur <thefishface@gmail.com>, Feb 2005
104 Many improvements by Robby Griffin <rmg@terc.edu>, Mar 2006