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