233c9453fd9e06aed80f1e904c7ae020a5431141
[xscreensaver] / hacks / glx / hypnowheel.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 hypnowheel - draws overlapping, translucent spiral patterns
4 .SH SYNOPSIS
5 .B hypnowheel
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fIint\fP]
11 [\-layers \fIint\fP]
12 [\-count \fIint\fP]
13 [\-twistiness \fIfloat\fP]
14 [\-speed \fIfloat\fP]
15 [\-wander\fP]
16 [\-symmetric\fP]
17 [\-fps]
18 .SH DESCRIPTION
19 Draws a series of overlapping, translucent spiral patterns.
20 The tightness of their spirals fluctuates in and out.
21 .SH OPTIONS
22 .TP 8
23 .B \-visual \fIvisual\fP
24 Specify which visual to use.  Legal values are the name of a visual class,
25 or the id number (decimal or hex) of a specific visual.
26 .TP 8
27 .B \-window
28 Draw on a newly-created window.  This is the default.
29 .TP 8
30 .B \-root
31 Draw on the root window.
32 .TP 8
33 .B \-delay \fIint\fP
34 Delay between frames, in microseconds.  Default 20000.
35 .TP 8
36 .B \-layers \fIint\fP
37 How many different spirals to draw at once.  Default 4.
38 .TP 8
39 .B \-count \fIint\fP
40 How many arms each spiral should have.  Default 11.
41 .TP 8
42 .B \-twistiness \fIfloat\fP
43 How tightly wound the spirals can become, measured in rotations.
44 Default 4.0 (four times around).
45 .TP 8
46 .B \-speed \fIratio\fP
47 Less than 1 for slower, greater than 1 for faster.  Default 1.
48 .TP 8
49 .B \-wander
50 If specified, then the centers of the spirals will wander around,
51 rather than them all having the same origin.
52 .TP 8
53 .B \-symmetric
54 If specified, then each pair of left-wrapping and right-wrapping
55 spirals will be mirror images of each other.
56 .TP 8
57 .B \-fps
58 Display the current frame rate, CPU load, and polygon count.
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 2008 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.