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 .SH DESCRIPTION
  16 Lines like crystals grow on a computational substrate.  A simple
  17 perpendicular growth rule creates intricate city-like structures.
  18
  19 Ported from the code by j.tarbell at http://complexification.net
  20 .SH OPTIONS
  21 .I substrate
  22 accepts the following options:
  23 .TP 8
  24 .B \-wireframe (Default: \fIFalse\fP)
  25 Don't draw sand-painting colored effects, only make a wireframe.
  26 .TP 8
  27 .B \-max\-cycles \fIcyclecount\fP (Default: \fI10000\fP)
  28 Maximum number of growth cycles before restarting.  The higher this is,
  29 the more complex the art.
  30 .TP 8
  31 .B \-growth\-delay \fIdelayms\fP (Default: \fI18000\fP)
  32 Delay in ms between growth cycles.  More delay, slower (but smoother
  33 and less CPU intensive)
  34 art.
  35 .TP 8
  36 .B \-initial\-cracks \fInuminitial\fP (Default: \fI3\fP)
  37 Initial number of cracks in the substrate
  38 .TP 8
  39 .B \-max\-cracks \fInummax\fP (Default: \fI100\fP)
  40 Maximum number of cracks in the substrate at a single time
  41 .TP 8
  42 .B \-sand\-grains \fInumgrains\fP (Default: \fI64\fP)
  43 Number of sand grains dropped during coloring.  More grains cause
  44 a denser colour but use more cpu power.
  45 .SH ENVIRONMENT
  46 .PP
  47 .TP 8
  48 .B DISPLAY
  49 to get the default host and display number.
  50 .TP 8
  51 .B XENVIRONMENT
  52 to get the name of a resource file that overrides the global
  53 resources stored in the RESOURCE_MANAGER property.
  54 .SH SEE ALSO
  55 .BR X (1),
  56 .BR xscreensaver (1)
  57 .SH COPYRIGHT
  58 Copyright \(co 2003 by J. Tarbell
  59 (complex@complexification.net, http://www.complexification.net).
  60
  61 Ported to XScreensaver 2004 by Mike Kershaw (dragorn@kismetwireless.net)
  62 .SH AUTHOR
  63 J. Tarbell <complex@complexification.net>, Jun-03
  64
  65 Mike Kershaw <dragorn@kismetwireless.net>, Oct-04