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