22256d3eb296d7a28919a9440a4ba239838e0855
[xscreensaver] / hacks / rocks.man
1 .TH XScreenSaver 1 "13-aug-92" "X Version 11"
2 .SH NAME
3 rocks - animation of flying through an asteroid field
4 .SH SYNOPSIS
5 .B rocks
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-install] [\-visual \fIvisual\fP] [\-count \fIinteger\fP] [\-delay \fIusecs\fP] [\-speed \fIinteger\fP] [\-norotate]
7 .SH DESCRIPTION
8 The \fIrocks\fP program draws an animation of an asteroid field moving past
9 the observer (or vice versa).  Sometimes the observer picks up spin on Z axis.
10 .SH OPTIONS
11 .I rocks
12 accepts the following options:
13 .TP 8
14 .B \-window
15 Draw on a newly-created window.  This is the default.
16 .TP 8
17 .B \-root
18 Draw on the root window.
19 .TP 8
20 .B \-install
21 Install a private colormap for the window.
22 .TP 8
23 .B \-visual \fIvisual\fP
24 Specify which visual to use.  Legal values are the name of a visual class,
25 or the id number (decimal or hex) of a specific visual.
26 .TP 8
27 .B \-count \fIinteger\fP
28 Maximum number of rocks to draw on the screen at once.  Default 100.
29 .TP 8
30 .B \-speed \fIinteger\fP
31 A measure of the speed with which the observer and the rocks pass each other,
32 from 1 to 100.  Default 100, meaning ``very fast.''  If you're on a slow 
33 display connection (the animation looks jerky) then try making this number 
34 smaller, and/or decreasing the number of rocks.
35 .TP 8
36 .B \-delay \fImicroseconds\fP
37 Number of microseconds to delay between each frame.  Default 50000, meaning
38 about 1/20th second.  Compare and contrast with \fI\-speed\fP, above.
39 .TP 8
40 .B \-norotate
41 Don't rotate the observer; just fly straight through the field.
42 .SH ENVIRONMENT
43 .PP
44 .TP 8
45 .B DISPLAY
46 to get the default host and display number.
47 .TP 8
48 .B XENVIRONMENT
49 to get the name of a resource file that overrides the global resources
50 stored in the RESOURCE_MANAGER property.
51 .SH SEE ALSO
52 .BR X (1),
53 .BR xscreensaver (1)
54 .SH BUGS
55 There should be an option to display doppler shift (a gravity rainbow.)
56
57 Speed of rotation should be settable.
58
59 Default speed of rotation should be relative to forward velocity.
60 .SH COPYRIGHT
61 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
62 distribute, and sell this software and its documentation for any purpose is 
63 hereby granted without fee, provided that the above copyright notice appear 
64 in all copies and that both that copyright notice and this permission notice
65 appear in supporting documentation.  No representations are made about the 
66 suitability of this software for any purpose.  It is provided "as is" without
67 express or implied warranty.
68 .SH AUTHOR
69 Based on Lisp Machine code copyright 1988 John Nguyen <johnn@hx.lcs.mit.edu>.
70
71 Ported to C and X by Jamie Zawinski <jwz@netscape.com>, 13-aug-92.