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

   1 .TH XScreenSaver 1 "10-May-97" "X Version 11"
   2 .SH NAME
   3 penrose - draws quasiperiodic tilings
   4 .SH SYNOPSIS
   5 .B penrose
   6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-ncolors \fIinteger\fP] [\-delay \fImicroseconds\fP] [\-size \fIinteger\fP] [\-ammann] [\-no\-ammann]
   7
   8 .SH DESCRIPTION
   9 The \fIpenrose\fP program draws quasiperiodic tilings.
  10
  11 See Onoda, Steinhardt, DiVincenzo and Socolar in
  12 Phys. Rev. Lett. 60, #25, 1988 or
  13 Strandburg in Computers in Physics, Sep/Oct 1991.
  14
  15 This implementation uses the simpler version of the growth
  16 algorithm, i.e., if there are no forced vertices, a randomly chosen
  17 tile is added to a randomly chosen vertex (no preference for those
  18 108 degree angles).
  19
  20 There are two essential differences to the algorithm presented in
  21 the literature: First, we do not allow the tiling to enclose an
  22 untiled area.  Whenever this is in danger of happening, we just
  23 do not add the tile, hoping for a better random choice the next
  24 time.  Second, when choosing a vertex randomly, we will take
  25 one that lies withing the viewport if available.  If this seems to
  26 cause enclosures in the forced rule case, we will allow invisible
  27 vertices to be chosen.
  28
  29 Tiling is restarted whenever one of the following happens: there
  30 are no incomplete vertices within the viewport or the tiling has
  31 extended a window's length beyond the edge of the window
  32 horizontally or vertically or forced rule choice has failed 100
  33 times due to areas about to become enclosed.
  34
  35 .SH OPTIONS
  36 .I penrose
  37 accepts the following options:
  38 .TP 8
  39 .B \-window
  40 Draw on a newly-created window.  This is the default.
  41 .TP 8
  42 .B \-root
  43 Draw on the root window.
  44 .TP 8
  45 .B \-mono
  46 If on a color display, pretend we're on a monochrome display.
  47 .TP 8
  48 .B \-install
  49 Install a private colormap for the window.
  50 .TP 8
  51 .B \-visual \fIvisual\fP
  52 Specify which visual to use.  Legal values are the name of a visual class,
  53 or the id number (decimal or hex) of a specific visual.
  54 .TP 8
  55 .B \-ncolors \fIinteger\fP
  56 How many colors should be used (if possible).  Default 64.
  57 The colors are chosen randomly.
  58 .TP 8
  59 .B \-size \fIinteger\fP
  60 How big the tiles should be.  Default 40 pixels.
  61
  62 .TP 8
  63 .B \-ammann \fIinteger\fP
  64 .TP 8
  65 .B \-no\-ammann \fIinteger\fP
  66 Whether Ammann lines should be added.
  67
  68 .SH ENVIRONMENT
  69 .PP
  70 .TP 8
  71 .B DISPLAY
  72 to get the default host and display number.
  73 .TP 8
  74 .B XENVIRONMENT
  75 to get the name of a resource file that overrides the global resources
  76 stored in the RESOURCE_MANAGER property.
  77 .SH SEE ALSO
  78 .BR X (1),
  79 .BR xscreensaver (1),
  80 .BR xlock (1)
  81 .SH COPYRIGHT
  82 Copyright \(co 1996 by Timo Korvola.
  83
  84 Permission to use, copy, modify, and distribute this software and its
  85 documentation for any purpose and without fee is hereby granted,
  86 provided that the above copyright notice appear in all copies and that
  87 both that copyright notice and this permission notice appear in
  88 supporting documentation.
  89 .SH AUTHOR
  90 Timo Korvola <tkorvola@dopey.hut.fi>, 1996.
  91
  92 Ability to run standalone or with \fIxscreensaver\fP added by
  93 Jamie Zawinski <jwz@jwz.org>, 10-May-97.