44e48db12975ee97b2cf8b3bc19f20426c010e5a
[xscreensaver] / hacks / glx / glplanet.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 glplanet - rotating 3d texture-mapped planet.
4 .SH SYNOPSIS
5 .B glplanet
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-image \fIfile\fP]
12 [\-resolution \fInumber\fP]
13 [\-wireframe]
14 [\-fps]
15 .SH DESCRIPTION
16 Draws a planet bouncing around in space.  The built-in image is a map
17 of the earth, but you can wrap any texture around the sphere, e.g., the
18 planetary textures that come with `ssystem'.
19 .SH OPTIONS
20 .TP 8
21 .B \-visual \fIvisual\fP
22 Specify which visual to use.  Legal values are the name of a visual class,
23 or the id number (decimal or hex) of a specific visual.
24 .TP 8
25 .B \-window
26 Draw on a newly-created window.  This is the default.
27 .TP 8
28 .B \-root
29 Draw on the root window.
30 .TP 8
31 .B \-delay \fInumber\fP
32 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
33 .TP 8
34 .B \-images \fIfile\fP
35 The texture map to wrap around the planet's surface.
36 .TP 8
37 .B \-resolution
38 The resolution of the planet. Default: 128.
39 .TP 8
40 .B \-wireframe
41 Render in wireframe instead of solid.
42 .TP 8
43 .B \-fps
44 Display the current frame rate, CPU load, and polygon count.
45 .SH ENVIRONMENT
46 .PP
47 .TP 8
48 .B DISPLAY
49 to get the default host and display number.
50 .TP 8
51 .B XENVIRONMENT
52 to get the name of a resource file that overrides the global resources
53 stored in the RESOURCE_MANAGER property.
54 .SH SEE ALSO
55 .BR X (1),
56 .BR xscreensaver (1)
57 .SH COPYRIGHT
58 Copyright \(co 2002 by David Konerding.  Permission to use, copy, modify, 
59 distribute, and sell this software and its documentation for any purpose is 
60 hereby granted without fee, provided that the above copyright notice appear 
61 in all copies and that both that copyright notice and this permission notice
62 appear in supporting documentation.  No representations are made about the 
63 suitability of this software for any purpose.  It is provided "as is" without
64 express or implied warranty.
65 .SH AUTHOR
66 David Konerding.