http://www.jwz.org/xscreensaver/xscreensaver-5.10.tar.gz
[xscreensaver] / hacks / starfish.man
1 .TH XScreenSaver 1 "14-Jun-97" "X Version 11"
2 .SH NAME
3 starfish - radially-symmetric throbbing colormap-hacking graphics demo
4 .SH SYNOPSIS
5 .B starfish
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-delay2 \fIsecs\fP] [\-thickness \fIpixels\fP] [\-rotation \fIdegrees\fP] [\-duration \fIseconds\fP] [\-colors \fIint\fP] [\-blob] [\-no\-blob]
7 [\-fps]
8 .SH DESCRIPTION
9 The \fIstarfish\fP program draws radially symmetric objects, which expand,
10 contract, rotate, and turn inside out.  It uses these shapes to lay down a
11 field of smooth colors, and then rotates the colormap.
12 .SH OPTIONS
13 .I starfish
14 accepts the following options:
15 .TP 8
16 .B \-window
17 Draw on a newly-created window.  This is the default.
18 .TP 8
19 .B \-root
20 Draw on the root window.
21 .TP 8
22 .B \-mono 
23 If on a color display, pretend we're on a monochrome display.
24 .TP 8
25 .B \-install
26 Install a private colormap for the window.
27 .TP 8
28 .B \-visual \fIvisual\fP
29 Specify which visual to use.  Legal values are the name of a visual class,
30 or the id number (decimal or hex) of a specific visual.
31 .TP 8
32 .B \-delay \fImicroseconds\fP
33 How much of a delay should be introduced between steps of the animation.
34 Default 10000, or about 1/100th second.
35 .TP 8
36 .B \-thickness \fIpixels\fP
37 How wide each color band should be.  Default 0, meaning random (the chosen
38 value will be between 0 and 15.)
39 .TP 8
40 .B \-rotation \fIdegrees\fP
41 How quickly the objects should rotate at each step.  Default 0, meaning 
42 random (the chosen value will be between 0 and 12 degrees.)
43 .TP 8
44 .B \-colors \fIint\fP
45 How many colors to use.  Default 200.  The more colors, the smoother the
46 transitions will be, and the nicer the resultant images.
47 .TP 8
48 .B \-duration \fIseconds\fP
49 How long to run before choosing a new shape.  Default 30 seconds.
50 .TP 8
51 .B \-delay2 \fIseconds\fP
52 When \fIduration\fP expires, how long to wait before starting a new run.
53 Default 5 seconds.
54 .TP 8
55 .B \-blob
56 .TP 8
57 .B \-no\-blob
58 If \fIblob\fP option is specified, then the raw shapes will be shown, 
59 instead of a field of colors generated from them.
60 .TP 8
61 .B \-fps
62 Display the current frame rate and CPU load.
63 .SH ENVIRONMENT
64 .PP
65 .TP 8
66 .B DISPLAY
67 to get the default host and display number.
68 .TP 8
69 .B XENVIRONMENT
70 to get the name of a resource file that overrides the global resources
71 stored in the RESOURCE_MANAGER property.
72 .SH SEE ALSO
73 .BR X (1),
74 .BR xscreensaver (1)
75 .SH COPYRIGHT
76 Copyright \(co 1997 by Jamie Zawinski.  Permission to use, copy, modify, 
77 distribute, and sell this software and its documentation for any purpose is 
78 hereby granted without fee, provided that the above copyright notice appear 
79 in all copies and that both that copyright notice and this permission notice
80 appear in supporting documentation.  No representations are made about the 
81 suitability of this software for any purpose.  It is provided "as is" without
82 express or implied warranty.
83 .SH AUTHOR
84 Jamie Zawinski <jwz@jwz.org>, 14-Jun-97.