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 [\-fps]
  14 .SH DESCRIPTION
  15 The \fIwormhole\fP program shows an animation of flying through a tunnel surrounded by streaks of light.
  16 .SH OPTIONS
  17 .I wormhole
  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 \-mono
  27 Make all the rocks the same color.
  28 .TP 8
  29 .B \-install
  30 Install a private colormap for the window.
  31 .TP 8
  32 .B \-visual \fIvisual\fP
  33 Specify which visual to use.  Legal values are the name of a visual class,
  34 or the id number (decimal or hex) of a specific visual.
  35 .TP 8
  36 .B \-stars \fIinteger\fP
  37 Number of stars to create every animation loop.
  38 .TP 8
  39 .B \-zspeed \fIinteger\fP
  40 Speed light streaks fly by.
  41 .TP 8
  42 .B \-delay \fImicroseconds\fP
  43 Number of microseconds to delay between each frame.  Default 10000, meaning
  44 about 1/100th second.  Compare and contrast with \fI\-zspeed\fP, above.
  45 .TP 8
  46 .B \-fps
  47 Display the current frame rate and CPU load.
  48 .SH ENVIRONMENT
  49 .PP
  50 .TP 8
  51 .B DISPLAY
  52 to get the default host and display number.
  53 .TP 8
  54 .B XENVIRONMENT
  55 to get the name of a resource file that overrides the global resources
  56 stored in the RESOURCE_MANAGER property.
  57 .SH SEE ALSO
  58 .BR X (1),
  59 .BR xscreensaver (1)
  60 .SH COPYRIGHT
  61 Copyright \(co 2004 by Jon Rafkind.  Permission to use, copy, modify,
  62 distribute, and sell this software and its documentation for any purpose is
  63 hereby granted without fee, provided that the above copyright notice appear
  64 in all copies and that both that copyright notice and this permission notice
  65 appear in supporting documentation.  No representations are made about the
  66 suitability of this software for any purpose.  It is provided "as is" without
  67 express or implied warranty.
  68 .SH AUTHOR
  69 Jon Rafkind <jon@rafkind.com>