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

   1 .TH XScreenSaver 1 "11-feb-04" "X Version 11"
   2 .SH NAME
   3 wormhole - animation of flying through a wormhole
   4 .SH SYNOPSIS
   5 .B wormhole
   6 [\-display \fIhost:display.screen\fP]
   7 [\-window]
   8 [\-visual \fIvisual\fP]
   9 [\-root]
  10 [\-stars \fIn\fP]
  11 [\-delay \fIusecs\fP]
  12 [\-zspeed \fIn\fP]
  13 .SH DESCRIPTION
  14 The \fIwormhole\fP program shows an animation of flying through a tunnel surrounded by streaks of light.
  15 .SH OPTIONS
  16 .I wormhole
  17 accepts the following options:
  18 .TP 8
  19 .B \-window
  20 Draw on a newly-created window.  This is the default.
  21 .TP 8
  22 .B \-root
  23 Draw on the root window.
  24 .TP 8
  25 .B \-mono
  26 Make all the rocks the same color.
  27 .TP 8
  28 .B \-install
  29 Install a private colormap for the window.
  30 .TP 8
  31 .B \-visual \fIvisual\fP
  32 Specify which visual to use.  Legal values are the name of a visual class,
  33 or the id number (decimal or hex) of a specific visual.
  34 .TP 8
  35 .B \-stars \fIinteger\fP
  36 Number of stars to create every animation loop.
  37 .TP 8
  38 .B \-zspeed \fIinteger\fP
  39 Speed light streaks fly by.
  40 .TP 8
  41 .B \-delay \fImicroseconds\fP
  42 Number of microseconds to delay between each frame.  Default 10000, meaning
  43 about 1/100th second.  Compare and contrast with \fI\-zspeed\fP, above.
  44 .SH ENVIRONMENT
  45 .PP
  46 .TP 8
  47 .B DISPLAY
  48 to get the default host and display number.
  49 .TP 8
  50 .B XENVIRONMENT
  51 to get the name of a resource file that overrides the global resources
  52 stored in the RESOURCE_MANAGER property.
  53 .SH SEE ALSO
  54 .BR X (1),
  55 .BR xscreensaver (1)
  56 .SH COPYRIGHT
  57 Copyright \(co 2004 by Jon Rafkind.  Permission to use, copy, modify,
  58 distribute, and sell this software and its documentation for any purpose is
  59 hereby granted without fee, provided that the above copyright notice appear
  60 in all copies and that both that copyright notice and this permission notice
  61 appear in supporting documentation.  No representations are made about the
  62 suitability of this software for any purpose.  It is provided "as is" without
  63 express or implied warranty.
  64 .SH AUTHOR
  65 Jon Rafkind <jon@rafkind.com>