git.hungrycats.org Git - xscreensaver/blob - hacks/glx/raverhoop.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 raverhoop - Simulates an LED hula hoop in a dark room.
   4 .SH SYNOPSIS
   5 .B raverhoop
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fInumber\fP]
  11 [\-ncolors \fInumber\fP]
  12 [\-lights \fInumber\fP]
  13 [\-speed \fInumber\fP]
  14 [\-light-speed \fInumber\fP]
  15 [\-sustain \fInumber\fP]
  16 [\-no-wander]
  17 [\-no-spin]
  18 [\-fps]
  19 .SH DESCRIPTION
  20 Simulates an LED hula hoop in a dark room. Oontz oontz oontz.
  21 .SH OPTIONS
  22 .TP 8
  23 .B \-visual \fIvisual\fP
  24 Specify which visual to use.  Legal values are the name of a visual class,
  25 or the id number (decimal or hex) of a specific visual.
  26 .TP 8
  27 .B \-window
  28 Draw on a newly-created window.  This is the default.
  29 .TP 8
  30 .B \-root
  31 Draw on the root window.
  32 .TP 8
  33 .B \-delay \fInumber\fP
  34 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds).
  35 .TP 8
  36 .B \-ncolors \fInumber\fP
  37 The number of colors to use on the hoop.  Default: 12.
  38 .TP 8
  39 .B \-lights \fInumber\fP
  40 The number of LEDs comprising the hoop.  Default: 200.
  41 .TP 8
  42 .B \-speed \fInumber\fP
  43 Speed of the motion of the object.
  44 2.0 means twice as fast, 0.5 means half as fast.
  45 .TP 8
  46 .B \-light-speed \fInumber\fP
  47 Speed at which the lights animate.
  48 2.0 means twice as fast, 0.5 means half as fast.
  49 .TP 8
  50 .B \-sustain \fInumber\fP
  51 Speed at which the after-images / vapor trails fade away.
  52 2.0 means they last twice as long, 0.5 means half as long.
  53 .TP 8
  54 .B \-wander | \-no-wander
  55 Whether the object should wander around the screen.
  56 .TP 8
  57 .B \-spin | \-no-spin
  58 Whether the scene itself should spin.
  59 .TP 8
  60 .B \-fps | \-no-fps
  61 Whether to show a frames-per-second display at the bottom of the screen.
  62 .SH ENVIRONMENT
  63 .PP
  64 .TP 8
  65 .B DISPLAY
  66 to get the default host and display number.
  67 .TP 8
  68 .B XENVIRONMENT
  69 to get the name of a resource file that overrides the global resources
  70 stored in the RESOURCE_MANAGER property.
  71 .SH SEE ALSO
  72 .BR X (1),
  73 .BR xscreensaver (1)
  74 .SH COPYRIGHT
  75 Copyright \(co 2016 by Jamie Zawinski.  Permission to use, copy, modify,
  76 distribute, and sell this software and its documentation for any purpose is
  77 hereby granted without fee, provided that the above copyright notice appear
  78 in all copies and that both that copyright notice and this permission notice
  79 appear in supporting documentation.  No representations are made about the
  80 suitability of this software for any purpose.  It is provided "as is" without
  81 express or implied warranty.
  82 .SH AUTHOR
  83 Jamie Zawinski.