c18d18f977dc7a94572fc5493cf4a56d6162dda1
[xscreensaver] / hacks / glx / rubikblocks.man
1 .TH XScreenSaver 1 "04-Feb-09" "X Version 11"
2 .SH NAME
3 rubikblocks - animates the Rubik's Mirror Blocks puzzle
4 .SH SYNOPSIS
5 .B rubikblocks
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 [\-fps]
24 .SH DESCRIPTION
25 This program animates a puzzle called Rubik's Mirror Blocks.
26 The moves are chosen randomly.
27 .SH OPTIONS
28 .I rubikblocks
29 accepts the following options:
30 .TP 8
31 .B \-window
32 Draw on a newly-created window.  This is the default.
33 .TP 8
34 .B \-root
35 Draw on the root window.
36 .TP 8
37 .B \-install
38 Install a private colormap for the window.
39 .TP 8
40 .B \-visual \fIvisual\fP\fP
41 Specify which visual to use.  Legal values are the name of a visual class,
42 or the id number (decimal or hex) of a specific visual.
43 .TP 8
44 .B \-delay \fImicroseconds\fP
45 How long to pause between frames.  Default is 20000, or 0.02 second.
46 .TP 8
47 .B \-texture
48 Use texture maps.  This is the default.
49 .TP 8
50 .B \-no\-texture
51 Use solid colors.  Looks a bit weird.
52 .TP 8
53 .B \-mono
54 Disable both texture maps and colors.  Ditto.
55 .TP 8
56 .B \-wireframe
57 Only draw outlines.  Outlines of each piece, not only the whole object, are drawn.
58 .TP 8
59 .B \-spin
60 Spin the whole object around X, Y and Z axes.  This is the default.
61 .TP 8
62 .B \-no\-spin
63 Do not spin, stay in the same tilt all the time.
64 .TP 8
65 .B \-wander
66 Move the object around the screen.  This is the default.
67 .TP 8
68 .B \-no\-wander
69 Keep the object centered on the screen.
70 .TP 8
71 .B \-randomize
72 Shuffle the puzzle randomly at startup.  This is the default.
73 .TP 8
74 .B \-no\-randomize
75 Do not shuffle at startup, begin at the shape of cube.
76 .TP 8
77 .B \-spinspeed \fInumber\fP
78 The relative speed of spinning.  Default is 1.0.
79 .TP 8
80 .B \-rotspeed \fInumber\fP
81 The relative speed of the moves.  Default is 3.0.  Setting to \(<= 0.0
82 makes the object stay at one configuration.
83 .TP 8
84 .B \-wanderspeed \fInumber\fP
85 The relative speed of wandering around the screen.  Default is 0.02.
86 .TP 8
87 .B \-wait \fInumber\fP
88 How long to stay at final position after each move.  The meaning of
89 the argument is again relative.  Default is 40.0.
90 .TP 8
91 .B \-cubesize \fInumber\fP
92 Size of the object.  Value of 3.0 fills roughly all the screen.
93 .TP 8
94 .B \-fps
95 Display the current frame rate, CPU load, and polygon count.
96 .SH ENVIRONMENT
97 .PP
98 .TP 8
99 .B DISPLAY
100 to get the default host and display number.
101 .TP 8
102 .B XENVIRONMENT
103 to get the name of a resource file that overrides the global resources
104 stored in the RESOURCE_MANAGER property.
105 .SH SEE ALSO
106 .BR X (1),
107 .BR xscreensaver (1)
108 .SH COPYRIGHT
109 Copyright \(co 2009 by Vasek Potocek.  Permission to use, copy, modify, 
110 distribute, and sell this software and its documentation for any purpose is 
111 hereby granted without fee, provided that the above copyright notice appear 
112 in all copies and that both that copyright notice and this permission notice
113 appear in supporting documentation.  No representations are made about the 
114 suitability of this software for any purpose.  It is provided "as is" without
115 express or implied warranty.
116 .SH AUTHOR
117 Vasek Potocek <vasek.potocek@post.cz>, 04-Feb-09.