6ae9044a89ca346889d2aef51dffe90c03f018c0
[xscreensaver] / hacks / glx / juggler3d.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 Juggler3D - a 3D juggling simulation.
4 .SH SYNOPSIS
5 .B juggler3d
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-speed \fInumber\fP]
12 [\-trans \fInumber\fP]
13 [\-spin \fInumber\fP]
14 [\-maxobjs \fInumber\fP]
15 [\-minobjs \fInumber\fP]
16 [\-maxhinc \fInumber\fP]
17 [\-minhinc \fInumber\fP]
18 [\-wireframe]
19 [\-fps]
20 .SH DESCRIPTION
21 Displays a 3D simulation of a juggler performing with balls, clubs and rings. 
22 Juggling patterns are either created randomly using siteswaps or from a 
23 small library of predefined patterns.  \fBjuggler3d\fP is partially based on the
24 Win32 screensaver Juggle Saver (www.jugglesaver.co.uk) by the same author.
25 .SH OPTIONS
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 \-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 \-delay \fInumber\fP
38 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
39 .TP 8
40 .B \-speed \fInumber\fP
41 Speed of objects being juggled in beats per seconds.  Default: 2.2.
42 .TP 8
43 .B \-trans \fInumber\fP
44 Speed of horizontal juggler movement (translational) across the screen in
45 degrees/seconds.  Default: 0.1
46 .TP 8
47 .B \-spin \fInumber\fP
48 Speed of juggler rotation in degrees/seconds.  Default: 20
49 .TP 8
50 .B \-maxobj \fInumber\fP
51 Maximum number of objects used in a random juggling pattern. 3 - 36.
52 .TP 8
53 .B \-minobj \fInumber\fP
54 Minimum number of objects used in a random juggling pattern. 3 - \fBmaxobj\fP.
55 .TP 8
56 .B \-minhinc \fInumber\fP | -maxhinc \fInumber\fP
57 Used to determine maximum throw weight in random siteswap.  Options refer to
58 minimum height increment and maximum height increment.  Maximum weight chosen
59 will lie between \fBmaxobj\fP + \fBminhinc\fP and \fBmaxobj\fP + \fBmaxhinc\fP.
60 Defaults: \fBminhinc\fP=1 and \fBmaxhinc\fP=6.
61 .TP 8
62 .B \-wireframe | \-no-wireframe
63 Render in wireframe instead of solid.
64 .TP 8
65 .B \-fps
66 Display the current frame rate, CPU load, and polygon count.
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 2005 by Brian Apps.  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 Brian Apps <brian@jugglesaver.co.uk>