http://www.jwz.org/xscreensaver/xscreensaver-5.10.tar.gz
[xscreensaver] / hacks / hypercube.man
1 .TH XScreenSaver 1 "6-dec-92" "X Version 11"
2 .SH NAME
3 hypercube - 2d projection of a 4d object
4 .SH SYNOPSIS
5 .B hypercube
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-color[0-7] \fIcolor\fP] [\-xy \fIfloat\fP] [\-xz \fIfloat\fP] [\-yz \fIfloat\fP] [\-xw \fIfloat\fP] [\-yw \fIfloat\fP] [\-zw \fIfloat\fP] [\-observer-z \fIint\fP] [\-delay \fIusecs\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP]
7 [\-fps]
8 .SH DESCRIPTION
9 The \fIhypercube\fP program displays a wireframe projection of a hypercube
10 which is rotating at user-specified rates around any or all of its four axes.
11 .SH OPTIONS
12 .I hypercube
13 accepts the following options:
14 .TP 8
15 .B \-window
16 Draw on a newly-created window.  This is the default.
17 .TP 8
18 .B \-root
19 Draw on the root window.
20 .TP 8
21 .B \-mono 
22 If on a color display, pretend we're on a monochrome display.
23 .TP 8
24 .B \-install
25 Install a private colormap for the window.
26 .TP 8
27 .B \-visual \fIvisual\fP
28 Specify which visual to use.  Legal values are the name of a visual class,
29 or the id number (decimal or hex) of a specific visual.
30 .TP 8
31 .B \-delay \fImicroseconds\fP
32 How much of a delay should be introduced between steps of the animation.
33 Default 100000, or about 1/10th second.
34 .TP 8
35 .B \-observer-z \fIint\fP
36 How far away the observer is from the center of the cube (the cube is one
37 unit per side.)  Default 5.
38 .TP 8
39 .B \-color0 \fIcolor\fP
40 .TP 8
41 .B \-color1 \fIcolor\fP
42 .TP 8
43 .B \-color2 \fIcolor\fP
44 .TP 8
45 .B \-color3 \fIcolor\fP
46 .TP 8
47 .B \-color4 \fIcolor\fP
48 .TP 8
49 .B \-color5 \fIcolor\fP
50 .TP 8
51 .B \-color6 \fIcolor\fP
52 .TP 8
53 .B \-color7 \fIcolor\fP
54 The colors used to draw the line segments bordering the eight faces of
55 the cube.  Some of the faces have only two of their border-lines drawn in
56 the specified color, and some have all four.
57 .TP 8
58 .B \-xw \fIfloat\fP
59 .TP 8
60 .B \-xy \fIfloat\fP
61 .TP 8
62 .B \-xz \fIfloat\fP
63 .TP 8
64 .B \-yw \fIfloat\fP
65 .TP 8
66 .B \-yz \fIfloat\fP
67 .TP 8
68 .B \-zw \fIfloat\fP
69 The amount that the cube should be rotated around the specified axis at
70 each frame of the animation, expressed in 0.001 radians.  These should be small
71 floating-point values (less than 50 works best.)  Default: xy=3,
72 xz=5, yw=10.
73 .TP 8
74 .B \-fps
75 Display the current frame rate and CPU load.
76 .SH ENVIRONMENT
77 .PP
78 .TP 8
79 .B DISPLAY
80 to get the default host and display number.
81 .TP 8
82 .B XENVIRONMENT
83 to get the name of a resource file that overrides the global resources
84 stored in the RESOURCE_MANAGER property.
85 .SH SEE ALSO
86 .BR X (1),
87 .BR xscreensaver (1)
88 .SH COPYRIGHT
89 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
90 distribute, and sell this software and its documentation for any purpose is 
91 hereby granted without fee, provided that the above copyright notice appear 
92 in all copies and that both that copyright notice and this permission notice
93 appear in supporting documentation.  No representations are made about the 
94 suitability of this software for any purpose.  It is provided "as is" without
95 express or implied warranty.
96 .SH AUTHOR
97 Jamie Zawinski <jwz@jwz.org>, 6-dec-92.