http://ftp.x.org/contrib/applications/xscreensaver-3.23.tar.gz
[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 the
16 displays in the Wachowski brothers' film, "The Matrix".
17 .SH OPTIONS
18 .I xmatrix
19 accepts the following options:
20 .TP 8
21 .B \-window
22 Draw on a newly-created window.  This is the default.
23 .TP 8
24 .B \-root
25 Draw on the root window.
26 .TP 8
27 .B \-install
28 Install a private colormap for the window.
29 .TP 8
30 .B \-visual \fIvisual\fP\fP
31 Specify which visual to use.  Legal values are the name of a visual class,
32 or the id number (decimal or hex) of a specific visual.
33 .TP 8
34 .B \-delay \fIusecs\fP
35 The delay between steps of the animation, in microseconds: default 10000.
36 .TP 8
37 .B \-density \fIpercentage\fP
38 The approximate percentage of the screen that should be filled with 
39 characters at any given time.  Default 75%.
40 .TP 8
41 .B \-top\fP | \fB\-bottom\fP | \fB\-both
42 If \fB\-top\fP is specified, the characters will only drop in from the
43 top of the screen as sliding columns of characters.  If \fB\-bottom\fP
44 is specified, then instead of sliding columns, the characters will appear
45 as columns that grow downwards and are erased from above.  If \fB\-both\fP
46 is specified, then a mixture of both styles will be used.  The default
47 is \fB\-both\fP.
48 .TP 8
49 .B \-small\fP | \fB\-large
50 These options specify the sizes of the characters.  The default
51 is \fB\-large\fP.
52
53 .TP 8
54 .B \-trace
55 Start off with a representation of a phone number being traced.  
56 When the number is finally found, display The Matrix as usual.
57 .TP 8
58 .B \-phone\fP \fInumber\fP
59 The phone number to trace, if \fB\-trace\fP is specified.
60 .SH ENVIRONMENT
61 .PP
62 .TP 8
63 .B DISPLAY
64 to get the default host and display number.
65 .TP 8
66 .B XENVIRONMENT
67 to get the name of a resource file that overrides the global resources
68 stored in the RESOURCE_MANAGER property.
69 .SH SEE ALSO
70 .BR X (1),
71 .BR xscreensaver (1)
72 .SH COPYRIGHT
73 Copyright \(co 1999 by Jamie Zawinski.  Permission to use, copy, modify, 
74 distribute, and sell this software and its documentation for any purpose is 
75 hereby granted without fee, provided that the above copyright notice appear 
76 in all copies and that both that copyright notice and this permission notice
77 appear in supporting documentation.  No representations are made about the 
78 suitability of this software for any purpose.  It is provided "as is" without
79 express or implied warranty.
80 .SH AUTHOR
81 Jamie Zawinski <jwz@jwz.org>, 25-Apr-99.