c4f1d1aef38c5673289c2ef0fd32273a51abda0e
[xscreensaver] / hacks / glx / glknots.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 glknots - generates some twisting 3d knot patterns
4 .SH SYNOPSIS
5 .B glknots
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-speed \fIfloat\fP]
12 [\-segments \fIint\fP]
13 [\-thickness \fIfloat\fP]
14 [\-duration \fIseconds\fP]
15 [\-no-wander]
16 [\-spin \fIXYZ\fP]
17 [\-wireframe]
18 [\-fps]
19 .SH DESCRIPTION
20 Generates some twisting 3d knot patterns.  Spins 'em around.
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 \fInumber\fP
34 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
35 .TP 8
36 .B \-speed \fInumber\fP
37 Larger numbers mean run faster.  Default: 1.0.
38 .TP 8
39 .B \-segments \fInumber\fP
40 Number of segments in each path.  Default 800.  Larger numbers make the
41 curves smoother, at the expense of a higher polygon count.
42 .TP 8
43 .B \-thickness \fIfloat\fP
44 How thick the tubes should be.  Default 0.3.
45 .TP 8
46 .B \-duration \fIseconds\fP
47 How long to leave each knot up.  Default 8 seconds.
48 .TP 8
49 .B \-wander | \-no-wander
50 Whether the cubes should wander around the screen.
51 .TP 8
52 .B \-spin [XYZ] | \-no-spin
53 Which axes, if any, to spin around on.
54 .TP 8
55 .B \-wireframe | \-no-wireframe
56 Render in wireframe instead of solid.
57 .TP 8
58 .B \-fps
59 Display the current frame rate, CPU load, and polygon count.
60 .SH ENVIRONMENT
61 .PP
62 .TP 8
63 .B DISPLAY
64 to get the default host and display number.
65 .TP 8
66 .B XENVIRONMENT
67 to get the name of a resource file that overrides the global resources
68 stored in the RESOURCE_MANAGER property.
69 .SH SEE ALSO
70 .BR X (1),
71 .BR xscreensaver (1)
72 .SH COPYRIGHT
73 Copyright \(co 2003 by Jamie Zawinski.  Permission to use, copy, modify, 
74 distribute, and sell this software and its documentation for any purpose is 
75 hereby granted without fee, provided that the above copyright notice appear 
76 in all copies and that both that copyright notice and this permission notice
77 appear in supporting documentation.  No representations are made about the 
78 suitability of this software for any purpose.  It is provided "as is" without
79 express or implied warranty.
80 .SH AUTHOR
81 Jamie Zawinski.