239516725241db59a8f1e08c3bbc8b7ba43aebe3
[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] [\-no-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 a running tally of how many frames per second are being rendered.
49 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
50 your GL performance.
51 .TP 8
52 .B \-object \fIobject_number\fP\fP
53 Specify how the spheres are grouped (forming an object).
54 Objects are:
55 .TP 10
56 .B 1 
57 tetrahedron
58 .TP 10
59 .B 2 
60 cube. This is the default.
61 .TP 10
62 .B 3 
63 octahedron
64 .TP 10
65 .B 4 
66 dodecahedron
67 .TP 10
68 .B 5 
69 icosahedron
70 .TP 10
71 .B 6 
72 plane
73 .TP 10
74 .B 7 
75 pyramid
76 .TP 10
77 .B 8 
78 star
79 .TP 8
80 .B \-size \fIviewport_size\fP\fP
81 Viewport of GL scene is specified size if greater than 32 and less than screensize. Default value is 0, meaning full screensize.
82 .TP 8
83 .B \-texture
84 Show a textured background and spheres. This is the default.
85 .TP 8
86 .B \-no\-texture
87 Disables texturing the animation.
88 .TP 8
89 .B \-trackmouse
90 Let the mouse be a joystick to change the view of the animation.
91 This implies 
92 .I \-no\-wander.
93 .TP 8
94 .B \-no\-trackmouse
95 Disables mouse tracking. This is the default.
96 .TP 8
97 .B \-wire
98 Draw a wireframe rendition of the spheres.
99 .SH ENVIRONMENT
100 .PP
101 .TP 8
102 .B DISPLAY
103 to get the default host and display number.
104 .TP 8
105 .B XENVIRONMENT
106 to get the name of a resource file that overrides the global resources
107 stored in the RESOURCE_MANAGER property.
108 .SH SEE ALSO
109 .BR X (1),
110 .BR xscreensaver (1)
111 .SH COPYRIGHT
112 Copyright \(co 2001 by Eric Lassauge.
113 Permission to use, copy, modify, distribute, and sell this software and
114 its documentation for any purpose is hereby granted without fee,
115 provided that the above copyright notice appear in all copies and that
116 both that copyright notice and this permission notice appear in
117 supporting documentation.  No representations are made about the
118 suitability of this software for any purpose.  It is provided "as is"
119 without express or implied warranty.
120
121 The original code for this mode was written by
122 Mustata Bogdan (LoneRunner) <lonerunner@planetquake.com>
123 and can be found at http://www.cfxweb.net/lonerunner/
124
125 .SH AUTHOR
126 Mustata Bogdan (LoneRunner) <lonerunner@planetquake.com>
127 Eric Lassauge <lassauge@users.sourceforge.net>