began for maemo
[xscreensaver] / xscreensaver / hacks / petri.man
1 .TH XScreenSaver 1 "06-Jul-2000" "X Version 11"
2 .SH NAME
3 petri - simulates mold growing in a petri dish
4 .SH SYNOPSIS
5 .B petri
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-size \fIinteger\fP] [\-mem-throttle \fIamount\fP] [\-count \fIinteger\fP] [\-originalcolors] [\-diaglim \fIreal\fP] [\-anychan \fIreal\fP] [\-minorchan \fIreal\fP] [\-instantdeathchan \fIreal\fP] [\-minlifespeed \fIreal\fP] [\-maxlifespeed \fIreal\fP] [\-mindeathspeed \fIreal\fP] [\-maxdeathspeed \fIreal\fP] [\-minlifespan \fIinteger\fP] [\-maxlifespan \fIinteger\fP]
7 .SH DESCRIPTION
8 \fIpetri\fP simulates mold growing in a petri dish via a state-heavy grid
9 of automata (vaguely like Conway's Life, only with much more state per
10 cell).
11 .SH OPTIONS
12 .I petri
13 accepts the following options:
14 .TP 8
15 .B \-window
16 Draw on a newly-created window.  This is the default.
17 .TP 8
18 .B \-root
19 Draw on the root window.
20 .TP 8
21 .B \-mono 
22 If on a color display, pretend we're on a monochrome display.
23 .TP 8
24 .B \-install
25 Install a private colormap for the window.
26 .TP 8
27 .B \-visual \fIvisual\fP
28 Which visual to use.  Legal values are the name of a visual class,
29 or the id number (decimal or hex) of a specific visual.
30 .TP 8
31 .B \-delay \fImicroseconds\fP
32 The interframe delay, in microseconds. Defaults to 10000, resource
33 \fIdelay\fP.
34 .TP 8
35 .B \-size \fIinteger\fP
36 The size of a cell in pixels. Defaults to 4, resource \fIsize\fP.
37 .TP 8
38 .B \-mem-throttle \fIamount\fP
39 The maximum amount of memory to consume, specified either in megabytes
40 (suffix "M"), kilobytes (suffix "K"), or bytes (sans suffix). In order
41 to meet the memory requirement, the cell size may be increased.
42 Defaults to 22M, resource \fImemThrottle\fP.
43 .TP 8
44 .B \-count \fIinteger\fP
45 How many different varieties of mold to grow (including Black Death).
46 Defaults to 8, resource \fIcount\fP.
47 .TP 8
48 .B \-originalcolors
49 If specified, indicates that the colors used should be the artist's
50 original choices (a fixed set of primary and secondary colors). In this
51 case, count must be 8 or less. Defaults to not specified (i.e., false), 
52 resource \fIoriginalcolors\fP.
53 .TP 8
54 .B \-diaglim \fIreal\fP 
55 The age limit for diagonal growth as a multiplier of
56 orthogonal growth (range 1..2). 1 means square growth, 1.414
57 (i.e., \fIsqrt(2)\fP) means approximately circular growth, 2 means
58 diamond growth. Defaults to 1.414, resource \fIdiaglim\fP.
59 .TP 8
60 .B \-anychan \fIreal\fP 
61 The chance (range 0..1) that at each iteration, one or more
62 new cells will be born. Defaults to 0.0015, resource \fIanychan\fP.
63 .TP 8
64 .B \-minorchan \fIreal\fP
65 The chance (range 0..1) that, given that new cells will be born, that only
66 two will be added (hence being a minor cell birth event).
67 Defaults to 0.5, resource \fIminorchan\fP.
68 .TP 8
69 .B \-instantdeathchan \fIreal\fP
70 The chance (range 0..1) that, given that death and destruction will happen,
71 that instead of using Black Death cells, death will come instantaneously.
72 Defaults to 0.2, resource \fIinstantdeathchan\fP.
73 .TP 8
74 .B \-minlifespeed \fIreal\fP 
75 The minimum speed for living cells as a fraction of the maximum possible
76 speed (range 0..1). Defaults to 0.04, resource \fIminlifespeed\fP.
77 .TP 8
78 .B \-maxlifespeed \fIreal\fP
79 The maximum speed for living cells as a fraction of the maximum possible
80 speed (range 0..1). Defaults to 0.13, resource \fImaxlifespeed\fP.
81 .TP 8
82 .B \-mindeathspeed \fIreal\fP
83 The minimum speed for Black Death cells as a fraction of the maximum possible
84 speed (range 0..1). Defaults to 0.42, resource \fImindeathspeed\fP.
85 .TP 8
86 .B \-maxdeathspeed \fIreal\fP
87 The maximum speed for Black Death cells as a fraction of the maximum possible
88 speed (range 0..1). Defaults to 0.46, resource \fImaxdeathspeed\fP.
89 .TP 8
90 .B \-minlifespan \fIinteger\fP 
91 The minimum lifespan for a colony, in iterations, before Black Death
92 comes. Defaults to 500, resource \fIminlifespan\fP.
93 .TP 8
94 .B \-maxlifespan \fIinteger\fP
95 The maximum lifespan for a colony, in iterations, before Black Death
96 comes. Defaults to 1500, resource \fImaxlifespan\fP.
97 .SH ENVIRONMENT
98 .PP
99 .TP 8
100 .B DISPLAY
101 to get the default host and display number.
102 .TP 8
103 .B XENVIRONMENT
104 to get the name of a resource file that overrides the global resources
105 stored in the RESOURCE_MANAGER property.
106 .SH X RESOURCES
107 There are resource equivalents for each option, noted above.
108 .SH BUGS
109 There are no known bugs in
110 .I petri
111 as of this writing.
112 .SH SEE ALSO
113 .BR xscreensaver (1)
114 .SH COPYRIGHT
115 Copyright \(co 1992-2000 by Dan Bornstein.
116
117 Permission to use, copy, modify, distribute, and sell this software and its
118 documentation for any purpose is hereby granted without fee, provided that
119 the above copyright notice appear in all copies and that both that
120 copyright notice and this permission notice appear in supporting
121 documentation.  No representations are made about the suitability of this
122 software for any purpose.  It is provided "as is" without express or 
123 implied warranty.
124 .SH AUTHOR
125 Dan Bornstein <danfuzz@milk.com>, 06-Jul-2000.