d26389eb1c47ff68c106ac0168703cba79e8908c
[xscreensaver] / hacks / anemone.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 anemone - wiggling tentacles.
4 .SH SYNOPSIS
5 .B anemone
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-arms \fInumber\fP]
12 [\-finpoints \fInumber\fP]
13 [\-width \fInumber\fP]
14 .SH DESCRIPTION
15 Wiggling tentacles.
16 .SH OPTIONS
17 .TP 8
18 .B \-visual \fIvisual\fP
19 Specify which visual to use.  Legal values are the name of a visual class,
20 or the id number (decimal or hex) of a specific visual.
21 .TP 8
22 .B \-window
23 Draw on a newly-created window.  This is the default.
24 .TP 8
25 .B \-root
26 Draw on the root window.
27 .TP 8
28 .B \-delay \fInumber\fP
29 Per-frame delay, in microseconds.  Default: 40000 (0.04 seconds.).
30 .TP 8
31 .B \-arms \fInumber\fP
32 Arms.  2 - 500.  Default: 128.
33 .TP 8
34 .B \-finpoints \fInumber\fP
35 Tentacles.  3 - 200.  Default: 64.
36 .TP 8
37 .B \-withdraw \fInumber\fP
38 Frequency that the arms withdraw. Arms withdraw on randomly generated
39 values between 1 and 11; this value determines the maximum value of
40 that range. So 100 spends a lot of time withdrawn, while 1000,000 tends
41 not to withdraw at all. Default: 1200.
42 .TP 8
43 .B \-turnspeed \fInumber\fP
44 How fast it turns. At zero, not at all, all they way up to thousands 
45 which are very fast indeed.  Default: 50.
46 .TP 8
47 .B \-width \fInumber\fP
48 Thickness.  1 - 10.  Default: 2.
49
50 .SH ENVIRONMENT
51 .PP
52 .TP 8
53 .B DISPLAY
54 to get the default host and display number.
55 .TP 8
56 .B XENVIRONMENT
57 to get the name of a resource file that overrides the global resources
58 stored in the RESOURCE_MANAGER property.
59 .SH SEE ALSO
60 .BR X (1),
61 .BR xscreensaver (1)
62 .SH COPYRIGHT
63 Copyright \(co 2002 by Gabriel Finch.  Permission to use, copy, modify, 
64 distribute, and sell this software and its documentation for any purpose is 
65 hereby granted without fee, provided that the above copyright notice appear 
66 in all copies and that both that copyright notice and this permission notice
67 appear in supporting documentation.  No representations are made about the 
68 suitability of this software for any purpose.  It is provided "as is" without
69 express or implied warranty.
70 .SH AUTHOR
71 Gabriel Finch.