source: trunk/third/xscreensaver/hacks/starfish.man @ 12203

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