b211b50cd1baffb8733f77122bb3aa00aaafd165
[xscreensaver] / hacks / glx / glmatrix.man
1 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
2 .SH NAME
3 glmatrix - simulates the title sequence effect of the movie
4 .SH SYNOPSIS
5 .B glmatrix
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
7 [\-visual \fIvisual\fP] 
8 [\-delay \fIusecs\fP] 
9 [\-speed \fIratio\fP]
10 [\-density \fIpct\fP]
11 [\-no\-fog]
12 [\-no\-waves]
13 [\-no\-rotate]
14 [\-binary]
15 [\-hexadecimal]
16 [\-dna]
17 [\-clock]
18 [\-timefmt \fIfmt\fP]
19 [\-wireframe]
20 [\-fps]
21 .SH DESCRIPTION
22 The \fIglmatrix\fP program draws dropping characters similar to what
23 is seen in the title sequence of the Wachowski brothers' film,
24 "The Matrix".
25
26 Also see
27 .BR xmatrix (MANSUFFIX)
28 for a 2D rendering of the similar effect that appeared on the
29 computer monitors actually \fIin\fP the movie.
30 .SH OPTIONS
31 .I glmatrix
32 accepts the following options:
33 .TP 8
34 .B \-window
35 Draw on a newly-created window.  This is the default.
36 .TP 8
37 .B \-root
38 Draw on the root window.
39 .TP 8
40 .B \-install
41 Install a private colormap for the window.
42 .TP 8
43 .B \-visual \fIvisual\fP\fP
44 Specify which visual to use.  Legal values are the name of a visual class,
45 or the id number (decimal or hex) of a specific visual.
46 .TP 8
47 .B \-delay \fIusecs\fP
48 The delay between frames of the animation, in microseconds: default 30000.
49 .TP 8
50 .B \-speed \fIratio\fP
51 How fast the glyphs should move; default 1.0.  2.0 means twice as fast,
52 0.5 means half as fast.
53 .TP 8
54 .B \-density \fIpercentage\fP
55 The approximate percentage of the screen that should be filled with 
56 characters at any given time.  Default 20%.
57 .TP 8
58 .B \-no\-fog
59 By default, glyphs are dimmer the farther away they are.  This 
60 argument disables that.
61 .TP 8
62 .B \-no\-waves
63 By default, waves of color roll down the columns of glyphs.  This
64 argument disables that.
65 .TP 8
66 .B \-no-rotate\fP
67 By default, the scene slowly tilts and rotates.  This
68 argument disables that.
69 .TP 8
70 .B \-binary\fP
71 Instead of displaying Matrix glyphs, only display ones and zeros.
72 .TP 8
73 .B \-hexadecimal\fP
74 Instead of displaying Matrix glyphs, display hexadecimal digits.
75 .TP 8
76 .B \-dna\fP
77 Instead of displaying Matrix glyphs, display genetic code
78 (guanine, adenine, thymine, and cytosine.)
79 .TP 8
80 .B \-clock\fP
81 Hide a clock displaying the current time somewhere in the glyphs.
82 .TP 8
83 .B \-timefmt\fP \fIstrftime-string\fP
84 How to format the clock when \fI\-clock\fP is specified.
85 Default "\ %l%M%p\ ".
86 .TP 8
87 .B \-speed \fIratio\fP
88 Less than 1 for slower, greater than 1 for faster.  Default 1.
89 .TP 8
90 .B \-wireframe
91 Just draw boxes instead of textured characters.
92 .TP 8
93 .B \-fps
94 Display the current frame rate, CPU load, and polygon count.
95 .SH ENVIRONMENT
96 .PP
97 .TP 8
98 .B DISPLAY
99 to get the default host and display number.
100 .TP 8
101 .B XENVIRONMENT
102 to get the name of a resource file that overrides the global resources
103 stored in the RESOURCE_MANAGER property.
104 .SH SEE ALSO
105 .BR xmatrix (MANSUFFIX),
106 .BR X (1),
107 .BR xscreensaver (1)
108 .SH COPYRIGHT
109 Copyright \(co 1999-2003 by Jamie Zawinski.  Permission to use, copy, modify, 
110 distribute, and sell this software and its documentation for any purpose is 
111 hereby granted without fee, provided that the above copyright notice appear 
112 in all copies and that both that copyright notice and this permission notice
113 appear in supporting documentation.  No representations are made about the 
114 suitability of this software for any purpose.  It is provided "as is" without
115 express or implied warranty.
116 .SH AUTHOR
117 Jamie Zawinski <jwz@jwz.org>, 8-Jun-2003.