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