From http://www.jwz.org/xscreensaver/xscreensaver-5.30.tar.gz
[xscreensaver] / hacks / glx / winduprobot.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 winduprobot - screen saver.
4 .SH SYNOPSIS
5 .B winduprobot
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-count \fInumber\fP]
12 [\-speed \fIratio\fP]
13 [\-size \fIratio\fP]
14 [\-opacity \fIratio\fP]
15 [\-talk \fIratio\fP]
16 [\-no-texture]
17 [\-no-fade]
18 [\-fps]
19 .SH DESCRIPTION
20 A swarm of wind-up toy robots wander around the table-top, bumping into
21 each other. Each robot contains a mechanically accurate gear system inside,
22 which you can see when the robot's shell occasionally fades to
23 transparency.
24 .SH OPTIONS
25 .TP 8
26 .B \-visual \fIvisual\fP
27 Specify which visual to use.  Legal values are the name of a visual class,
28 or the id number (decimal or hex) of a specific visual.
29 .TP 8
30 .B \-window
31 Draw on a newly-created window.  This is the default.
32 .TP 8
33 .B \-root
34 Draw on the root window.
35 .TP 8
36 .B \-delay \fInumber\fP
37 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds).
38 .TP 8
39 .B \-count \fInumber\fP
40 Number of robots.  1 - 100.  Default: 25.
41 .TP 8
42 .B \-speed \fIratio\fP
43 Animation speed.  2.0 means twice as fast, 0.5 means half as fast.
44 .TP 8
45 .B \-size \fIratio\fP
46 Robot size.  2.0 means twice as big, 0.5 means half as big.
47 .TP 8
48 .B \-opacity \fIratio\fP
49 Robot skin transparency.  0.0 - 1.0.  Default: 1.0.
50 .TP 8
51 .B \-talk \fIratio\fP
52 How often to occasionally pop up a word bubble with random text in it.
53 0.0 means never. 1.0 means often.
54 .TP 8
55 .B \-texture | \-no-texture
56 Whether the robot's surface should be reflective chrome.
57 .TP 8
58 .B \-fade | \-no-fade
59 Whether to sometimes fade the robot's opacity to show the inner mechanism.
60 .TP 8
61 .B \-fps | \-no-fps
62 Whether to show a frames-per-second display at the bottom of the screen.
63 .SH ENVIRONMENT
64 .PP
65 .TP 8
66 .B DISPLAY
67 to get the default host and display number.
68 .TP 8
69 .B XENVIRONMENT
70 to get the name of a resource file that overrides the global resources
71 stored in the RESOURCE_MANAGER property.
72 .SH SEE ALSO
73 .BR X (1),
74 .BR xscreensaver (1)
75 .BR xscreensaver-text (1)
76 .SH COPYRIGHT
77 Copyright \(co 2014 by Jamie Zawinski.  Permission to use, copy, modify, 
78 distribute, and sell this software and its documentation for any purpose is 
79 hereby granted without fee, provided that the above copyright notice appear 
80 in all copies and that both that copyright notice and this permission notice
81 appear in supporting documentation.  No representations are made about the 
82 suitability of this software for any purpose.  It is provided "as is" without
83 express or implied warranty.
84 .SH AUTHOR
85 Jamie Zawinski.