X-Git-Url: http://git.hungrycats.org/cgi-bin/gitweb.cgi?p=xscreensaver;a=blobdiff_plain;f=hacks%2Fwhirlygig.man;h=92b56cf2d08eab8e68c26e2a4ce03b731275bc72;hp=c42edc1423075ff4dbe92e4776ce5b6a71aaba78;hb=4cecfc89e5e889c7232693897c06168fb378bd5c;hpb=c28aecf9fc41e3a03494bacf7279745425e2fa18

diff --git a/hacks/whirlygig.man b/hacks/whirlygig.man
index c42edc14..92b56cf2 100644
--- a/hacks/whirlygig.man
+++ b/hacks/whirlygig.man
@@ -3,7 +3,13 @@
 whirlygig -- zooming chains of sinusoidal spots
 .SH SYNOPSIS
 .B whirlygig
-[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-background] [\-foreground] [\-xspeed] [\-yspeed] [\-whirlies] [\-nlines]
+[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-mono]
+[\-install] [\-noinstall] [\-visual arg] [\-window-id arg]   
+[\-xspeed arg] [\-yspeed arg] [\-whirlies arg] [\-nlines arg] 
+[\-xmode arg] [\-ymode arg] [\-speed arg] [\-trail 1|0]
+[\-color_modifier arg] [\-start_time arg] [\-explain 1|0]
+[\-wrap 1|0] [\-db] [\-no-db] 
+
 .SH DESCRIPTION
 The \flwhirlygig\fP program draws a series of circles on your screen.
 They then move about in a cyclic pattern
@@ -23,17 +29,86 @@ or the id number (decimal or hex) of a specific visual.
 .TP 8
 .B \-xspeed \flspeed\fP
 Specify how fast the dots should cycle horizontally.
-Try out values from .01 to 4000
+Try out values from .01 to 4000. Random by default.
 .TP 8
 .B \-yspeed \flspeed\fP
 Specify how fast the dots should cycle vertically.
-Try out values from .01 to 4000
+Try out values from .01 to 4000. Random by default.
+.TP 8
+.B \-xamplitude \flfactor\fP
+Specify the horizonatal amplitude.
+Try out values from .01 to 10. Defaults to 1.0.
+.TP 8
+.B \-yamplitude \flfactor\fP
+Specify the horizonatal amplitude.
+Try out values from .01 to 10. Defaults to 1.0.
 .TP 8
 .B \-whirlies \fla number\fP
-Specify how many whilrlies you want
+Specify how many whirlies you want (per line). Defaults
+to a random number.
 .TP 8
 .B \-nlines \flnumber of lines\fP
-Specify how many lines of whirlies you want
+Specify how many lines of whirlies you want. Defaults to a 
+random number.
+.TP 8
+.B \-xmode \flmode\fP
+.TP 8 
+.B \-ymode \flmode\fP
+Specify which mode to use for calculating the x and y positions of the
+whirlies. Can be any of spin, funky, circle, linear, test, fun, innie
+or lissajous. Defaults to 'change' mode, which randomly selects a new
+mode for x and y every now an then. Unrecognized options default to spin.
+.TP 8
+.B \-explain
+Prints some strings to the window explaining what the initially
+selected modes are, before displaying the whirlies. Off by default.
+.TP 8
+.B \-trail \fl1 or 0\fP
+Trail mode fails to erase the whirlies as they move, so they leave a
+multicoloured trail behind. Doesn't work if the doubled buffered mode
+is using the X server's double buffer extension, and the useDBEclear 
+resource is true (which it is by default).
+.TP 8
+.B \-speed \flint\fP
+Specifies how fast to cycle through the internal time. Values 1,2 and
+3 look ok, up to 10 is not too bad, but beyond ends up
+flickery. Adjust xspeed and yspeed instead.
+.TP 8
+.B \-start_time \flint\fP
+Where in the internal time cycle to start. Ranges from 1 to 429496729,
+Defaults to a random value.
+.TP 8
+.B \-xoffset \flfactor\fP
+Tell the whirlies to be offset by this factor of a sin.
+Defaults to 1.0
+.TP 8
+.B \-yoffset \flfactor\fP
+Tell the whirlies to be offset by this factor of a cos.
+Defaults to 1.0
+.TP 8
+.B \-offset_period \flfactor\fP
+Change the period of an offset cycle
+Defaults to 1
+.TP 8
+.B \-color_modifier \flint\fP
+How many colors away from the current should the next whirly be?
+.TP 8
+.B \-wrap \fl1|0\fP
+Causes whirlies that fall off the edge of the screen to wrap over to
+the other end of the screen. Otherwise they disappear and new ones
+to materialize on the other side of the screen. The difference is
+subtle, but it is different. Try it. On by default.
+.TP 8
+.B \-db
+.TP 8
+.B \-no-db
+Use double buffering to reduce flicker. This uses the double buffering
+extension if your X server supports it, otherwise it draws to it's own
+pixmap buffer and copies that to the window, which works almost as
+well. If the resource 'useDBEClear' is true, whirlies are not 
+individually erased, so the -trail option won't work, and running
+multiple instances on the root window will flicker. 
+
 .SH ENVIRONMENT
 .PP
 .TP 8