X-Git-Url: http://git.hungrycats.org/cgi-bin/gitweb.cgi?p=xscreensaver;a=blobdiff_plain;f=hacks%2Fglx%2Fjuggler3d.man;h=48d47160fc561da99d13af7bdf3c6057c1c03647;hp=6ae9044a89ca346889d2aef51dffe90c03f018c0;hb=f0261d8acab611f3433160e4f07367b870439739;hpb=7b34ef992563d7bcbb64cc5597dc45fa24470b05 diff --git a/hacks/glx/juggler3d.man b/hacks/glx/juggler3d.man index 6ae9044a..48d47160 100644 --- a/hacks/glx/juggler3d.man +++ b/hacks/glx/juggler3d.man @@ -1,69 +1,161 @@ +'\" t +.\" ** The above line should force tbl to be used as a preprocessor ** .TH XScreenSaver 1 "" "X Version 11" .SH NAME -Juggler3D - a 3D juggling simulation. +juggler3d - juggling man screen saver. .SH SYNOPSIS .B juggler3d -[\-display \fIhost:display.screen\fP] -[\-visual \fIvisual\fP] -[\-window] -[\-root] -[\-delay \fInumber\fP] -[\-speed \fInumber\fP] -[\-trans \fInumber\fP] -[\-spin \fInumber\fP] -[\-maxobjs \fInumber\fP] -[\-minobjs \fInumber\fP] -[\-maxhinc \fInumber\fP] -[\-minhinc \fInumber\fP] -[\-wireframe] +[\-display host:display.screen ] +[\-root ] +[\-window ] +[\-mono ] +[\-install | \-noinstall ] +[\-visual visual ] +[\-window\-id id ] +[\-pattern pattern ] +[\-tail number ] +[\-real | \-no\-real ] +[\-describe | \-no\-describe ] +[\-balls | \-no\-balls ] +[\-clubs | \-no\-clubs ] +[\-torches | \-no\-torches ] +[\-knives | \-no\-knives ] +[\-rings | \-no\-rings ] +[\-bballs | \-no\-bballs ] +[\-count count ] +[\-cycles cycles ] +[\-delay delay ] +[\-ncolors ncolors ] [\-fps] .SH DESCRIPTION -Displays a 3D simulation of a juggler performing with balls, clubs and rings. -Juggling patterns are either created randomly using siteswaps or from a -small library of predefined patterns. \fBjuggler3d\fP is partially based on the -Win32 screensaver Juggle Saver (www.jugglesaver.co.uk) by the same author. +Draws a stick-man juggling various collections of objects. .SH OPTIONS +.I juggler3d +accepts the following options: .TP 8 -.B \-visual \fIvisual\fP +.B \-display host:display.screen +X11 display to use. Overrides +.B DISPLAY +environment variable. +.TP 8 +.B \-root +Draw on the root window. +.TP 8 +.B \-window +Draw on a newly-created X window. This is the default. +.TP 8 +.B \-mono +Draw in monochrome. +.TP 8 +.B \-install | \-noinstall +Turn on/off installing colormap. +.TP 8 +.B \-visual visual Specify which visual to use. Legal values are the name of a visual class, or the id number (decimal or hex) of a specific visual. .TP 8 -.B \-window -Draw on a newly-created window. This is the default. +.B \-window\-id id +Draw on an already existing X window. .TP 8 -.B \-root -Draw on the root window. +.B \-pattern\ \(dq pattern \(dq +Specify juggling pattern in annotated +.B site-swap +notation. In +.B site-swap +notation, the "height" of each throw is given. E.g., "3" is the height +needed to juggle a 3\-Cascade. Note that these sequences need to be +chosen carefully, to avoid collisions. + +Annotations indicate relative hand movements or tricks: +.TS +cb l. +\&\- Inside throw (default) ++ Outside throw +\&= Cross Throw +& Cross Catch +x Cross Throw and Catch +\&_ Bounce +.TE +.TP 8 +.B \-pattern\ \(dq[ pattern ]\(dq +Specify juggling pattern in annotated +.B Adam +notation. Adam notation is a little harder to visualize. Each +integer +.B n +represents a cyclic permutation of (0...n). The equivalent +.B site-swap +value is determined by calculating how many of the permutations it +takes to get back to the identity. The largest number used is the +same as the number of objects in the pattern. The advantage of Adam +notation is that these sequences do not need to be chosen carefully, +since all possible sequences are juggle-able. Annotations are the same +as in +.B site-swap +notation. + +For example, both of these describe a 3\-Shower: +.IP +.B \-pattern\ "+5 1" +.IP +.B \-pattern\ "[+3 1]" + +For further examples, see the +.B portfolio +list in the source code. +.TP 8 +.B \-tail number +Minimum Trail Length. 0 \- 100. Default: 1. Objects may override +this, for example flaming torches always leave a trail. +.TP 8 +.BR \-real | \-no\-real +Turn on/off real-time juggling. +.B Deprecated. +There should be no need to turn off real-time juggling, even on slow +systems. Adjust speed using +.B \-count +above. +.TP 8 +.BR \-describe | \-no\-describe +Turn on/off pattern descriptions. +.TP 8 +.BR \-balls | \-no\-balls +Turn on/off Balls. +.TP 8 +.BR \-clubs | \-no\-clubs +Turn on/off Clubs. .TP 8 -.B \-delay \fInumber\fP -Per-frame delay, in microseconds. Default: 20000 (0.02 seconds.). +.BR \-torches | \-no\-torches +Turn on/off Flaming Torches. .TP 8 -.B \-speed \fInumber\fP -Speed of objects being juggled in beats per seconds. Default: 2.2. +.BR \-knives | \-no\-knives +Turn on/off Knives. .TP 8 -.B \-trans \fInumber\fP -Speed of horizontal juggler movement (translational) across the screen in -degrees/seconds. Default: 0.1 +.BR \-rings | \-no\-rings +Turn on/off Rings. .TP 8 -.B \-spin \fInumber\fP -Speed of juggler rotation in degrees/seconds. Default: 20 +.BR \-bballs | \-no\-bballs +Turn on/off Bowling Balls. .TP 8 -.B \-maxobj \fInumber\fP -Maximum number of objects used in a random juggling pattern. 3 - 36. +.B \-count number +Speed. 50 \- 1000. Default: 200. This determines the expected time +interval between a throw and the next catch, in milliseconds. .TP 8 -.B \-minobj \fInumber\fP -Minimum number of objects used in a random juggling pattern. 3 - \fBmaxobj\fP. +.B \-cycles number +Performance Length. 50 \- 1000. Default: 1000. Setting this smaller +will force the juggler to switch patterns (and objects) more often. .TP 8 -.B \-minhinc \fInumber\fP | -maxhinc \fInumber\fP -Used to determine maximum throw weight in random siteswap. Options refer to -minimum height increment and maximum height increment. Maximum weight chosen -will lie between \fBmaxobj\fP + \fBminhinc\fP and \fBmaxobj\fP + \fBmaxhinc\fP. -Defaults: \fBminhinc\fP=1 and \fBmaxhinc\fP=6. +.B \-delay delay +Additional delay between frames, in microseconds. Default: 10000. +.B Deprecated. +Adjust speed using +.BR \-count . .TP 8 -.B \-wireframe | \-no-wireframe -Render in wireframe instead of solid. +.B \-ncolors ncolors +Maximum number of colors to use. Default: 32. .TP 8 .B \-fps -Display the current frame rate, CPU load, and polygon count. +Display the current frame rate and CPU load. .SH ENVIRONMENT .PP .TP 8 @@ -77,12 +169,15 @@ stored in the RESOURCE_MANAGER property. .BR X (1), .BR xscreensaver (1) .SH COPYRIGHT -Copyright \(co 2005 by Brian Apps. Permission to use, copy, modify, -distribute, and sell this software and its documentation for any purpose is -hereby granted without fee, provided that the above copyright notice appear -in all copies and that both that copyright notice and this permission notice -appear in supporting documentation. No representations are made about the -suitability of this software for any purpose. It is provided "as is" without -express or implied warranty. +Copyright \(co 1996,2000,2002,2004 by Tim Auckland. Permission to +use, copy, modify, distribute, and sell this software and its +documentation for any purpose is hereby granted without fee, provided +that the above copyright notice appear in all copies and that both +that copyright notice and this permission notice appear in supporting +documentation. No representations are made about the suitability of +this software for any purpose. It is provided "as is" without express +or implied warranty. .SH AUTHOR -Brian Apps +Tim Auckland. + +Converted to OpenGL by Jamie Zawinski, 2009.