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