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