began for maemo
[xscreensaver] / 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 .SH DESCRIPTION
22 The \fIhyperball\fP program displays a wireframe projection of a hyperball
23 which is rotating at user-specified rates around any or all of its four axes.
24 .SH OPTIONS
25 .I hyperball
26 accepts the following options:
27 .TP 8
28 .B \-window
29 Draw on a newly-created window.  This is the default.
30 .TP 8
31 .B \-root
32 Draw on the root window.
33 .TP 8
34 .B \-mono 
35 If on a color display, pretend we're on a monochrome display.
36 .TP 8
37 .B \-install
38 Install a private colormap for the window.
39 .TP 8
40 .B \-visual \fIvisual\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 much of a delay should be introduced between steps of the animation.
46 Default 20000, or about 0.02 seconds.
47 .TP 8
48 .B \-xw \fIfloat\fP
49 .TP 8
50 .B \-xy \fIfloat\fP
51 .TP 8
52 .B \-xz \fIfloat\fP
53 .TP 8
54 .B \-yw \fIfloat\fP
55 .TP 8
56 .B \-yz \fIfloat\fP
57 .TP 8
58 .B \-zw \fIfloat\fP
59 The amount that the ball should be rotated around the specified axis at
60 each frame of the animation, expressed in 0.001 radians.  These should be small
61 floating-point values (less than 50 works best.)  Default: xy=3,
62 xz=5, yw=10.
63 .SH ENVIRONMENT
64 .PP
65 .TP 8
66 .B DISPLAY
67 to get the default host and display number.
68 .TP 8
69 .B XENVIRONMENT
70 to get the name of a resource file that overrides the global resources
71 stored in the RESOURCE_MANAGER property.
72 .SH SEE ALSO
73 .BR X (1),
74 .BR xscreensaver (1)
75 .SH COPYRIGHT
76 Copyright \(co 2000 by Joe Keane.  Permission to use, copy, modify, 
77 distribute, and sell this software and its documentation for any purpose is 
78 hereby granted without fee, provided that the above copyright notice appear 
79 in all copies and that both that copyright notice and this permission notice
80 appear in supporting documentation.  No representations are made about the 
81 suitability of this software for any purpose.  It is provided "as is" without
82 express or implied warranty.
83 .SH AUTHOR
84 Joe Keane <jgk@jgk.org>