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