http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / juggle.man
1 '\" t
2 .\" ** The above line should force tbl to be used as a preprocessor **
3 .TH XScreenSaver 1 "" "X Version 11"
4 .SH NAME
5 juggle - juggling man screen saver.
6 .SH SYNOPSIS
7 .B juggle
8 [\-display host:display.screen ]
9 [\-root ]
10 [\-window ]
11 [\-mono ]
12 [\-install | \-noinstall ]
13 [\-visual visual ]
14 [\-window\-id id ]
15 [\-pattern pattern ]
16 [\-tail number ]
17 [\-real | \-no\-real ]
18 [\-describe | \-no\-describe ]
19 [\-balls | \-no\-balls ]
20 [\-clubs | \-no\-clubs ]
21 [\-torches | \-no\-torches ]
22 [\-knives | \-no\-knives ]
23 [\-rings | \-no\-rings ]
24 [\-bballs | \-no\-bballs ]
25 [\-count count ]
26 [\-cycles cycles ]
27 [\-delay delay ]
28 [\-ncolors ncolors ]
29 [\-fps]
30 .SH DESCRIPTION
31 Draws a stick-man juggling various collections of objects.
32 .SH OPTIONS
33 .I juggle
34 accepts the following options:
35 .TP 8
36 .B \-display host:display.screen
37 X11 display to use.  Overrides
38 .B DISPLAY
39 environment variable.
40 .TP 8
41 .B \-root
42 Draw on the root window.
43 .TP 8
44 .B \-window
45 Draw on a newly-created X window.  This is the default.
46 .TP 8
47 .B \-mono
48 Draw in monochrome.
49 .TP 8
50 .B \-install | \-noinstall
51 Turn on/off installing colormap.
52 .TP 8
53 .B \-visual visual
54 Specify which visual to use.  Legal values are the name of a visual class,
55 or the id number (decimal or hex) of a specific visual.
56 .TP 8
57 .B \-window\-id id
58 Draw on an already existing X window.
59 .TP 8
60 .B \-pattern\ \(dq pattern \(dq
61 Specify juggling pattern in annotated
62 .B site-swap
63 notation.  In 
64 .B site-swap
65 notation, the "height" of each throw is given.  E.g., "3" is the height
66 needed to juggle a 3\-Cascade.  Note that these sequences need to be
67 chosen carefully, to avoid collisions.
68
69 Annotations indicate relative hand movements or tricks:
70 .TS
71 cb l.
72 \&\-    Inside throw (default)
73 +       Outside throw
74 \&=     Cross Throw
75 &       Cross Catch
76 x       Cross Throw and Catch
77 \&_     Bounce
78 .TE
79 .TP 8
80 .B \-pattern\ \(dq[ pattern ]\(dq
81 Specify juggling pattern in annotated
82 .B Adam
83 notation.  Adam notation is a little harder to visualize.  Each
84 integer
85 .B n
86 represents a cyclic permutation of (0...n).  The equivalent
87 .B site-swap
88 value is determined by calculating how many of the permutations it
89 takes to get back to the identity.  The largest number used is the
90 same as the number of objects in the pattern.  The advantage of Adam
91 notation is that these sequences do not need to be chosen carefully,
92 since all possible sequences are juggle-able.  Annotations are the same
93 as in
94 .B site-swap
95 notation.
96
97 For example, both of these describe a 3\-Shower:
98 .IP
99 .B \-pattern\ "+5 1"
100 .IP
101 .B \-pattern\ "[+3 1]"
102
103 For further examples, see the
104 .B portfolio
105 list in the source code.
106 .TP 8
107 .B \-tail number
108 Minimum Trail Length.  0 \- 100.  Default: 1.  Objects may override
109 this, for example flaming torches always leave a trail.
110 .TP 8
111 .BR \-real | \-no\-real
112 Turn on/off real-time juggling.
113 .B Deprecated.
114 There should be no need to turn off real-time juggling, even on slow
115 systems.  Adjust speed using
116 .B \-count
117 above.
118 .TP 8
119 .BR \-describe | \-no\-describe
120 Turn on/off pattern descriptions.
121 .TP 8 
122 .BR \-balls | \-no\-balls
123 Turn on/off Balls.
124 .TP 8
125 .BR \-clubs | \-no\-clubs
126 Turn on/off Clubs.
127 .TP 8
128 .BR \-torches | \-no\-torches
129 Turn on/off Flaming Torches.
130 .TP 8
131 .BR \-knives | \-no\-knives
132 Turn on/off Knives.
133 .TP 8
134 .BR \-rings | \-no\-rings
135 Turn on/off Rings.
136 .TP 8
137 .BR \-bballs | \-no\-bballs
138 Turn on/off Bowling Balls.
139 .TP 8
140 .B \-count number
141 Speed. 50 \- 1000.  Default: 200.  This determines the expected time
142 interval between a throw and the next catch, in milliseconds.
143 .TP 8
144 .B \-cycles number
145 Performance Length. 50 \- 1000.  Default: 1000.  Setting this smaller
146 will force the juggler to switch patterns (and objects) more often.
147 .TP 8
148 .B \-delay delay
149 Additional delay between frames, in microseconds.  Default: 10000.
150 .B Deprecated.
151 Adjust speed using
152 .BR \-count .
153 .TP 8
154 .B \-ncolors ncolors
155 Maximum number of colors to use.  Default: 32.
156 .TP 8
157 .B \-fps
158 Display the current frame rate and CPU load.
159 .SH ENVIRONMENT
160 .PP
161 .TP 8
162 .B DISPLAY
163 to get the default host and display number.
164 .TP 8
165 .B XENVIRONMENT
166 to get the name of a resource file that overrides the global resources
167 stored in the RESOURCE_MANAGER property.
168 .SH SEE ALSO
169 .BR X (1),
170 .BR xscreensaver (1)
171 .SH COPYRIGHT
172 Copyright \(co 1996,2000,2002,2004 by Tim Auckland.  Permission to
173 use, copy, modify, distribute, and sell this software and its
174 documentation for any purpose is hereby granted without fee, provided
175 that the above copyright notice appear in all copies and that both
176 that copyright notice and this permission notice appear in supporting
177 documentation.  No representations are made about the suitability of
178 this software for any purpose.  It is provided "as is" without express
179 or implied warranty.
180 .SH AUTHOR
181 Tim Auckland.