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