4a408caeab9839a8151512125f41f0602266f097
[xscreensaver] / hacks / glx / geodesic.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 geodesic - animates a mesh geodesic sphere.
4 .SH SYNOPSIS
5 .B geodesic
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-mode \fImode\fP]
11 [\-no-wander]
12 [\-no-spin]
13 [\-fps]
14 [\-delay \fInumber\fP]
15 [\-speed \fInumber\fP]
16 [\-count \fInumber\fP]
17 .SH DESCRIPTION
18 Animates a mesh geodesic sphere of increasing and decreasing complexity. A
19 geodesic sphere is an icosohedron whose equilateral faces are sub-divided
20 into non-equilateral triangles to more closely approximate a sphere.
21
22 The animation shows the equilateral triangles subdivided into four
23 coplanar equilateral triangles; and then inflated outward, causing the
24 sub-triangles to no longer be equilateral, but to more closely
25 approximate the surface of a sphere.
26 .SH OPTIONS
27 .TP 8
28 .B \-visual \fIvisual\fP
29 Specify which visual to use.  Legal values are the name of a visual class,
30 or the id number (decimal or hex) of a specific visual.
31 .TP 8
32 .B \-window
33 Draw on a newly-created window.  This is the default.
34 .TP 8
35 .B \-root
36 Draw on the root window.
37 .TP 8
38 .B \-mode mesh | solid | stellated | stellated2 | wire
39 Face/edge display style. Default mesh.
40 .TP 8
41 .B \-wander | \-no-wander
42 Whether the object should wander around the screen.
43 .TP 8
44 .B \-spin | \-no-spin
45 Whether the object should spin.
46 .TP 8
47 .B \-fps | \-no-fps
48 Whether to show a frames-per-second display at the bottom of the screen.
49 .TP 8
50 .B \-delay \fInumber\fP
51 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds).
52 .TP 8
53 .B \-speed \fInumber\fP
54 Animation speed.  2.0 means twice as fast, 0.5 means half as fast.
55 .TP 8
56 .B \-count \fInumber\fP
57 Depth (frequency) of the geodesic sphere.  Default: 4.
58 .SH ENVIRONMENT
59 .PP
60 .TP 8
61 .B DISPLAY
62 to get the default host and display number.
63 .TP 8
64 .B XENVIRONMENT
65 to get the name of a resource file that overrides the global resources
66 stored in the RESOURCE_MANAGER property.
67 .SH SEE ALSO
68 .BR X (1),
69 .BR xscreensaver (1)
70 .SH COPYRIGHT
71 Copyright \(co 2013 by Jamie Zawinski.  Permission to use, copy, modify, 
72 distribute, and sell this software and its documentation for any purpose is 
73 hereby granted without fee, provided that the above copyright notice appear 
74 in all copies and that both that copyright notice and this permission notice
75 appear in supporting documentation.  No representations are made about the 
76 suitability of this software for any purpose.  It is provided "as is" without
77 express or implied warranty.
78 .SH AUTHOR
79 Jamie Zawinski.