git.hungrycats.org Git - xscreensaver/blob - hacks/glx/glmatrix.man

   1 .TH XScreenSaver 1 "30-Oct-99" "X Version 11"
   2 .SH NAME
   3 glmatrix - simulates the title sequence effect of the movie
   4 .SH SYNOPSIS
   5 .B glmatrix
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
   7 [\-visual \fIvisual\fP]
   8 [\-delay \fIusecs\fP]
   9 [\-speed \fIratio\fP]
  10 [\-density \fIpct\fP]
  11 [\-no\-fog]
  12 [\-no\-waves]
  13 [\-no\-rotate]
  14 [\-binary]
  15 [\-hexadecimal]
  16 [\-dna]
  17 [\-clock]
  18 [\-timefmt \fIfmt\fP]
  19 [\-wireframe]
  20 [\-fps]
  21 .SH DESCRIPTION
  22 The \fIglmatrix\fP program draws the 3D "digital rain" effect, as seen
  23 in the title sequence of the Wachowski brothers' film, "The Matrix".
  24
  25 Also see
  26 .BR xmatrix (MANSUFFIX)
  27 for a 2D rendering of the similar effect that appeared on the
  28 computer monitors actually \fIin\fP the movie.
  29 .SH OPTIONS
  30 .I glmatrix
  31 accepts the following options:
  32 .TP 8
  33 .B \-window
  34 Draw on a newly-created window.  This is the default.
  35 .TP 8
  36 .B \-root
  37 Draw on the root window.
  38 .TP 8
  39 .B \-install
  40 Install a private colormap for the window.
  41 .TP 8
  42 .B \-visual \fIvisual\fP\fP
  43 Specify which visual to use.  Legal values are the name of a visual class,
  44 or the id number (decimal or hex) of a specific visual.
  45 .TP 8
  46 .B \-delay \fIusecs\fP
  47 The delay between frames of the animation, in microseconds: default 30000.
  48 .TP 8
  49 .B \-speed \fIratio\fP
  50 How fast the glyphs should move; default 1.0.  2.0 means twice as fast,
  51 0.5 means half as fast.
  52 .TP 8
  53 .B \-density \fIpercentage\fP
  54 The approximate percentage of the screen that should be filled with
  55 characters at any given time.  Default 20%.
  56 .TP 8
  57 .B \-no\-fog
  58 By default, glyphs are dimmer the farther away they are.  This
  59 argument disables that.
  60 .TP 8
  61 .B \-no\-waves
  62 By default, waves of color roll down the columns of glyphs.  This
  63 argument disables that.
  64 .TP 8
  65 .B \-no-rotate\fP
  66 By default, the scene slowly tilts and rotates.  This
  67 argument disables that.
  68 .TP 8
  69 .B \-binary\fP
  70 Instead of displaying Matrix glyphs, only display ones and zeros.
  71 .TP 8
  72 .B \-hexadecimal\fP
  73 Instead of displaying Matrix glyphs, display hexadecimal digits.
  74 .TP 8
  75 .B \-dna\fP
  76 Instead of displaying Matrix glyphs, display genetic code
  77 (guanine, adenine, thymine, and cytosine.)
  78 .TP 8
  79 .B \-clock\fP
  80 Hide a clock displaying the current time somewhere in the glyphs.
  81 .TP 8
  82 .B \-timefmt\fP \fIstrftime-string\fP
  83 How to format the clock when \fI\-clock\fP is specified.
  84 Default "\ %l%M%p\ ".
  85 .TP 8
  86 .B \-speed \fIratio\fP
  87 Less than 1 for slower, greater than 1 for faster.  Default 1.
  88 .TP 8
  89 .B \-wireframe
  90 Just draw boxes instead of textured characters.
  91 .TP 8
  92 .B \-fps
  93 Display the current frame rate, CPU load, and polygon count.
  94 .SH ENVIRONMENT
  95 .PP
  96 .TP 8
  97 .B DISPLAY
  98 to get the default host and display number.
  99 .TP 8
 100 .B XENVIRONMENT
 101 to get the name of a resource file that overrides the global resources
 102 stored in the RESOURCE_MANAGER property.
 103 .SH SEE ALSO
 104 .BR xmatrix (MANSUFFIX),
 105 .BR X (1),
 106 .BR xscreensaver (1)
 107 .SH COPYRIGHT
 108 Copyright \(co 1999-2003 by Jamie Zawinski.  Permission to use, copy, modify,
 109 distribute, and sell this software and its documentation for any purpose is
 110 hereby granted without fee, provided that the above copyright notice appear
 111 in all copies and that both that copyright notice and this permission notice
 112 appear in supporting documentation.  No representations are made about the
 113 suitability of this software for any purpose.  It is provided "as is" without
 114 express or implied warranty.
 115 .SH AUTHOR
 116 Jamie Zawinski <jwz@jwz.org>, 8-Jun-2003.