http://se.aminet.net/pub/X11/ftp.x.org/contrib/vms/xscreensaver-124.zip
[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] [\-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 \-count integer
21 Maximum number of rocks to draw on the screen at once.  Default 100.
22 .TP 8
23 .B \-speed integer
24 A measure of the speed with which the observer and the rocks pass each other,
25 from 1 to 100.  Default 100, meaning ``very fast.''  If you're on a slow 
26 display connection (the animation looks jerky) then try making this number 
27 smaller, and/or decreasing the number of rocks.
28 .TP 8
29 .B \-delay microseconds
30 Number of microseconds to delay between each frame.  Default 50000, meaning
31 about 1/20th second.  Compare and contrast with \fI\-speed\fP, above.
32 .TP 8
33 .B \-norotate
34 Don't rotate the observer; just fly straight through the field.
35 .SH ENVIRONMENT
36 .PP
37 .TP 8
38 .B DISPLAY
39 to get the default host and display number.
40 .TP 8
41 .B XENVIRONMENT
42 to get the name of a resource file that overrides the global resources
43 stored in the RESOURCE_MANAGER property.
44 .SH SEE ALSO
45 .BR X (1),
46 .BR xscreensaver (1)
47 .SH BUGS
48 There should be an option to display doppler shift (a gravity rainbow.)
49
50 Speed of rotation should be settable.
51
52 Default speed of rotation should be relative to forward velocity.
53 .SH COPYRIGHT
54 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
55 distribute, and sell this software and its documentation for any purpose is 
56 hereby granted without fee, provided that the above copyright notice appear 
57 in all copies and that both that copyright notice and this permission notice
58 appear in supporting documentation.  No representations are made about the 
59 suitability of this software for any purpose.  It is provided "as is" without
60 express or implied warranty.
61 .SH AUTHOR
62 Based on Lisp Machine code copyright 1988 John Nguyen <johnn@hx.lcs.mit.edu>.
63
64 Ported to C and X by Jamie Zawinski <jwz@mcom.com>, 13-aug-92.