git.hungrycats.org Git - xscreensaver/blob - hacks/whirlygig.man

   1 .TH XScreenSaver 1 "31-Mar-01" "X Version 11"
   2 .SH NAME
   3 whirlygig -- zooming chains of sinusoidal spots
   4 .SH SYNOPSIS
   5 .B whirlygig
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-mono]
   7 [\-install] [\-noinstall] [\-visual arg] [\-window-id arg]
   8 [\-xspeed arg] [\-yspeed arg] [\-whirlies arg] [\-nlines arg]
   9 [\-xmode arg] [\-ymode arg] [\-speed arg] [\-trail 1|0]
  10 [\-color_modifier arg] [\-start_time arg] [\-explain 1|0]
  11 [\-wrap 1|0] [\-db] [\-no-db]
  12
  13 .SH DESCRIPTION
  14 The \fIwhirlygig\fP program draws a series of circles on your screen.
  15 They then move about in a cyclic pattern
  16 .SH OPTIONS
  17 .I whirlygig
  18 accepts the following options:
  19 .TP 8
  20 .B \-window
  21 Draw on a newly-created window.  This is the default.
  22 .TP 8
  23 .B \-root
  24 Draw on the root window.
  25 .TP 8
  26 .B \-visual \fIvisual\fP
  27 Specify which visual to use.  Legal values are the name of a visual class,
  28 or the id number (decimal or hex) of a specific visual.
  29 .TP 8
  30 .B \-xspeed \fIspeed\fP
  31 Specify how fast the dots should cycle horizontally.
  32 Try out values from .01 to 4000. Random by default.
  33 .TP 8
  34 .B \-yspeed \fIspeed\fP
  35 Specify how fast the dots should cycle vertically.
  36 Try out values from .01 to 4000. Random by default.
  37 .TP 8
  38 .B \-xamplitude \fIfactor\fP
  39 Specify the horizontal amplitude.
  40 Try out values from .01 to 10. Defaults to 1.0.
  41 .TP 8
  42 .B \-yamplitude \fIfactor\fP
  43 Specify the horizontal amplitude.
  44 Try out values from .01 to 10. Defaults to 1.0.
  45 .TP 8
  46 .B \-whirlies \fIa number\fP
  47 Specify how many whirlies you want (per line). Defaults
  48 to a random number.
  49 .TP 8
  50 .B \-nlines \fInumber of lines\fP
  51 Specify how many lines of whirlies you want. Defaults to a
  52 random number.
  53 .TP 8
  54 .B \-xmode \fImode\fP
  55 .TP 8
  56 .B \-ymode \fImode\fP
  57 Specify which mode to use for calculating the x and y positions of the
  58 whirlies. Can be any of spin, funky, circle, linear, test, fun, innie
  59 or lissajous. Defaults to 'change' mode, which randomly selects a new
  60 mode for x and y every now an then. Unrecognized options default to spin.
  61 .TP 8
  62 .B \-explain
  63 Prints some strings to the window explaining what the initially
  64 selected modes are, before displaying the whirlies. Off by default.
  65 .TP 8
  66 .B \-trail \fI1 or 0\fP
  67 Trail mode fails to erase the whirlies as they move, so they leave a
  68 multicoloured trail behind. Doesn't work if the doubled buffered mode
  69 is using the X server's double buffer extension, and the useDBEclear
  70 resource is true (which it is by default).
  71 .TP 8
  72 .B \-speed \fIint\fP
  73 Specifies how fast to cycle through the internal time. Values 1,2 and
  74 3 look ok, up to 10 is not too bad, but beyond ends up
  75 flickery. Adjust xspeed and yspeed instead.
  76 .TP 8
  77 .B \-start_time \fIint\fP
  78 Where in the internal time cycle to start. Ranges from 1 to 429496729,
  79 Defaults to a random value.
  80 .TP 8
  81 .B \-xoffset \fIfactor\fP
  82 Tell the whirlies to be offset by this factor of a sin.
  83 Defaults to 1.0
  84 .TP 8
  85 .B \-yoffset \fIfactor\fP
  86 Tell the whirlies to be offset by this factor of a cos.
  87 Defaults to 1.0
  88 .TP 8
  89 .B \-offset_period \fIfactor\fP
  90 Change the period of an offset cycle
  91 Defaults to 1
  92 .TP 8
  93 .B \-color_modifier \fIint\fP
  94 How many colors away from the current should the next whirly be?
  95 .TP 8
  96 .B \-wrap \fI1|0\fP
  97 Causes whirlies that fall off the edge of the screen to wrap over to
  98 the other end of the screen. Otherwise they disappear and new ones
  99 to materialize on the other side of the screen. The difference is
 100 subtle, but it is different. Try it. On by default.
 101 .TP 8
 102 .B \-db
 103 .TP 8
 104 .B \-no-db
 105 Use double buffering to reduce flicker. This uses the double buffering
 106 extension if your X server supports it, otherwise it draws to it's own
 107 pixmap buffer and copies that to the window, which works almost as
 108 well. If the resource 'useDBEClear' is true, whirlies are not
 109 individually erased, so the -trail option won't work, and running
 110 multiple instances on the root window will flicker.
 111
 112 .SH ENVIRONMENT
 113 .PP
 114 .TP 8
 115 .B DISPLAY
 116 to get the default host and display number.
 117 .TP 8
 118 .B XENVIRONMENT
 119 to get the name of a resource file that overrides the global resources
 120 stored in the RESOURCE_MANAGER property.
 121 .SH SEE ALSO
 122 .BR X (1),
 123 .BR xscreensaver (1)
 124 .SH COPYRIGHT
 125 Copyright \(co 2001 by Ashton Trey Belew.  Permission to use, copy, modify,
 126 distribute, and sell this software and its documentation for any purpose is
 127 hereby granted without fee, provided that the above copyright notice appear
 128 in all copies and that both that copyright notice and this permission notice
 129 appear in supporting documentation.  No representations are made about the
 130 suitability of this software for any purpose.  It is provided "as is" without
 131 express or implied warranty.
 132 .SH AUTHOR
 133 Ashton Trey Belew <trey@veggie.wesleyan.edu>, 31-Mar-01