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