af794e5e203399690c04587ddc2546629a1a6dce
[xscreensaver] / hacks / glx / engine.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 engine - draws a 3D four-stroke engine.
4 .SH SYNOPSIS
5 .B engine
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-engine \fIname\fP]
11 [\-delay \fInumber\fP]
12 [\-no-move]
13 [\-no-spin]
14 [\-no-title]
15 [\-fps]
16 .SH DESCRIPTION
17 Draws a simple four-stroke engine that floats around the screen.
18 .SH OPTIONS
19 .TP 8
20 .B \-visual \fIvisual\fP
21 Specify which visual to use.  Legal values are the name of a visual class,
22 or the id number (decimal or hex) of a specific visual.
23 .TP 8
24 .B \-window
25 Draw on a newly-created window.  This is the default.
26 .TP 8
27 .B \-root
28 Draw on the root window.
29 .TP 8
30 .B \-engine \fIname\fP
31 What kind of engine to draw.  Default: random.
32 Known models are:
33 "Honda Insight" (3),
34 "BMW M3" (4),
35 "VW Beetle" (flat 4),
36 "Audi Quattro" (5),
37 "BMW M5" (6),
38 "Subaru XT" (V6),
39 "Porsche 911" (flat 6),
40 "Corvette Z06" (V8),
41 "Dodge Viper" (V10),
42 and
43 "Jaguar XKE" (V12).
44 .TP 8
45 .B \-delay \fInumber\fP
46 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
47 .TP 8
48 .B \-move | \-no-move
49 Whether the object should wander around the screen.
50 .TP 8
51 .B \-spin | \-no-spin
52 Whether the object should spin.
53 .TP 8
54 .B \-fps
55 Display the current frame rate, CPU load, and polygon count.
56 .TP 8
57 .B \-title | \-no-title
58 Whether to display the name of the engine being rendered.
59 .SH ENVIRONMENT
60 .PP
61 .TP 8
62 .B DISPLAY
63 to get the default host and display number.
64 .TP 8
65 .B XENVIRONMENT
66 to get the name of a resource file that overrides the global resources
67 stored in the RESOURCE_MANAGER property.
68 .SH SEE ALSO
69 .BR X (1),
70 .BR xscreensaver (1)
71 .SH COPYRIGHT
72 Copyright \(co 2002 by Ben Buxton.  Permission to use, copy, modify, 
73 distribute, and sell this software and its documentation for any purpose is 
74 hereby granted without fee, provided that the above copyright notice appear 
75 in all copies and that both that copyright notice and this permission notice
76 appear in supporting documentation.  No representations are made about the 
77 suitability of this software for any purpose.  It is provided "as is" without
78 express or implied warranty.
79 .SH AUTHOR
80 Ben Buxton.