00cbfec2e01655c03393c2191e76cb04c10f1ade
[xscreensaver] / hacks / cloudlife.man
1 .TH XScreenSaver 6 "20-May-2003" "X Version 11"
2 .SH NAME
3 cloudlife - a cellular automaton based on Conway's Life
4 .SH SYNOPSIS
5 .B cloudlife
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-ncolors \fIinteger\fP] [\-cycle-delay \fImicroseconds\fP] [\-cycle-colors \fIinteger\fP][\-cell-size \fIinteger\fP] [\-initial-density \fIinteger\fP] [\-max-age \fIinteger\fP]
7
8 .SH DESCRIPTION
9 The \fIcloudlife\fP program draws a cellular
10 automaton based on Conway's Life, except that
11 cells have a maximum age, and only one pixel per
12 cell is drawn every tick.
13 .SH OPTIONS
14 .I cloudlife
15 accepts the following options:
16 .TP 8
17 .B \-window
18 Draw on a newly-created window.  This is the default.
19 .TP 8
20 .B \-root
21 Draw on the root window.
22 .TP 8
23 .B \-mono 
24 If on a color display, pretend we're on a monochrome display.
25 .TP 8
26 .B \-install
27 Install a private colormap for the window.
28 .TP 8
29 .B \-visual \fIvisual\fP
30 Specify which visual to use.  Legal values are the name of a visual class,
31 or the id number (decimal or hex) of a specific visual.
32 .TP 8
33 .B \-cycle-delay \fIinteger\fP
34 Time in microseconds to sleep between ticks.  Default 25000.
35 .TP 8
36 .B \-cycle-colors \fIinteger\fP
37 How many ticks should elapse between cycling colors.  0 to disable
38 color cycling.  Default 2.
39 .TP 8
40 .B \-ncolors \fIinteger\fP
41 How many colors should be used (if possible).  Default 64.
42 The colors are chosen randomly.
43 .TP 8
44 .B \-cell-size \fIinteger\fP
45 Size of each cell, in powers of 2.  Default 3 (8-pixel cells).
46 .TP 8
47 .B \-initial-density \fIinteger\fP
48 Percentage of cells that are alive at start and when the
49 field is repopulated.  Default 30.  
50 .TP 8
51 .B \-max-age \fIinteger\fP
52 Maximum age for a cell.  Default 64.
53
54
55 .SH ENVIRONMENT
56 .PP
57 .TP 8
58 .B DISPLAY
59 to get the default host and display number.
60 .TP 8
61 .B XENVIRONMENT
62 to get the name of a resource file that overrides the global resources
63 stored in the RESOURCE_MANAGER property.
64 .SH SEE ALSO
65 .BR X (1),
66 .BR xscreensaver (1),
67 .BR xlock (1)
68 .SH COPYRIGHT
69
70 Copyright \(co 2003 by Don Marti.  Based on
71 examples from the hacks directory of xscreensaver,
72 Copyright (c) 1997, 1998, 2002 Jamie Zawinski
73 <jwz@jwz.org>
74
75 This man page based on the man page of sierpinski,
76 Copyright \(co 1996 by Desmond Daignault.
77
78 Permission to use, copy, modify, and distribute this software and its
79 documentation for any purpose and without fee is hereby granted,
80 provided that the above copyright notice appear in all copies and that
81 both that copyright notice and this permission notice appear in
82 supporting documentation. 
83 .SH AUTHOR
84 Don Marti <dmarti@zgp.org> 20 May 2003.  
85