From http://www.jwz.org/xscreensaver/xscreensaver-5.35.tar.gz
[xscreensaver] / hacks / glx / quasicrystal.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 quasicrystal - aperiodic plane tilings.
4 .SH SYNOPSIS
5 .B quasicrystal
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-speed \fInumber\fP]
12 [\-count \fInumber\fP]
13 [\-contrast \fIpercent\fP]
14 [\-no-wander]
15 [\-no-spin]
16 [\-asymmetric]
17 [\-fps]
18 .SH DESCRIPTION
19 A quasicrystal is a structure that is ordered but aperiodic.
20 Two-dimensional quasicrystals can be generated by adding a set of planes
21 where x is the sine of y. Different complex aperiodic plane tilings are
22 produced depending on the period, position, and rotation of the component
23 planes, and whether the rotation of the planes is evenly distributed around
24 the circle (the "symmetric" option, above) or random. See also the
25 "RD-Bomb", "CWaves" and "Penrose" screen savers.
26 .SH OPTIONS
27 .TP 8
28 .B \-visual \fIvisual\fP
29 Specify which visual to use.  Legal values are the name of a visual class,
30 or the id number (decimal or hex) of a specific visual.
31 .TP 8
32 .B \-window
33 Draw on a newly-created window.  This is the default.
34 .TP 8
35 .B \-root
36 Draw on the root window.
37 .TP 8
38 .B \-delay \fInumber\fP
39 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
40 .TP 8
41 .B \-speed \fInumber\fP
42 Animation speed. 2 for twice as fast, 0.5 for half as fast.
43 .TP 8
44 .B \-contrast \fIcontrast\fP
45 Contrast. Sort of.  Default 30%.
46 .TP 8
47 .B \-count \fInumber\fP
48 How many planes to use. Default 17.
49 .TP 8
50 .B \-wander | \-no-wander
51 Whether the planes should displace horizontally and vertically.
52 .TP 8
53 .B \-spin | \-no-spin
54 Whether the planes should rotate.
55 .TP 8
56 .B \-asymmetric
57 Allow each plane to rotate freely instead of being constrained to an
58 even distribution around the circle.
59 .TP 8
60 .B \-fps | \-no-fps
61 Whether to show a frames-per-second display at the bottom of the screen.
62 .SH ENVIRONMENT
63 .PP
64 .TP 8
65 .B DISPLAY
66 to get the default host and display number.
67 .TP 8
68 .B XENVIRONMENT
69 to get the name of a resource file that overrides the global resources
70 stored in the RESOURCE_MANAGER property.
71 .SH SEE ALSO
72 .BR X (1),
73 .BR xscreensaver (1)
74 .SH COPYRIGHT
75 Copyright \(co 2013 by Jamie Zawinski.  Permission to use, copy, modify, 
76 distribute, and sell this software and its documentation for any purpose is 
77 hereby granted without fee, provided that the above copyright notice appear 
78 in all copies and that both that copyright notice and this permission notice
79 appear in supporting documentation.  No representations are made about the 
80 suitability of this software for any purpose.  It is provided "as is" without
81 express or implied warranty.
82 .SH AUTHOR
83 Jamie Zawinski.