git.hungrycats.org Git - xscreensaver/blob - hacks/substrate.man

   1 .TH Substrate 1 "08-Oct-04" "X Version 11"
   2 .SH NAME
   3 substrate - Grow crystal-like lines on a computational substrate
   4 .SH SYNOPSIS
   5 .B substrate
   6 [\-display \fIhost:display.screen\fP]
   7 [\-foreground \fIcolor\fP]
   8 [\-background \fIcolor\fP]
   9 [\-wireframe]
  10 [\-max\-cycles \fIcyclecount\fP]
  11 [\-growth\-delay \fIdelayms\fP]
  12 [\-initial\-cracks \fInuminitial\fP]
  13 [\-max\-cracks \fInummax\fP]
  14 [\-sand\-grains \fInumgrains\fP]
  15 [\-circle\-percent \fIcirclepercent\fP]
  16 [\-fps]
  17 .SH DESCRIPTION
  18 Lines like crystals grow on a computational substrate.  A simple
  19 perpendicular growth rule creates intricate city-like structures.  Optionally, cracks may also be circular, producing a cityscape more familiar to places for which city planning is a distant, theoretical concern.
  20
  21 Ported from the code by j.tarbell at http://complexification.net
  22 .SH OPTIONS
  23 .I substrate
  24 accepts the following options:
  25 .TP 8
  26 .B \-wireframe (Default: \fIFalse\fP)
  27 Don't draw sand-painting colored effects, only make a wireframe.
  28 .TP 8
  29 .B \-max\-cycles \fIcyclecount\fP (Default: \fI10000\fP)
  30 Maximum number of growth cycles before restarting.  The higher this is,
  31 the more complex the art.
  32 .TP 8
  33 .B \-growth\-delay \fIdelayms\fP (Default: \fI18000\fP)
  34 Delay in ms between growth cycles.  More delay, slower (but smoother
  35 and less CPU intensive)
  36 art.
  37 .TP 8
  38 .B \-initial\-cracks \fInuminitial\fP (Default: \fI3\fP)
  39 Initial number of cracks in the substrate
  40 .TP 8
  41 .B \-max\-cracks \fInummax\fP (Default: \fI100\fP)
  42 Maximum number of cracks in the substrate at a single time
  43 .TP 8
  44 .B \-sand\-grains \fInumgrains\fP (Default: \fI64\fP)
  45 Number of sand grains dropped during coloring.  More grains cause
  46 a denser colour but use more cpu power.
  47 .TP 8
  48 .B \-circle-percent \fIcirclepercent\fP (Default: \fI0\fP)
  49 The percentage of the cracks will be circular.
  50 .TP 8
  51 .B \-fps
  52 Display the current frame rate and CPU load.
  53 .SH ENVIRONMENT
  54 .PP
  55 .TP 8
  56 .B DISPLAY
  57 to get the default host and display number.
  58 .TP 8
  59 .B XENVIRONMENT
  60 to get the name of a resource file that overrides the global
  61 resources stored in the RESOURCE_MANAGER property.
  62 .SH SEE ALSO
  63 .BR X (1),
  64 .BR xscreensaver (1)
  65 .SH COPYRIGHT
  66 Copyright \(co 2003 by J. Tarbell
  67 (complex@complexification.net, http://www.complexification.net).
  68
  69 Ported to XScreensaver 2004 by Mike Kershaw (dragorn@kismetwireless.net)
  70 .SH AUTHOR
  71 J. Tarbell <complex@complexification.net>, Jun-03
  72
  73 Mike Kershaw <dragorn@kismetwireless.net>, Oct-04