http://www.uw-madison.lkams.kernel.org/pub/mirrors/fink/distfiles/xscreensaver-4...
[xscreensaver] / hacks / xmatrix.man
1 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
2 .SH NAME
3 xmatrix - simulates the computer displays from the movie
4 .SH SYNOPSIS
5 .B xmatrix
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 \fIxmatrix\fP program draws dropping characters similar to what
16 is seen on the computer monitors in the Wachowski brothers' film,
17 "The Matrix".  
18
19 Also see
20 .BR glmatrix (1)
21 for a 3D rendering of the similar effect that appeared in the title
22 sequence of the movie.
23 .SH OPTIONS
24 .I xmatrix
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 steps of the animation, in microseconds: default 10000.
42 .TP 8
43 .B \-density \fIpercentage\fP
44 The approximate percentage of the screen that should be filled with 
45 characters at any given time.  Default 75%.
46
47 When running in a window, typing \fB+\fP will increase the density and 
48 typing \fB-\fP will decrease it.  Typing \fB0\fP will momentarily
49 drain the screen.
50 .TP 8
51 .B \-top\fP | \fB\-bottom\fP | \fB\-both
52 If \fB\-top\fP is specified, the characters will only drop in from the
53 top of the screen as sliding columns of characters.  If \fB\-bottom\fP
54 is specified, then instead of sliding columns, the characters will appear
55 as columns that grow downwards and are erased from above.  If \fB\-both\fP
56 is specified, then a mixture of both styles will be used.  The default
57 is \fB\-both\fP.
58
59 When running in a window, typing \fB[\fP will switch to top-mode, 
60 typing \fB\]\fP will switch to bottom-mode, and typing \fB\\\fP will
61 switch to both-mode.
62 .TP 8
63 .B \-small\fP | \fB\-large
64 These options specify the sizes of the characters.  The default
65 is \fB\-large\fP.
66 .TP 8
67 .B \-trace
68 Start off with a representation of a phone number being traced.  
69 When the number is finally found, display The Matrix as usual.
70 .TP 8
71 .B \-phone\fP \fInumber\fP
72 The phone number to trace, if \fB\-trace\fP is specified.
73 .TP 8
74 .B \-crack
75 Start off by shutting down the power grid.
76 .TP 8
77 .B \-binary\fP
78 Instead of displaying Matrix glyphs, only display ones and zeros.
79 .TP 8
80 .B \-hexadecimal\fP
81 Instead of displaying Matrix glyphs, display hexadecimal digits.
82 .TP 8
83 .B \-dna\fP
84 Instead of displaying Matrix glyphs, display genetic code
85 (guanine, adenine, thymine, and cytosine.)
86 .TP 8
87 .B \-knock\-knock\fP
88 Produce some messages at random times.
89 .SH ENVIRONMENT
90 .PP
91 .TP 8
92 .B DISPLAY
93 to get the default host and display number.
94 .TP 8
95 .B XENVIRONMENT
96 to get the name of a resource file that overrides the global resources
97 stored in the RESOURCE_MANAGER property.
98 .SH SEE ALSO
99 .BR glmatrix (1),
100 .BR X (1),
101 .BR xscreensaver (1)
102 .SH COPYRIGHT
103 Copyright \(co 1999-2003 by Jamie Zawinski.  Permission to use, copy, modify, 
104 distribute, and sell this software and its documentation for any purpose is 
105 hereby granted without fee, provided that the above copyright notice appear 
106 in all copies and that both that copyright notice and this permission notice
107 appear in supporting documentation.  No representations are made about the 
108 suitability of this software for any purpose.  It is provided "as is" without
109 express or implied warranty.
110 .SH AUTHOR
111 Jamie Zawinski <jwz@jwz.org>, 25-Apr-99.