ftp://ftp.linux.ncsu.edu/mirror/ftp.redhat.com/pub/redhat/linux/enterprise/4/en/os...
[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 [\-count \fInumber_of_spheres\fP] 
23 [\-cycles \fIsphere_speed\fP] 
24 [\-size \fIviewport_size\fP] 
25 [\-texture] [\-no-texture]
26 [\-wireframe] [\-no-wireframe]
27 [\-trackmouse] [\-no-trackmouse]
28 [\-fps] [\-no-fps]
29 .SH DESCRIPTION
30 The \fIsballs\fP program draws an animation of balls spinning like crazy in GL.
31 .SH OPTIONS
32 .I sballs
33 accepts the following options:
34 .TP 8
35 .B \-window
36 Draw on a newly-created window.  This is the default.
37 .TP 8
38 .B \-root
39 Draw on the root window.
40 .TP 8
41 .B \-install
42 Install a private colormap for the window.
43 .TP 8
44 .B \-visual \fIvisual\fP
45 Specify which visual to use.  Legal values are the name of a visual class,
46 or the id number (decimal or hex) of a specific visual.
47 .TP 8
48 .B \-fps
49 Display a running tally of how many frames per second are being rendered.
50 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of 
51 your GL performance.
52 .TP 8
53 .B \-object \fIobject_number\fP\fP
54 Specify how the spheres are grouped (forming an object).
55 Objects are:
56 .TP 10
57 .B 1 
58 tetrahedron
59 .TP 10
60 .B 2 
61 cube. This is the default.
62 .TP 10
63 .B 3 
64 octahedron
65 .TP 10
66 .B 4 
67 dodecahedron
68 .TP 10
69 .B 5 
70 icosahedron
71 .TP 10
72 .B 6 
73 plane
74 .TP 10
75 .B 7 
76 pyramid
77 .TP 10
78 .B 8 
79 star
80 .TP 8
81 .B \-count \fInumber_of_spheres\fP\fP
82 Specify how much spheres are drawn in the selected object. 
83 .TP 8
84 .B \-size \fIviewport_size\fP\fP
85 Viewport of GL scene is specified size if greater than 32 and less than screensize. Default value is 0, meaning full screensize.
86 .TP 8
87 .B \-count \fInumber_of_particles\fP\fP
88 Specify how much fire particles are drawn. A very special case is 0
89 wich means that you get
90 .B rain
91 !
92 .TP 8
93 .B \-texture
94 Show a textured background and spheres. This is the default.
95 .TP 8
96 .B \-no\-texture
97 Disables texturing the animation.
98 .TP 8
99 .B \-trackmouse
100 Let the mouse be a joystick to change the view of the animation.
101 This implies 
102 .I \-no\-wander.
103 .TP 8
104 .B \-no\-trackmouse
105 Disables mouse tracking. This is the default.
106 .TP 8
107 .B \-wire
108 Draw a wireframe rendition of the spheres.
109 .SH ENVIRONMENT
110 .PP
111 .TP 8
112 .B DISPLAY
113 to get the default host and display number.
114 .TP 8
115 .B XENVIRONMENT
116 to get the name of a resource file that overrides the global resources
117 stored in the RESOURCE_MANAGER property.
118 .SH SEE ALSO
119 .BR X (1),
120 .BR xscreensaver (1)
121 .SH COPYRIGHT
122 Copyright \(co 2001 by Eric Lassauge.
123 Permission to use, copy, modify, distribute, and sell this software and
124 its documentation for any purpose is hereby granted without fee,
125 provided that the above copyright notice appear in all copies and that
126 both that copyright notice and this permission notice appear in
127 supporting documentation.  No representations are made about the
128 suitability of this software for any purpose.  It is provided "as is"
129 without express or implied warranty.
130
131 The original code for this mode was written by
132 Mustata Bogdan (LoneRunner) <lonerunner@planetquake.com>
133 and can be found at http://www.cfxweb.net/lonerunner/
134
135 .SH AUTHOR
136 Mustata Bogdan (LoneRunner) <lonerunner@planetquake.com>
137 Eric Lassauge <lassauge@users.sourceforge.net>