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

   1 .TH XScreenSaver 1 "7-mar-93" "X Version 11"
   2 .SH NAME
   3 maze \- an automated X11 demo repeatedly creating and solving a random maze
   4 .SH SYNOPSIS
   5 .B maze
   6 [\-\-display \fIhost:display.screen\fP] [\-\-foreground \fIcolor\fP]
   7 [\-\-background \fIcolor\fP] [\-\-window] [\-\-root]
   8 [\-\-window\-id \fInumber\fP][\-\-install] [\-\-visual \fIvisual\fP] [\-\-grid\-size \fIpixels\fP] [\-\-live\-color \fIcolor\fP] [\-\-dead\-color \fIcolor\fP] [\-\-solve\-delay \fIusecs\fP] [\-\-pre\-delay \fIusecs\fP] [\-\-post\-delay \fIusecs\fP] [\-\-generator \fIinteger\fP] [\-\-max\-length \fIinteger\fP]
   9 [\-\-fps]
  10 .SH DESCRIPTION
  11 The \fImaze\fP program creates a "random" maze and then solves it with
  12 graphical feedback.
  13 .SH OPTIONS
  14 .I maze
  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 \-\-window\-id \fInumber\fP
  24 Draw on the specified window.
  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 \-\-grid\-size \fIpixels\fP
  34 The size of each block of the maze, in pixels; default is 0, meaning
  35 pick a random grid size.  Minimum meaningful value is 2.
  36 .TP 8
  37 .B \-\-live\-color \fIcolor\fP
  38 The color of the path.
  39 .TP 8
  40 .B \-\-dead\-color \fIcolor\fP
  41 The color of the failed path (it is also stippled with a 50% pattern.)
  42 .TP 8
  43 .B \-\-skip\-color \fIcolor\fP
  44 The maze solver will choose to not go down a path if it can "see" (in a
  45 straight line) that it is a dead end.  This is the color to use for paths
  46 that are skipped for this reason.
  47 .TP 8
  48 .B \-\-surround\-color \fIcolor\fP
  49 If the maze solver ever completely encloses an area within the maze, then
  50 it knows that the exit is not in there (and in fact the interior of that
  51 area might not even be reachable.)  It will mark out those cells using this
  52 color.
  53 .TP 8
  54 .B \-\-solve\-delay \fIinteger\fP
  55 Delay (in microseconds) between each step of the solution path.
  56 Default 5000, or about 1/200th second.
  57 .TP 8
  58 .B \-\-pre\-delay \fIinteger\fP
  59 Delay (in microseconds) between generating a maze and starting to solve it.
  60 Default 2000000 (2 seconds.)
  61 .TP 8
  62 .B \-\-post\-delay \fIinteger\fP
  63 Delay (in microseconds) after solving a maze and before generating a new one.
  64 Default 4000000 (4 seconds.)
  65 .TP 8
  66 .B \-\-generator \fInum\fP
  67 Sets the algorithm that will be used to generate the mazes. The
  68 default is \-1, which randomly selects an algorithm for each maze that
  69 is generated. Generator 0 is the original one, and works by walking
  70 around randomly until we hit a place we've been before, then
  71 backtracking and trying a new direction somewhere. Generator 1 picks a
  72 random spot in the maze, then draws a straight wall from that spot in
  73 a random direction until it hits another wall (and continues until the
  74 maze is complete). Generator 2 is based on sets. Initially all cells
  75 are in different sets. Then two neighboring cells are chosen and if
  76 they are in different sets, their sets are joined. If they were in the
  77 same set, a wall is built between them. This continues until the maze is
  78 complete.
  79
  80 All generators generate mazes with a certain 'characteristic'. See if you
  81 can spot them!
  82
  83 The three algorithms are essentially Kruskal, Prim, and a depth-first
  84 recursive backtracker.
  85 .TP 8
  86 .B \-\-max\-length \fInum\fP
  87 Controls the maximum length of walls drawn in one go by generator 1.
  88 .PP
  89 Clicking the mouse in the maze window controls it.
  90 .TP 16
  91 .B "LeftButton
  92 Clears the window and restarts maze.
  93 .TP 16
  94 .B MiddleButton
  95 Pause or unpause the program.
  96 .TP 16
  97 .B RightButton
  98 Exit.
  99 .TP 8
 100 .B \-\-fps
 101 Display the current frame rate and CPU load.
 102 .SH BUGS
 103 Expose events force a restart of maze.
 104
 105 Mouse actions are based on "raw" values (Button1, Button2 and Button3)
 106 instead of using the pointer map.
 107 .SH ENVIRONMENT
 108 .PP
 109 .TP 8
 110 .B DISPLAY
 111 to get the default host and display number.
 112 .TP 8
 113 .B XENVIRONMENT
 114 to get the name of a resource file that overrides the global resources
 115 stored in the RESOURCE_MANAGER property.
 116 .TP 8
 117 .B XSCREENSAVER_WINDOW
 118 The window ID to use with \fI\-\-root\fP.
 119 .SH SEE ALSO
 120 .BR X (1),
 121 .BR xscreensaver (1)
 122 .SH COPYRIGHT
 123 .PP
 124 Copyright \(co 1988 by Sun Microsystems, Inc. Mountain View, CA.
 125 .PP
 126 All Rights Reserved
 127 .PP
 128 Permission to use, copy, modify, and distribute this software and its
 129 documentation for any purpose and without fee is hereby granted, provided that
 130 the above copyright notice appear in all copies and that both that copyright
 131 notice and this permission notice appear in supporting documentation, and that
 132 the names of Sun or MIT not be used in advertising or publicity pertaining to
 133 distribution of the software without specific prior written permission. Sun
 134 and M.I.T.  make no representations about the suitability of this software for
 135 any purpose. It is provided "as is" without any express or implied warranty.
 136 .PP
 137 SUN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
 138 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN
 139 NO EVENT SHALL SUN BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
 140 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 141 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 142 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 143 .SH AUTHOR(s)
 144 .nf
 145 Zack Weinberg [ Smarter maze-solver ] zack@rabi.phys.columbia.edu
 146 Johannes Keukelaar [ Generators 1 and 2 ] johannes@nada.kth.se
 147   Royal Institute of Technology, Stockholm, Sweden
 148 Jim Randell     [ XScreenSaver version ] jmr@mddjmr.fc.hp.com
 149   HPLabs, Bristol
 150 Richard Hess    [ X11 extensions ]      {...}!uunet!cimshop!rhess
 151   Consilium, Mountain View, CA
 152 Dave Lemke      [ X11 version ]         lemke@sun.COM
 153   Sun MicroSystems, Mountain View, CA
 154 Martin Weiss    [ SunView version ]
 155   Sun MicroSystems, Mountain View, CA
 156 .fi