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