forked from M4444/TMatrix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtmatrix.6
105 lines (105 loc) · 2.43 KB
/
tmatrix.6
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.TH TMatrix 6 "27 May 2019" "TMatrix Version 1.0"
.SH NAME
TMatrix \- Terminal based replica of the digital rain from The Matrix
.SH SYNOPSIS
.nf
\fItmatrix\fR [--version] [--help] [--mode=<mode>]
[-s<value>|--steps-per-sec=<value>]
[-f<min>,<max>|--fall-speed=<min>,<max>]
[-G<min>,<max>|--start-gap=<min>,<max>]
[-g<min>,<max>|--gap=<min>,<max>] [-l<min>,<max>]
[-r<min>,<max>] [-C<color> | --color=<color>]
[-c<color> | --background=<color>] [-t<text> | --title=<text>]
.fi
.SH DESCRIPTION
Simulates the digital rain effect from The Matrix.
.SH OPTIONS
.TP 4
\-\-version
Output version information and exit.
.TP 4
\-\-help
Display this help and exit.
.TP 4
\-\-mode=<mode>
Set the mode of the rain.
.br
Available modes: \fBdefault\fR, \fBdense\fR.
.TP 4
\-s, \-\-steps-per-sec=<value>
Run this many steps per second.
.br
<value> can range from \fB1\fR to \fB60\fR.
.br
Default: \fI10\fR.
.TP 4
\-f, --fall-speed=<min>,<max>
Set the range for the fall speed.
.br
The maximal fall speed value is \fB10\fR.
.br
Default: \fI1,1\fR.
.TP 4
\-G, --start-gap=<min>,<max>
Set the range for the starting gaps.
.br
Default: \fI10,50\fR.
.TP 4
\-g, --gap=<min>,<max>
Set the range for the gaps between streaks.
.br
Default: \fI0,40\fR.
.TP 4
\-l <min>,<max>
Set the range for the length of rain streaks.
.br
The minimal length value is \fB1\fR.
.br
Default: \fI1,30\fR.
.TP 4
\-r <min>,<max>
Set the range for the update rate of the Matrix characters.
.br
The values correspond to the number of steps before the change.
.br
\fB0\fR represents no change.
.br
Default: \fI10,20\fR.
.TP 4
\-C, --color=<color>
Set the color of the Matrix characters.
.br
Available colors: \fBdefault\fR, \fBwhite\fR, \fBgray\fR, \fBblack\fR, \fBred\fR, \fBgreen\fR,
.br
\fByellow\fR, \fBblue\fR, \fBmagenta\fR, \fBcyan\fR.
.br
Default: \fIgreen\fR.
.TP 4
\-c, --background=<color>
Set the color of the background.
.br
Available colors: \fBdefault\fR, \fBwhite\fR, \fBgray\fR, \fBblack\fR, \fBred\fR, \fBgreen\fR,
.br
\fByellow\fR, \fBblue\fR, \fBmagenta\fR, \fBcyan\fR.
.TP 4
\-t, --title=<text>
Set the title that appears in the rain.
.br
\fINote\fR: the title needs to fit within the terminal window
.br
in order to be displayed.
.SH Real-time commands
.TP 4
p
Pause
.TP 4
q
Quit
.SH AUTHORS
Written by Miloš Stojanović <[email protected]>
.SH LICENSE
Copyright (C) 2018-2019 Miloš Stojanović
.br
SPDX-License-Identifier: GPL-2.0-only
.SH SEE ALSO
.BR cmatrix (1)