cmatrix.1

.TH CMatrix 1 "Mon May 3 1999"
.SH NAME
CMatrix
.SH SYNOPSIS
.B cmatrix
[\-abchskV] [\-F fps] [\-T color] [\-H color] [\-O color] [\-M message]
.SH DESCRIPTION
Shows a scrolling 'Matrix' like screen in Linux.
.PP
Rendering uses Notcurses (24-bit color, UTF-8). Build and run-time require \fBlibnotcurses\fR (e.g. Debian: \fBlibnotcurses-dev\fR).
.PP
Default rain uses Unicode PUA \fBU+E000\fR–\fBU+E069\fR (106 glyphs) from a merged DejaVu font. \fBmake install\fR installs the patched font as \fI~/.local/share/fonts/DejaVuSansMono.ttf\fR on Linux (runs \fBfc-cache -fv\fR on that directory) and as \fI~/Library/Fonts/DejaVuSansMono.ttf\fR on macOS. Set your terminal font to \fIDejaVu Sans Mono\fR so those code points render correctly.
.SS OPTIONS
.TP
.I "\-a"
Asynchronous scroll
.TP
.I "\-b"
Bold characters on
.TP
.I "\-B"
All bold characters (overrides \-b)
.TP
.I "\-o"
Use old-style scrolling
.TP
.I "\-c"
Matrix glyphs mode: draws the movie-style column stream (Unicode halfwidth forms U+FF66–U+FF9D plus Basic Latin, one column per cell) using the wide-character API. Requires UTF-8 locale and a terminal font that includes those code points. Set
.B CMATRIX_ASCII_FALLBACK=1
to use ASCII placeholders instead.
.TP
.I "\-h, \-?"
Print usage and exit
.TP
.I "\-k"
Every characters change 
.TP
.I "\-s"
"Screensaver" mode, exits on first keystroke
.TP
.I "\-V"
Print version information and exit
.TP
.I "\-F fps"
Frame rate in frames per second, 12–60 (default 24).
.TP
.I "\-T color"
Matrix tail color (default green).
.TP
.I "\-H color"
Drop head color (default mint).
.TP
.I "\-O color"
\fB\-M\fR message color (default red).
.PP
For \fB\-T\fR, \fB\-H\fR, and \fB\-O\fR, each \fIcolor\fR is a name (string) or hex \fI#RRGGBB\fR with a leading \fB#\fR.
.TP
.I "\-M message"
Add a message in the center of cmatrix
.SS KEYSTROKES
The following keystrokes are available during execution (unavailable in
\-s mode)
.TP
.I "a"
Toggle asynchronous scroll
.TP
.I "b"
Random bold characters
.TP
.I "n"
Turn off bold characters
.TP
.I "! @ # $ % ^ & )"
Change the color of the matrix to the corresponding color:
! \- red, @ \- green, # \- yellow, $ \- blue, % \- magenta, ^ \- cyan,
& \- white, ) \- black.
.TP
.I "q"
Quit the program
.SH ENVIRONMENT
.TP
.B CMATRIX_ASCII_FALLBACK
If set, \fB\-c\fR always uses ASCII placeholders (#0-9A-F).
.TP
.B CMATRIX_NO_ALTERNATE_SCREEN
If set, Notcurses is started without the alternate screen (may help garbled display on some terminals).
.TP
.B CMATRIX_USE_DEVTTY
If set on macOS, pass a write\-only \fI/dev/tty\fR \fBFILE\fR to \fBnotcurses_init\fR instead of \fBstdout\fR. Default follows upstream guidance (\fBstdout\fR). Use only if an environment specifically needs this split.
.TP
.B CMATRIX_NO_EXTRA_PILE
If set on macOS, do not create the auxiliary full\-screen pile when the standard plane has the wrong geometry.
.TP
.B TERM
If \fBTERM\fR is \fIdumb\fR or unset, \fB\-c\fR is disabled and a warning is printed.
.SH FONTS FOR MATRIX GLYPH MODE (\-c)
Matrix glyphs mode uses halfwidth-form code points (U+FF66–U+FF9D) and Basic Latin (single-column). Choose a UTF\-8 terminal font that includes those ranges. Cmatrix does not change your terminal font; use your terminal’s font settings or the install helper scripts.
.RS
.IP "Testing your font" 4
Paste in your terminal: \fIｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿ\fR. If you see boxes or replacement characters, the font does not include the halfwidth forms used for matrix glyphs (U+FF66–U+FF9D).
.RE
.SH BUGS
This program is very CPU intensive.  Don't be surprised if it eats up over
40% of your CPU at times.
.SH AUTHORS
Original CMatrix by Chris Allegretta (1999\-2017) and Abishek V Ashok (2017\-Present).
This version (fork) by shr00mie.
.SH HOMEPAGE
Upstream: https://github.com/abishekvashok/cmatrix