cbf90400d9d02f18282cb5f9fbe8cd39e9f091d2
[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 http://en.wikipedia.org/wiki/Quasicrystal
27 .SH OPTIONS
28 .TP 8
29 .B \-visual \fIvisual\fP
30 Specify which visual to use.  Legal values are the name of a visual class,
31 or the id number (decimal or hex) of a specific visual.
32 .TP 8
33 .B \-window
34 Draw on a newly-created window.  This is the default.
35 .TP 8
36 .B \-root
37 Draw on the root window.
38 .TP 8
39 .B \-delay \fInumber\fP
40 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
41 .TP 8
42 .B \-speed \fInumber\fP
43 Animation speed. 2 for twice as fast, 0.5 for half as fast.
44 .TP 8
45 .B \-contrast \fIcontrast\fP
46 Contrast. Sort of.  Default 30%.
47 .TP 8
48 .B \-count \fInumber\fP
49 How many planes to use. Default 17.
50 .TP 8
51 .B \-wander | \-no-wander
52 Whether the planes should displace horizontally and vertically.
53 .TP 8
54 .B \-spin | \-no-spin
55 Whether the planes should rotate.
56 .TP 8
57 .B \-asymmetric
58 Allow each plane to rotate freely instead of being constrained to an
59 even distribution around the circle.
60 .TP 8
61 .B \-fps | \-no-fps
62 Whether to show a frames-per-second display at the bottom of the screen.
63 .SH ENVIRONMENT
64 .PP
65 .TP 8
66 .B DISPLAY
67 to get the default host and display number.
68 .TP 8
69 .B XENVIRONMENT
70 to get the name of a resource file that overrides the global resources
71 stored in the RESOURCE_MANAGER property.
72 .SH SEE ALSO
73 .BR X (1),
74 .BR xscreensaver (1)
75 .SH COPYRIGHT
76 Copyright \(co 2013 by Jamie Zawinski.  Permission to use, copy, modify, 
77 distribute, and sell this software and its documentation for any purpose is 
78 hereby granted without fee, provided that the above copyright notice appear 
79 in all copies and that both that copyright notice and this permission notice
80 appear in supporting documentation.  No representations are made about the 
81 suitability of this software for any purpose.  It is provided "as is" without
82 express or implied warranty.
83 .SH AUTHOR
84 Jamie Zawinski.