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