ftp://ftp.ntnu.no/old/pub/X11/R5contrib/xscreensaver-1.17.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] [\-window] [\-root] [\-mono] [\-delay \fIusecs\fP]
7 .SH DESCRIPTION
8 The \fIhypercube\fP program displays a wireframe projection of a hypercube
9 which is rotating at user-specified rates around any or all of its four axes.
10 .SH OPTIONS
11 .I hypercube
12 accepts the following options:
13 .TP 8
14 .B \-window
15 Draw on a newly-created window.  This is the default.
16 .TP 8
17 .B \-root
18 Draw on the root window.
19 .TP 8
20 .B \-mono 
21 If on a color display, pretend we're on a monochrome display.
22 .TP 8
23 .B \-delay microseconds
24 How much of a delay should be introduced between steps of the animation.
25 Default 100000, or about 1/10th second.
26 .TP 8
27 .B \-observer-z int
28 How far away the observer is from the center of the cube (the cube is one
29 unit per side.)  Default 5.
30 .TP 8
31 .B \-color0 color
32 .TP 8
33 .B \-color1 color
34 .TP 8
35 .B \-color2 color
36 .TP 8
37 .B \-color3 color
38 .TP 8
39 .B \-color4 color
40 .TP 8
41 .B \-color5 color
42 .TP 8
43 .B \-color6 color
44 .TP 8
45 .B \-color7 color
46 The colors used to draw the line segments bordering the eight faces of
47 the cube.  Some of the faces have only two of their border-lines drawn in
48 the specified color, and some have all four.
49 .TP 8
50 .B \-xw float
51 .TP 8
52 .B \-xy float
53 .TP 8
54 .B \-xz float
55 .TP 8
56 .B \-yw float
57 .TP 8
58 .B \-yz float
59 .TP 8
60 .B \-zw float
61 The amount that the cube should be rotated around the specified axis at
62 each frame of the animation, expressed in radians.  These should be small
63 floating-point values (less than 0.05 works best.)  Default: xy=0.01,
64 xz=0.005, yw=0.01.
65 .SH ENVIRONMENT
66 .PP
67 .TP 8
68 .B DISPLAY
69 to get the default host and display number.
70 .TP 8
71 .B XENVIRONMENT
72 to get the name of a resource file that overrides the global resources
73 stored in the RESOURCE_MANAGER property.
74 .SH SEE ALSO
75 .BR X (1),
76 .BR xscreensaver (1)
77 .SH COPYRIGHT
78 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
79 distribute, and sell this software and its documentation for any purpose is 
80 hereby granted without fee, provided that the above copyright notice appear 
81 in all copies and that both that copyright notice and this permission notice
82 appear in supporting documentation.  No representations are made about the 
83 suitability of this software for any purpose.  It is provided "as is" without
84 express or implied warranty.
85 .SH AUTHOR
86 Jamie Zawinski <jwz@lucid.com>, 6-dec-92.