git.hungrycats.org Git - xscreensaver/blob - hacks/glx/cube21.man

   1 .TH XScreenSaver 1 "30-Aug-05" "X Version 11"
   2 .SH NAME
   3 cube21 - animates the Cube 21 puzzle
   4 .SH SYNOPSIS
   5 .B cube21
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-install]
  11 [\-delay \fImicroseconds\fP]
  12 [\-texture] [\-no\-texture]
  13 [\-mono]
  14 [\-wireframe]
  15 [\-spin] [\-no\-spin]
  16 [\-wander] [\-no\-wander]
  17 [\-randomize] [\-no\-randomize]
  18 [\-spinspeed \fInumber\fP]
  19 [\-rotspeed \fInumber\fP]
  20 [\-wanderspeed \fInumber\fP]
  21 [\-wait \fInumber\fP]
  22 [\-cubesize \fInumber\fP]
  23 [\-colormode \fIarg\fP]
  24 [\-fps]
  25 .SH DESCRIPTION
  26 This program animates a puzzle known as Cube 21 or Square-1.
  27 Its moves are chosen randomly.
  28 .P
  29 Cube 21 is a Rubik-like puzzle invented in 1992.  Its specialities are that
  30 it can change its shape and even the number of possible moves.  It can have
  31 more than 200 different shapes and the total number of configurations
  32 (assuming colors) is several tens of billions.
  33 .SH OPTIONS
  34 .I cube21
  35 accepts the following options:
  36 .TP 8
  37 .B \-window
  38 Draw on a newly-created window.  This is the default.
  39 .TP 8
  40 .B \-root
  41 Draw on the root window.
  42 .TP 8
  43 .B \-install
  44 Install a private colormap for the window.
  45 .TP 8
  46 .B \-visual \fIvisual\fP\fP
  47 Specify which visual to use.  Legal values are the name of a visual class,
  48 or the id number (decimal or hex) of a specific visual.
  49 .TP 8
  50 .B \-delay \fImicroseconds\fP
  51 How long to pause between frames.  Default is 20000, or 0.02 second.
  52 .TP 8
  53 .B \-texture
  54 Use texture maps.  This is the default.
  55 .TP 8
  56 .B \-no\-texture
  57 Use solid colors.
  58 .TP 8
  59 .B \-mono
  60 Disable both texture maps and colors.
  61 .TP 8
  62 .B \-wireframe
  63 Only draw outlines.  Outlines of all pieces, not only the whole object, are drawn.
  64 .TP 8
  65 .B \-spin
  66 Spin the whole object around X, Y and Z axes.  This is the default.
  67 .TP 8
  68 .B \-no\-spin
  69 Do not spin, showing the same three faces all the time.
  70 .TP 8
  71 .B \-wander
  72 Move the object around the screen.  This is the default.
  73 .TP 8
  74 .B \-no\-wander
  75 Keep the object centered on the screen.
  76 .TP 8
  77 .B \-randomize
  78 Shuffle the puzzle randomly at startup.  This is the default.
  79 .TP 8
  80 .B \-no\-randomize
  81 Do not shuffle at startup, begin at the shape of cube.
  82 .TP 8
  83 .B \-spinspeed \fInumber\fP
  84 The relative speed of spinning.  Default is 1.0.
  85 .TP 8
  86 .B \-rotspeed \fInumber\fP
  87 The relative speed of the moves.  Default is 3.0.  Setting to \(<= 0.0
  88 makes the object stay at one configuration.
  89 .TP 8
  90 .B \-wanderspeed \fInumber\fP
  91 The relative speed of wandering around the screen.  Default is 1.0.
  92 .TP 8
  93 .B \-wait \fInumber\fP
  94 How long to stay at ending position after each move.  The meaning of
  95 the argument is again relative.  Default is 40.0.
  96 .TP 8
  97 .B \-cubesize \fInumber\fP
  98 Size of the object.  Value of 3.0 fills roughly all the screen (its height).  Default is 0.7.
  99 .TP 8
 100 .B \-colormode \fIargument\fP
 101 How many and which colors should the object have.  The colors are put on the piece
 102 faces so that the puzzle is solvable.  The inner faces are not influenced.
 103 .RS
 104 .TP 8
 105 .BR se " or " silver
 106 Simulate the "Silver Edition" \- white and one random color.
 107 .TP 8
 108 .BR 2 " or " two
 109 Two random colors.
 110 .TP 8
 111 .BR ce " or " classic
 112 Simulate the "Classic Edition" \- white, yellow, orange, red, green and blue.
 113 .TP 8
 114 .BR 6 " or " six
 115 Six random colors.
 116 .TP 8
 117 .BR 1 " or " random " or " rnd
 118 One random color.
 119 .TP 8
 120 Anything else
 121 All faces white.
 122 .RE
 123 .TP 8
 124 .B \-fps
 125 Display the current frame rate, CPU load, and polygon count.
 126 .SH ENVIRONMENT
 127 .PP
 128 .TP 8
 129 .B DISPLAY
 130 to get the default host and display number.
 131 .TP 8
 132 .B XENVIRONMENT
 133 to get the name of a resource file that overrides the global resources
 134 stored in the RESOURCE_MANAGER property.
 135 .SH SEE ALSO
 136 .BR X (1),
 137 .BR xscreensaver (1)
 138 .SH COPYRIGHT
 139 Copyright \(co 2005 by Vaclav Potocek.  Permission to use, copy, modify,
 140 distribute, and sell this software and its documentation for any purpose is
 141 hereby granted without fee, provided that the above copyright notice appear
 142 in all copies and that both that copyright notice and this permission notice
 143 appear in supporting documentation.  No representations are made about the
 144 suitability of this software for any purpose.  It is provided "as is" without
 145 express or implied warranty.
 146 .SH AUTHOR
 147 Vaclav (Vasek) Potocek <vasek.potocek@post.cz>, 30-Aug-05.