git.hungrycats.org Git - xscreensaver/blob - hacks/xmatrix.man

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
  15 .SH NAME
  16 xmatrix - simulates the computer displays from the movie
  17 .SH SYNOPSIS
  18 .B xmatrix
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
  20 [\-visual \fIvisual\fP]
  21 [\-delay \fIusecs\fP]
  22 [\-density \fIpercentage\fP]
  23 [\-top | \-bottom | \-both]
  24 [\-small | \-large]
  25 [\-trace]
  26 [\-mode \fImode\fP]
  27 [\-phone \fInumber\fP]
  28 [\-fps]
  29 .SH DESCRIPTION
  30 The \fIxmatrix\fP program draws the 2D "digital rain" effect, as seen on
  31 the computer monitors in the Wachowski brothers' film, "The Matrix".
  32
  33 Also see
  34 .BR glmatrix (MANSUFFIX)
  35 for a 3D rendering of the similar effect that appeared in the title
  36 sequence of the movie.
  37 .SH OPTIONS
  38 .I xmatrix
  39 accepts the following options:
  40 .TP 8
  41 .B \-window
  42 Draw on a newly-created window.  This is the default.
  43 .TP 8
  44 .B \-root
  45 Draw on the root window.
  46 .TP 8
  47 .B \-install
  48 Install a private colormap for the window.
  49 .TP 8
  50 .B \-visual \fIvisual\fP\fP
  51 Specify which visual to use.  Legal values are the name of a visual class,
  52 or the id number (decimal or hex) of a specific visual.
  53 .TP 8
  54 .B \-delay \fIusecs\fP
  55 The delay between steps of the animation, in microseconds: default 10000.
  56 .TP 8
  57 .B \-density \fIpercentage\fP
  58 The approximate percentage of the screen that should be filled with
  59 characters at any given time.  Default 75%.
  60
  61 When running in a window, typing \fB+\fP will increase the density and
  62 typing \fB-\fP will decrease it.  Typing \fB0\fP will momentarily
  63 drain the screen.
  64 .TP 8
  65 .B \-top\fP | \fB\-bottom\fP | \fB\-both
  66 If \fB\-top\fP is specified, the characters will only drop in from the
  67 top of the screen as sliding columns of characters.  If \fB\-bottom\fP
  68 is specified, then instead of sliding columns, the characters will appear
  69 as columns that grow downwards and are erased from above.  If \fB\-both\fP
  70 is specified, then a mixture of both styles will be used.  The default
  71 is \fB\-both\fP.
  72
  73 When running in a window, typing \fB[\fP will switch to top-mode,
  74 typing \fB\]\fP will switch to bottom-mode, and typing \fB\\\fP will
  75 switch to both-mode.
  76 .TP 8
  77 .B \-small\fP | \fB\-large
  78 These options specify the sizes of the characters.  The default
  79 is \fB\-large\fP.
  80 .TP 8
  81 .B \-mode trace
  82 Start off with a representation of a phone number being traced.
  83 When the number is finally found, display The Matrix as usual.
  84 This is the default.
  85 .TP 8
  86 .B \-phone\fP \fInumber\fP
  87 The phone number to trace, if \fB\-trace\fP is specified.
  88 .TP 8
  89 .B \-mode crack
  90 Start off by shutting down the power grid.
  91 .TP 8
  92 .B \-mode binary
  93 Instead of displaying Matrix glyphs, only display ones and zeros.
  94 .TP 8
  95 .B \-mode hexadecimal
  96 Instead of displaying Matrix glyphs, display hexadecimal digits.
  97 .TP 8
  98 .B \-mode dna
  99 Instead of displaying Matrix glyphs, display genetic code
 100 (guanine, adenine, thymine, and cytosine.)
 101 .TP 8
 102 .B \-mode ascii
 103 Instead of displaying Matrix glyphs, display random ASCII characters.
 104 .TP 8
 105 .B \-mode pipe
 106 Instead of displaying random characters, display the output of a subprocess,
 107 as ASCII.
 108 .TP 8
 109 .B \-program \fIsh-command\fP
 110 The command to run to generate the text to display.  This option may
 111 be any string acceptable to /bin/sh.  The program will be run at the
 112 end of a pty or pipe, and any characters that it prints to
 113 \fIstdout\fP will be placed in the feeders for xmatrix. If the program
 114 exits, it will be launched again after xmatrix has processed all the
 115 text it produced.
 116
 117 For example:
 118 .EX
 119 xmatrix -program 'echo Hello World'
 120 xmatrix -ascii -program 'ps -eo comm | rev'
 121 xmatrix -program 'od -txC -w6 /dev/random'
 122 xmatrix -program 'cat /dev/random'
 123 .EE
 124 .SH ENVIRONMENT
 125 .PP
 126 .TP 8
 127 .B DISPLAY
 128 to get the default host and display number.
 129 .TP 8
 130 .B XENVIRONMENT
 131 to get the name of a resource file that overrides the global resources
 132 stored in the RESOURCE_MANAGER property.
 133 .SH SEE ALSO
 134 .BR glmatrix (MANSUFFIX),
 135 .BR X (1),
 136 .BR xscreensaver (1)
 137 .SH COPYRIGHT
 138 Copyright \(co 1999-2003 by Jamie Zawinski.  Permission to use, copy, modify,
 139 distribute, and sell this software and its documentation for any purpose is
 140 hereby granted without fee, provided that the above copyright notice appear
 141 in all copies and that both that copyright notice and this permission notice
 142 appear in supporting documentation.  No representations are made about the
 143 suitability of this software for any purpose.  It is provided "as is" without
 144 express or implied warranty.
 145 .SH AUTHOR
 146 Jamie Zawinski <jwz@jwz.org>, 25-Apr-99.