4c62a0e798dcf58da3cb5812fcb906b1fdb46be5
[xscreensaver] / hacks / glx / surfaces.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 surfaces - Draws some interesting 3d parametric surfaces.
4 .SH SYNOPSIS
5 .B surfaces
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-speed \fInumber\fP]
11 [\-rand]
12 [\-spin]
13 [\-wander]
14 [\-fps]
15 [\-surface \fIsurface-name\fP]
16 [\-random-surface]
17 [\-dini]
18 [\-enneper]
19 [\-kuen]
20 [\-moebius]
21 [\-seashell]
22 [\-swallowtail]
23 [\-bohemian]
24 [\-whitney]
25 [\-pluecker]
26 [\-henneberg]
27 [\-catalan]
28 [\-corkscrew]
29 [\-mode \fIdisplay-mode\fP]
30 [\-random-mode]
31 [\-points]
32 [\-lines]
33 [\-line-loops]
34 .SH DESCRIPTION
35 This draws one of several three dimensional parametric surfaces.
36 .SH OPTIONS
37 .TP 8
38 .B \-visual \fIvisual\fP
39 Specify which visual to use.  Legal values are the name of a visual
40 class, or the id number (decimal or hex) of a specific visual.
41 .TP 8
42 .B \-window
43 Draw on a newly-created window.  This is the default.
44 .TP 8
45 .B \-root
46 Draw on the root window.
47 .TP 8
48 .B \-delay \fInumber\fP
49 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
50 .TP 8
51 .B \-speed \fInumber\fP
52 Number of frames before changing shape.  Default: 1000.
53 .TP 8
54 .B \-surface random \fP(Shortcut: \fB\-random-surface\fP)
55 Display a random surface.  This is the default.
56 .TP 8
57 .B \-surface dini \fP(Shortcut: \fB\-dini\fP)
58 Display Dini's surface.
59 .TP 8
60 .B \-surface enneper \fP(Shortcut: \fB\-enneper\fP)
61 Display Enneper's minimal surface.
62 .TP 8
63 .B \-surface kuen \fP(Shortcut: \fB\-kuen\fP)
64 Display the Kuen surface.
65 .TP 8
66 .B \-surface moebius \fP(Shortcut: \fB\-moebius\fP)
67 Display the Moebius strip.
68 .TP 8
69 .B \-surface seashell \fP(Shortcut: \fB\-seashell\fP)
70 Display the seashell surface.
71 .TP 8
72 .B \-surface swallowtail \fP(Shortcut: \fB\-swallowtail\fP)
73 Display the swallowtail catastrophe.
74 .TP 8
75 .B \-surface bohemian \fP(Shortcut: \fB\-bohemian\fP)
76 Display the Bohemian dome.
77 .TP 8
78 .B \-surface whitney \fP(Shortcut: \fB\-whitney\fP)
79 Display the Whitney umbrella.
80 .TP 8
81 .B \-surface pluecker \fP(Shortcut: \fB\-pluecker\fP)
82 Display Pluecker's conoid.
83 .TP 8
84 .B \-surface henneberg \fP(Shortcut: \fB\-henneberg\fP)
85 Display Henneberg's minimal surface.
86 .TP 8
87 .B \-surface catalan \fP(Shortcut: \fB\-catalan\fP)
88 Display Catalan's minimal surface.
89 .TP 8
90 .B \-surface corkscrew \fP(Shortcut: \fB\-corkscrew\fP)
91 Display the corkscrew surface.
92 .TP 8
93 .B \-mode random \fP(Shortcut: \fB\-random-mode\fP)
94 Use random OpenGL primitives to display the surface.  This is the
95 default.
96 .TP 8
97 .B \-mode points \fP(Shortcut: \fB\-points\fP)
98 Use OpenGL points to display the surface.
99 .TP 8
100 .B \-mode lines \fP(Shortcut: \fB\-lines\fP)
101 Use OpenGL lines to display the surface.
102 .TP 8
103 .B \-mode line-loops \fP(Shortcut: \fB\-line-loops\fP)
104 Use OpenGL line loops to display the surface.
105 .TP 8
106 .B \-wander | \-no-wander
107 Whether to wander around the screen.
108 .TP 8
109 .B \-spin | \-no-spin
110 Whether to rotate around the center of the figure.
111 .TP 8
112 .B \-fps
113 Display the current frame rate, CPU load, and polygon count.
114 .SH ENVIRONMENT
115 .PP
116 .TP 8
117 .B DISPLAY
118 to get the default host and display number.
119 .TP 8
120 .B XENVIRONMENT
121 to get the name of a resource file that overrides the global resources
122 stored in the RESOURCE_MANAGER property.
123 .SH SEE ALSO
124 .BR X (1),
125 .BR xscreensaver (1)
126 .SH AUTHORS
127 Andrey Mirtchovski, Carsten Steger