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

   1 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
   2 .SH NAME
   3 pinion - draws a scrolling sequence of interconnected gears
   4 .SH SYNOPSIS
   5 .B pinion
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
   7 [\-visual \fIvisual\fP]
   8 [\-delay \fIusecs\fP]
   9 [\-scroll \fIratio\fP]
  10 [\-spin \fIratio\fP]
  11 [\-size \fIratio\fP]
  12 [\-max-rpm \fIint\fP]
  13 [\-wireframe]
  14 [\-fps]
  15 .SH DESCRIPTION
  16 The \fIpinion\fP program draws an interconnected set of gears moving
  17 across the screen.
  18 .SH OPTIONS
  19 .I pinion
  20 accepts the following options:
  21 .TP 8
  22 .B \-window
  23 Draw on a newly-created window.  This is the default.
  24 .TP 8
  25 .B \-root
  26 Draw on the root window.
  27 .TP 8
  28 .B \-install
  29 Install a private colormap for the window.
  30 .TP 8
  31 .B \-visual \fIvisual\fP\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 \-delay \fIusecs\fP
  36 The delay between frames of the animation, in microseconds: default 15000.
  37 .TP 8
  38 .B \-spin \fIratio\fP
  39 How fast the gears should spin; default 1.0.  2.0 means twice as fast,
  40 0.5 means half as fast.
  41 .TP 8
  42 .B \-scroll \fIratio\fP
  43 How fast the gears should scroll past the screen; default 1.0.
  44 2.0 means twice as fast, 0.5 means half as fast.
  45 .TP 8
  46 .B \-size \fIratio\fP
  47 How big the gears should be, on average; default 1.0.
  48 2.0 means twice as large, 0.5 means half as large.
  49 .TP 8
  50 .B \-max\-rpm \fIinteger\fP
  51 If any gear exceeds the maximum RPM, the current gear train is broken there,
  52 and we start a new train.  Default: 900 RPM.  (At 30 FPS, that's about half
  53 a rotation per frame.)
  54 .TP 8
  55 .B \-wireframe
  56 Render in wireframe instead of solid.
  57 .TP 8
  58 .B \-fps
  59 Display the current frame rate, CPU load, and polygon count.
  60 .SH ENVIRONMENT
  61 .PP
  62 .TP 8
  63 .B DISPLAY
  64 to get the default host and display number.
  65 .TP 8
  66 .B XENVIRONMENT
  67 to get the name of a resource file that overrides the global resources
  68 stored in the RESOURCE_MANAGER property.
  69 .SH SEE ALSO
  70 .BR gears (MANSUFFIX),
  71 .BR xscreensaver (1),
  72 .BR X (1)
  73 .SH COPYRIGHT
  74 Copyright \(co 2004 by Jamie Zawinski.  Permission to use, copy, modify,
  75 distribute, and sell this software and its documentation for any purpose is
  76 hereby granted without fee, provided that the above copyright notice appear
  77 in all copies and that both that copyright notice and this permission notice
  78 appear in supporting documentation.  No representations are made about the
  79 suitability of this software for any purpose.  It is provided "as is" without
  80 express or implied warranty.
  81 .SH AUTHOR
  82 Jamie Zawinski <jwz@jwz.org>, 12-Dec-2004.