http://www.tienza.es/crux/src/www.jwz.org/xscreensaver/xscreensaver-5.04.tar.gz
[xscreensaver] / hacks / glx / gears.man
index 999cf11fbe375df6fcabaff0fd8ccb7306c40613..8f5b4d94e9addae552ab3b3fb3d5f895067ff6e5 100644 (file)
@@ -3,23 +3,20 @@
 gears - draw interlocking gears, for xscreensaver.
 .SH SYNOPSIS
 .B gears
-[\-display \fIhost:display.screen\fP]
+[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
 [\-visual \fIvisual\fP]
-[\-window]
-[\-root]
-[-delay \fInumber\fP]
-[-cycles \fInumber\fP]
-[-planetary]
+[\-delay \fIusecs\fP] 
+[\-speed \fIfloat\fP] 
+[\-no\-spin]
+[\-no\-wander]
+[-count \fIinteger\fP]
 [-wireframe]
 [-fps]
 .SH DESCRIPTION
-This draws sets of turning, interlocking gears, rotating in three
-dimensions.
+This draws a set of rotating gears.
 .SH OPTIONS
-.TP 8
-.B \-visual \fIvisual\fP
-Specify which visual to use.  Legal values are the name of a visual class,
-or the id number (decimal or hex) of a specific visual.
+.I gears
+accepts the following options:
 .TP 8
 .B \-window
 Draw on a newly-created window.  This is the default.
@@ -27,14 +24,28 @@ Draw on a newly-created window.  This is the default.
 .B \-root
 Draw on the root window.
 .TP 8
-.B \-delay \fInumber\fP
-Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
+.B \-install
+Install a private colormap for the window.
+.TP 8
+.B \-visual \fIvisual\fP
+Specify which visual to use.  Legal values are the name of a visual class,
+or the id number (decimal or hex) of a specific visual.
+.TP 8
+.B \-delay \fIusecs\fP
+The delay between frames of the animation, in microseconds.
+Default: 30000 (0.03 seconds.)
+.TP 8
+.B \-speed \fIfloat\fP
+Larger numbers mean run faster.  Default: 1.0.
+.TP 8
+.B \-no\-spin
+Don't rotate the object.
 .TP 8
-.B \-cycles \fInumber\fP
-Rotational Speed.  1 - 30.  Default: 2.
+.B \-no\-wander
+Don't wander the object around the screen.
 .TP 8
-.B \-planetary
-Draw a planetary gear system, instead of three simple gears.
+.B \-count \fIinteger\fP
+How many gears to draw.  Default: 0 for random.
 .TP 8
 .B \-wireframe
 Render in wireframe instead of solid.
@@ -54,7 +65,7 @@ stored in the RESOURCE_MANAGER property.
 .BR X (1),
 .BR xscreensaver (1)
 .SH COPYRIGHT
-Copyright \(co 2002 by Jamie Zawinski.  Permission to use, copy, modify, 
+Copyright \(co 2007 by Jamie Zawinski.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is 
 hereby granted without fee, provided that the above copyright notice appear 
 in all copies and that both that copyright notice and this permission notice
@@ -62,4 +73,7 @@ appear in supporting documentation.  No representations are made about the
 suitability of this software for any purpose.  It is provided "as is" without
 express or implied warranty.
 .SH AUTHOR
-By Danny Sung, Brian Paul, Ed Mackey, and Jamie Zawinski.
+Jamie Zawinski.
+
+An earlier version of this program by Brian Paul was written in 1997;
+this version was rewritten from scratch by jwz in 2007.