From http://www.jwz.org/xscreensaver/xscreensaver-5.30.tar.gz
[xscreensaver] / hacks / rd-bomb.man
1 .TH XScreenSaver 1 "10-May-97" "X Version 11"
2 .SH NAME
3 rd-bomb - reaction/diffusion textures
4 .SH SYNOPSIS
5 .B rd-bomb
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-install]
8 [\-visual \fIvisual\fP] [\-width \fIn\fP] [\-height \fIn\fP]
9 [\-reaction \fIn\fP] [\-diffusion \fIn\fP]
10 [\-size \fIf\fP] [\-speed \fIf\fP] [\-delay \fImillisecs\fP]
11 [\-fps]
12 .SH DESCRIPTION
13
14 The \fIrd-bomb\fP program draws reaction/diffusion textures.  The code
15 is derived from the 'd' mode of the "bomb" visual musical instrument
16 (see http://www.cs.cmu.edu/~spot/bomb.html).  I got the equations from
17 xmorphia (http://www.ccsf.caltech.edu/ismap/image.html), which is
18 based on a version of the Gray-Scott model taken from:
19     John E. Pearson "Complex Patterns in a Simple System"
20     Science, 261,189, 9 July 1993.
21
22 If the frame-rate is too low, consider decreasing the width and height
23 of the tile, or decreasing the size of the active part of the screen.
24
25 .SH OPTIONS
26
27 If one of the reaction, diffusion, radius, and palette options is set
28 to a negative value, then that option will be set to a random
29 appropriate value.
30
31 Be sure to try "-speed 1 -size 0.1 -epoch 3000".
32
33 .I rd-bomb
34 accepts the following options:
35 .TP 8
36 .B \-window
37 Draw on a newly-created window.  This is the default.
38 .TP 8
39 .B \-root
40 Draw on the root window.
41 .TP 8
42 .B \-install
43 Install a private colormap for the window.
44 .TP 8
45 .B \-visual \fIvisual\fP
46 Specify which visual to use.  Legal values are the name of a visual class,
47 or the id number (decimal or hex) of a specific visual.
48 .TP 8
49 .B \-width \fIn\fP
50 .TP 8
51 .B \-height \fIn\fP
52 Specify the size of the tile, in pixels.
53 .TP 8
54 .B \-reaction \fIn\fP
55 .TP 8
56 .B \-diffusion \fIn\fP
57 These are constants in the equations that effect its visual nature.
58 Each may be one of 0, 1, or 2. Default is -1: these constants are
59 chosen randomly.
60 .TP 8
61 .B \-radius \fIn\fP
62 Size of the seed.
63 .TP 8
64 .B \-size \fIf\fP
65 What fraction of the window is actively drawn, a floating point number
66 between 0 (exclusive) and 1 (inclusive).  Default is 1.0.
67 .TP 8
68 .B \-speed \fIf\fP
69 When a fraction of the screen is active, the active area moves at this
70 rate (a floating point number).  Default is zero.  Suggested value: 1.0.
71 .TP 8
72 .B \-delay \fImillisecs\fP
73 How many milliseconds to delay between frames; default 1, or 
74 about 1/1000th of a second.
75 .TP 8
76 .B \-fps
77 Display the current frame rate and CPU load.
78 .SH ENVIRONMENT
79 .PP
80 .TP 8
81 .B DISPLAY
82 to get the default host and display number.
83 .TP 8
84 .B XENVIRONMENT
85 to get the name of a resource file that overrides the global resources
86 stored in the RESOURCE_MANAGER property.
87 .SH SEE ALSO
88 .BR X (1),
89 .BR xscreensaver (1),
90 .BR xlock (1)
91 .SH COPYRIGHT
92 Copyright \(co 1997 by Scott Draves.
93
94 Permission to use, copy, modify, and distribute this software and its
95 documentation for any purpose and without fee is hereby granted,
96 provided that the above copyright notice appear in all copies and that
97 both that copyright notice and this permission notice appear in
98 supporting documentation. 
99 .SH AUTHOR
100 Scott Draves <spot@cs.cmu.edu>, 9/97