From http://www.jwz.org/xscreensaver/xscreensaver-5.23.tar.gz
[xscreensaver] / hacks / glx / boing.man
1 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
2 .SH NAME
3 boing - draws a bouncing ball like the ancient Amiga demo
4 .SH SYNOPSIS
5 .B boing
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
7 [\-visual \fIvisual\fP] 
8 [\-delay \fIusecs\fP] 
9 [\-smooth]
10 [\-lighting]
11 [\-scanlines]
12 [\-speed]
13 [\-no\-spin]
14 [\-angle \fIdegrees\fP]
15 [\-size \fIratio\fP]
16 [\-parallels \fIn\fP]
17 [\-meridians \fIn\fP]
18 [\-wireframe]
19 [\-fps]
20 .SH DESCRIPTION
21 The \fIboing\fP program draws a bouncing checkered ball on a grid.
22
23 This is a clone of the first graphics demo for the Amiga 1000, which
24 was written by Dale Luck and RJ Mical during a break at the 1984
25 Consumer Electronics Show (or so the legend goes.)  The boing ball was
26 briefly the official logo of Amiga Inc., until they were bought by
27 Commodore later that year.
28
29 With no arguments, this program looks a lot like the original Amiga
30 demo. With "-smooth -lighting", it looks... less old.
31 .SH OPTIONS
32 .I boing
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\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 \-delay \fIusecs\fP
49 The delay between frames of the animation, in microseconds: default 15000.
50 .TP 8
51 .B \-smooth
52 Draw a smooth sphere instead of a faceted polyhedron.
53 .TP 8
54 .B \-lighting
55 Do shaded lighting instead of flat colors.
56 .TP 8
57 .B \-scanlines
58 If the window is large enough, draw horizontal lines to simulate the
59 scanlines on a low resolution monitor.
60 .TP 8
61 .B \-speed \fIratio\fP
62 Change the animation speed; 0.5 to go half as fast, 2.0 to go twice as fast.
63 .TP 8
64 .B \-no\-spin
65 Don't rotate the ball.
66 .TP 8
67 .B \-angle \fIdegrees\fP
68 The jaunty angle at which the ball sits.  Default 15 degrees.
69 .TP 8
70 .B \-size \fIratio\fP
71 How big the ball is; default 0.5 meaning about half the size of the window.
72 .TP 8
73 .B \-parallels \fIn\fP
74 .B \-meridians \fIn\fP
75 The pattern of rectangles on the ball.  Default 8x16.
76 .TP 8
77 .B \-wireframe
78 Look crummy.
79 .TP 8
80 .B \-fps
81 Display the current frame rate, CPU load, and polygon count.
82 .SH ENVIRONMENT
83 .PP
84 .TP 8
85 .B DISPLAY
86 to get the default host and display number.
87 .TP 8
88 .B XENVIRONMENT
89 to get the name of a resource file that overrides the global resources
90 stored in the RESOURCE_MANAGER property.
91 .SH SEE ALSO
92 .BR bsod (MANSUFFIX),
93 .BR pong (MANSUFFIX),
94 .BR xscreensaver (1),
95 .BR X (1)
96 .SH COPYRIGHT
97 Copyright \(co 2005 by Jamie Zawinski.  Permission to use, copy, modify, 
98 distribute, and sell this software and its documentation for any purpose is 
99 hereby granted without fee, provided that the above copyright notice appear 
100 in all copies and that both that copyright notice and this permission notice
101 appear in supporting documentation.  No representations are made about the 
102 suitability of this software for any purpose.  It is provided "as is" without
103 express or implied warranty.
104 .SH AUTHOR
105 Jamie Zawinski <jwz@jwz.org>, 19-Feb-2005.