a6e4c15d0af0a74d34d7816ff23c8ea0778986e9
[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 [\-delay \fInumber\fP]
11 [\-detail \fInumber\fP]
12 [\-mode \fImode\fP]
13 [\-colors \fInumber\fP]
14 [\-functions \fInumber\fP]
15 .SH DESCRIPTION
16 The \fIifs\fP program draws spinning, colliding iterated-function-system images.
17 .SH OPTIONS
18 .TP 8
19 .B \-visual \fIvisual\fP
20 Specify which visual to use.  Legal values are the name of a visual class,
21 or the id number (decimal or hex) of a specific visual.
22 .TP 8
23 .B \-window
24 Draw on a newly-created window.  This is the default.
25 .TP 8
26 .B \-root
27 Draw on the root window.
28 .TP 8
29 .B \-delay \fInumber\fP
30 Per-frame delay, in microseconds.  Default: 10000
31 .TP 8
32 .B \-mode \fImode\fP
33 Colouring mode. 0 = blend, 1 = per-function, 2 = single colour.  Default: 0
34 .TP 8
35 .B \-colors \fInumber\fP
36 Number of colours to use. Default: 200
37 .TP 8
38 .B \-detail \fInumber\fP
39 Number of times to iterate each function. Default: 9
40 .TP 8
41 .B \-functions \fInumber\fP
42 Number of functions to be iterated. Default: 3
43 .TP 8
44 .B \-ncolors \fInumber\fP
45 Number of colors.  Default: 20.
46 .SH ENVIRONMENT
47 .PP
48 .TP 8
49 .B DISPLAY
50 to get the default host and display number.
51 .TP 8
52 .B XENVIRONMENT
53 to get the name of a resource file that overrides the global resources
54 stored in the RESOURCE_MANAGER property.
55 .SH SEE ALSO
56 .BR X (1),
57 .BR xscreensaver (1),
58 .BR ifs (1)
59 .SH COPYRIGHT
60 Copyright \(co Chris Le Sueur (thefishface@gmail.com) February 2005
61
62 Permission is hereby granted, free of charge, to any person obtaining
63 a copy of this software and associated documentation files (the
64 "Software"), to deal in the Software without restriction, including
65 without limitation the rights to use, copy, modify, merge, publish,
66 distribute, sublicense, and/or sell copies of the Software, and to
67 permit persons to whom the Software is furnished to do so, subject to
68 the following conditions:
69
70 The above copyright notice and this permission notice shall be included
71 in all copies or substantial portions of the Software.
72
73 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
74 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
75 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
76 IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
77 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
78 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
79 OTHER DEALINGS IN THE SOFTWARE.
80 .SH AUTHOR
81 Chris Le Sueur