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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 gears - draw interlocking gears, for xscreensaver.
   4 .SH SYNOPSIS
   5 .B gears
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
   7 [\-visual \fIvisual\fP]
   8 [\-delay \fIusecs\fP]
   9 [\-speed \fIfloat\fP]
  10 [\-no\-spin]
  11 [\-no\-wander]
  12 [-count \fIinteger\fP]
  13 [-wireframe]
  14 [-fps]
  15 .SH DESCRIPTION
  16 This draws a set of rotating gears.
  17 .SH OPTIONS
  18 .I gears
  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 \-install
  28 Install a private colormap for the window.
  29 .TP 8
  30 .B \-visual \fIvisual\fP
  31 Specify which visual to use.  Legal values are the name of a visual class,
  32 or the id number (decimal or hex) of a specific visual.
  33 .TP 8
  34 .B \-delay \fIusecs\fP
  35 The delay between frames of the animation, in microseconds.
  36 Default: 30000 (0.03 seconds.)
  37 .TP 8
  38 .B \-speed \fIfloat\fP
  39 Larger numbers mean run faster.  Default: 1.0.
  40 .TP 8
  41 .B \-no\-spin
  42 Don't rotate the object.
  43 .TP 8
  44 .B \-no\-wander
  45 Don't wander the object around the screen.
  46 .TP 8
  47 .B \-count \fIinteger\fP
  48 How many gears to draw.  Default: 0 for random.
  49 .TP 8
  50 .B \-wireframe
  51 Render in wireframe instead of solid.
  52 .TP 8
  53 .B \-fps
  54 Display the current frame rate, CPU load, and polygon count.
  55 .SH ENVIRONMENT
  56 .PP
  57 .TP 8
  58 .B DISPLAY
  59 to get the default host and display number.
  60 .TP 8
  61 .B XENVIRONMENT
  62 to get the name of a resource file that overrides the global resources
  63 stored in the RESOURCE_MANAGER property.
  64 .SH SEE ALSO
  65 .BR X (1),
  66 .BR xscreensaver (1)
  67 .SH COPYRIGHT
  68 Copyright \(co 2007 by Jamie Zawinski.  Permission to use, copy, modify,
  69 distribute, and sell this software and its documentation for any purpose is
  70 hereby granted without fee, provided that the above copyright notice appear
  71 in all copies and that both that copyright notice and this permission notice
  72 appear in supporting documentation.  No representations are made about the
  73 suitability of this software for any purpose.  It is provided "as is" without
  74 express or implied warranty.
  75 .SH AUTHOR
  76 Jamie Zawinski.
  77
  78 An earlier version of this program by Brian Paul was written in 1997;
  79 this version was rewritten from scratch by jwz in 2007.