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