From http://www.jwz.org/xscreensaver/xscreensaver-5.30.tar.gz
[xscreensaver] / hacks / speedmine.man
1 .de EX          \"Begin example
2 .ne 5
3 .if n .sp 1
4 .if t .sp .5
5 .nf
6 .in +.5i
7 ..
8 .de EE
9 .fi
10 .in -.5i
11 .if n .sp 1
12 .if t .sp .5
13 ..
14 .TH XScreenSaver 1 "23-Apr-01" "X Version 11"
15 .SH NAME
16 speedmine - simulates speeding down a rocky mineshaft, or a funky dancing worm
17 .SH SYNOPSIS
18 .B speedmine 
19 [\-display \fIhost:display.screen\fP] [\-root] [\-window]
20 [\-install] [\-noinstall] [\-visual \fIvisual\fP] [\-wire] [\-nowire]
21 [\-worm]
22 [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-darkground \fIcolor\fP] [\-lightground \fIcolor\fP] [\-tunnelend \fIcolor\fP] [\-delay \fImicroseconds\fP] [\-maxspeed \fInumber\fP] [\-thrust \fInumber\fP] [\-gravity \fInumber\fP] [\-vertigo \fInumber\fP] [\-terrain] [\-noterrain] [\-smoothness \fInumber\fP] [\-curviness \fInumber\fP] [\-twistiness \fInumber\fP] [\-widening] [\-nowidening] [\-bumps] [\-nobumps] [\-bonuses] [\-crosshair] [\-nocrosshair] [\-psychedelic] [\-nopsychedelic]
23 [\-fps]
24 .SH DESCRIPTION
25 .TP 8
26 Speedmine!
27  
28 Down the speedmine, you'll find speed
29
30 to satisfy your moving needs;
31
32 So if you're looking for a blast
33
34 then hit the speedmine, really fast.
35 .PP
36 Speedworm loves you.
37  
38 Speedworm likes to bump and grind
39
40 and chase her tail, and dance around
41
42 she really is a funky friend;
43
44 she's made of speed from end to end.
45 .PP
46 You can configure stuff
47 either with command-line options or X resources.
48 .SH OPTIONS
49 .TP 8
50 .B \-display \fIhost:display.screen\fP
51 Specifies which X display we should use (see the section DISPLAY NAMES in
52 .BR X (1)
53 for more information about this option).
54 .TP 8
55 .B \-root
56 Draw on the root window.
57 .TP 8
58 .B \-window
59 Draw on a newly-created window.  This is the default.
60 .TP 8
61 .B \-install
62 Install a private colormap for the window.
63 .TP 8
64 .B \-noinstall
65 Don't install a private colormap for the window.
66 .TP 8
67 .B \-visual \fIvisual\fP
68 Specify which visual to use.  Legal values are the name of a visual
69 class, or the id number (decimal or hex) of a specific visual.
70 Possible choices include
71
72 .RS
73 default, best, mono, monochrome, gray, grey, color, staticgray, staticcolor, 
74 truecolor, grayscale, greyscale, pseudocolor, directcolor, \fInumber\fP
75
76 If a decimal or hexadecimal number is used, 
77 .BR XGetVisualInfo (3X)
78 is consulted to obtain the required visual.
79 .RE
80 .TP 8
81 .B \-worm
82 Be a happy spastic worm instead of a tunnel.
83 .TP 8
84 .B \-wire
85 Specifies that the tunnel/worm should always be rendered in wireframe style.
86 .TP 8
87 .B \-nowire
88 Specifies that the tunnel/worm should be rendered normally. Note that 
89 tunnel rendering may still temporarily switch to wireframe style when 
90 a wireframe bonus is hit, if
91 .B bonuses
92 are enabled.
93 .TP 8
94 .B \-foreground \fIcolor\fP
95 Specifies the default foreground color.
96 .TP 8
97 .B \-background \fIcolor\fP
98 Specifies the default background color.
99 .TP 8
100 .B \-darkground \fIcolor\fP
101 Specifies the color of the darkest portions of the ground (or the
102 worm's belly.)  The ground/belly is colored by a gradient between
103 .B darkground
104 and
105 .B lightground.
106 .TP 8
107 .B \-lightground \fIcolor\fP
108 Specifies the color of the lightest portions of the ground/belly. 
109 The ground/belly is colored by a gradient between
110 .B darkground
111 and
112 .B lightground.
113 .TP 8
114 .B \-tunnelend \fIcolor\fP
115 Specifies the color of the light at the end of the tunnel.
116 .TP 8
117 .B \-delay \fImicroseconds\fP
118 Specifies the delay between drawing successive frames. If you do not specify 
119 .BR -sync ,
120 some X servers may batch up several drawing operations together,
121 producing a less smooth effect.   This is more likely to happen 
122 in monochrome mode (on monochrome servers or when 
123 .B \-mono 
124 is specified).
125 .TP 8
126 .B -maxspeed \fInumber\fP
127 Specifies an upper bound on the speed of normal movement. This does not
128 affect the speed that may be attained when hitting a speed bonus.
129 .TP 8
130 .B -thrust \fInumber\fP
131 Specifies the thrust constantly applied. Positive numbers indicate a forwards
132 thrust, negative numbers indicate a backwards thrust.
133 .TP 8
134 .B -gravity \fInumber\fP
135 Specifies the effect of gravity. Larger numbers will increase acceleration
136 downhill and decrease acceleration uphill.
137 .TP 8
138 .B -vertigo \fInumber\fP
139 Specifies to what level the demo should accentuate the curvature and
140 windiness of the tunnel or worm.
141 .TP 8
142 .B -terrain
143 Continuously generate a fractal terrain to simulate the rockiness of the
144 tunnel walls, or the texture of the worm's skin.
145 .TP 8
146 .B -noterrain
147 Do not generate terrain. When this option is set, all surfaces are flat.
148 .TP 8
149 .B -smoothness \fInumber\fP
150 When
151 .BR -terrain
152 is set, specifies how smooth the walls or skin are.
153 .TP 8
154 .B -curviness \fInumber\fP
155 Controls how much the generated tunnel (or worm) should curve left 
156 and right, and dip up and down.
157 .TP 8
158 .B -twistiness \fInumber\fP
159 Controls how much the generated tunnel (or worm) twists around itself.
160 .TP 8
161 .B -widening
162 Specifies that the generated tunnel (or worm) may vary in width.
163 .TP 8
164 .B -nowidening
165 Specifies that the average width should be kept constant.
166 .TP 8
167 .B -bumps
168 Indicates that the simulation should take the bumpiness of the ground into
169 account and allow the animation to shake and rattle when travelling over
170 rough ground.  Or that the worm should be allowed to bump around and 
171 shake her booty.
172 .TP 8
173 .B -nobumps
174 Indicates that the bumpiness of the ground should be ignored, such that the
175 simulation will glide through the tunnel.  Or that the worm should calm
176 down and behave herself.
177 .TP 8
178 .B -bonuses
179 Indicates that the demo should include bonus events. These include speed
180 bonuses, spins, and changes of viewpoint and rendering style.
181 .TP 8
182 .B -nobonuses
183 Indicates that bonuses should not be included in the demo.
184 .TP 8
185 .B -crosshair
186 Specifies that a gaming style crosshair be drawn on the simulation. This
187 serves little purpose but may make hardcore gamers feel more comfortable.
188 .TP 8
189 .B -nocrosshair
190 Specifies that no crosshair be drawn.
191 .TP 8
192 .B -psychedelic
193 Specifies that a psychedelic colormap should be generated. When this is
194 set, the walls and ground of the tunnel are drawn in an often changing
195 rainbow of colours.
196 .TP 8
197 .B -nopsychedelic
198 Specifies that a normal colormap should be used, with muted walls and a
199 grey road.
200 .TP 8
201 .B \-fps
202 Display the current frame rate and CPU load.
203 .SH RESOURCES
204 .EX
205 Option            Resource               Default Value
206 ------            --------               -------------
207 -wire             .wire                  False
208 -background       .background            black
209 -foreground       .foreground            white
210 -darkground       .darkground            #101010
211 -lightground      .lightground           #a0a0a0
212 -tunnelend        .tunnelend             #000000
213 -delay            .delay                 30000
214 -maxspeed         .maxspeed              700
215 -thrust           .thrust                1.0
216 -gravity          .gravity               9.8
217 -vertigo          .vertigo               1.0
218 -terrain          .terrain               True
219 -smoothness       .smoothness            6
220 -curviness        .curviness             1.0
221 -twistiness       .twistiness            1.0
222 -widening         .widening              True
223 -bumps            .bumps                 True
224 -bonuses          .bonuses               True
225 -crosshair        .crosshair             False
226 -psychedelic      .psychedelic           False
227 .EE
228 .SH WARNING
229 Speedworm is a trained professional. Do not try this at home.
230
231 Prolonged viewing of this demo with
232 .B maxspeed
233 and
234 .B vertigo
235 above the defaults may have short-term psychological side effects including
236 hyperactivity and attention deficiency.
237 .SH COPYRIGHT
238 Copyright \(co 2001, Conrad Parker.  Permission to use, copy, modify,
239 distribute, and sell this software and its documentation for any purpose is
240 hereby granted without fee, provided that the above copyright notice appear
241 in all copies and that both that copyright notice and this permission notice
242 appear in supporting documentation.  No representations are made about the
243 suitability of this software for any purpose.  It is provided "as is" without
244 express or implied warranty.
245 .SH AUTHOR
246 Conrad Parker <conrad@deephackmode.org>, April 2001.