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 .SH DESCRIPTION
  14 The \fIpinion\fP program draws an interconnected set of gears moving
  15 across the screen.
  16 .SH OPTIONS
  17 .I pinion
  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 \-install
  27 Install a private colormap for the window.
  28 .TP 8
  29 .B \-visual \fIvisual\fP\fP
  30 Specify which visual to use.  Legal values are the name of a visual class,
  31 or the id number (decimal or hex) of a specific visual.
  32 .TP 8
  33 .B \-delay \fIusecs\fP
  34 The delay between frames of the animation, in microseconds: default 15000.
  35 .TP 8
  36 .B \-spin \fIratio\fP
  37 How fast the gears should spin; default 1.0.  2.0 means twice as fast,
  38 0.5 means half as fast.
  39 .TP 8
  40 .B \-scroll \fIratio\fP
  41 How fast the gears should scroll past the screen; default 1.0.
  42 2.0 means twice as fast, 0.5 means half as fast.
  43 .TP 8
  44 .B \-size \fIratio\fP
  45 How big the gears should be, on average; default 1.0.
  46 2.0 means twice as large, 0.5 means half as large.
  47 .TP 8
  48 .B \-max\-rpm \fIinteger\fP
  49 If any gear exceeds the maximum RPM, the current gear train is broken there,
  50 and we start a new train.  Default: 900 RPM.  (At 30 FPS, that's about half
  51 a rotation per frame.)
  52 .TP 8
  53 .B \-fps
  54 Display a running tally of how many frames per second are being rendered.
  55 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  56 your GL performance.
  57 .SH ENVIRONMENT
  58 .PP
  59 .TP 8
  60 .B DISPLAY
  61 to get the default host and display number.
  62 .TP 8
  63 .B XENVIRONMENT
  64 to get the name of a resource file that overrides the global resources
  65 stored in the RESOURCE_MANAGER property.
  66 .SH SEE ALSO
  67 .BR gears (1),
  68 .BR xscreensaver (1),
  69 .BR X (1)
  70 .SH COPYRIGHT
  71 Copyright \(co 2004 by Jamie Zawinski.  Permission to use, copy, modify,
  72 distribute, and sell this software and its documentation for any purpose is
  73 hereby granted without fee, provided that the above copyright notice appear
  74 in all copies and that both that copyright notice and this permission notice
  75 appear in supporting documentation.  No representations are made about the
  76 suitability of this software for any purpose.  It is provided "as is" without
  77 express or implied warranty.
  78 .SH AUTHOR
  79 Jamie Zawinski <jwz@jwz.org>, 12-Dec-2004.