From http://www.jwz.org/xscreensaver/xscreensaver-5.23.tar.gz
[xscreensaver] / hacks / glx / sballs.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 "03-Oct-01" "X Version 11"
15 .SH NAME
16 sballs - draws balls spinning like crazy in GL
17 .SH SYNOPSIS
18 .B sballs
19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
20 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
21 [\-object \fIobject_number\fP] 
22 [\-cycles \fIsphere_speed\fP] 
23 [\-size \fIviewport_size\fP] 
24 [\-texture] [\-no-texture]
25 [\-wireframe] [\-no-wireframe]
26 [\-trackmouse] [\-no-trackmouse]
27 [\-fps]
28 .SH DESCRIPTION
29 The \fIsballs\fP program draws an animation of balls spinning like crazy in GL.
30 .SH OPTIONS
31 .I sballs
32 accepts the following options:
33 .TP 8
34 .B \-window
35 Draw on a newly-created window.  This is the default.
36 .TP 8
37 .B \-root
38 Draw on the root window.
39 .TP 8
40 .B \-install
41 Install a private colormap for the window.
42 .TP 8
43 .B \-visual \fIvisual\fP
44 Specify which visual to use.  Legal values are the name of a visual class,
45 or the id number (decimal or hex) of a specific visual.
46 .TP 8
47 .B \-fps
48 Display the current frame rate, CPU load, and polygon count.
49 .TP 8
50 .B \-object \fIobject_number\fP\fP
51 Specify how the spheres are grouped (forming an object).
52 Objects are:
53 .TP 10
54 .B 1 
55 tetrahedron
56 .TP 10
57 .B 2 
58 cube. This is the default.
59 .TP 10
60 .B 3 
61 octahedron
62 .TP 10
63 .B 4 
64 dodecahedron
65 .TP 10
66 .B 5 
67 icosahedron
68 .TP 10
69 .B 6 
70 plane
71 .TP 10
72 .B 7 
73 pyramid
74 .TP 10
75 .B 8 
76 star
77 .TP 8
78 .B \-size \fIviewport_size\fP\fP
79 Viewport of GL scene is specified size if greater than 32 and less than screensize. Default value is 0, meaning full screensize.
80 .TP 8
81 .B \-texture
82 Show a textured background and spheres. This is the default.
83 .TP 8
84 .B \-no\-texture
85 Disables texturing the animation.
86 .TP 8
87 .B \-trackmouse
88 Let the mouse be a joystick to change the view of the animation.
89 This implies 
90 .I \-no\-wander.
91 .TP 8
92 .B \-no\-trackmouse
93 Disables mouse tracking. This is the default.
94 .TP 8
95 .B \-wire
96 Draw a wireframe rendition of the spheres.
97 .SH ENVIRONMENT
98 .PP
99 .TP 8
100 .B DISPLAY
101 to get the default host and display number.
102 .TP 8
103 .B XENVIRONMENT
104 to get the name of a resource file that overrides the global resources
105 stored in the RESOURCE_MANAGER property.
106 .SH SEE ALSO
107 .BR X (1),
108 .BR xscreensaver (1)
109 .SH COPYRIGHT
110 Copyright \(co 2001 by Eric Lassauge.
111 Permission to use, copy, modify, distribute, and sell this software and
112 its documentation for any purpose is hereby granted without fee,
113 provided that the above copyright notice appear in all copies and that
114 both that copyright notice and this permission notice appear in
115 supporting documentation.  No representations are made about the
116 suitability of this software for any purpose.  It is provided "as is"
117 without express or implied warranty.
118
119 The original code for this mode was written by
120 Mustata Bogdan (LoneRunner) <lonerunner@planetquake.com>
121 and can be found at http://www.cfxweb.net/lonerunner/
122
123 .SH AUTHOR
124 Mustata Bogdan (LoneRunner) <lonerunner@planetquake.com>
125 Eric Lassauge <lassauge@users.sourceforge.net>