aboutsummaryrefslogtreecommitdiff
path: root/games/tetrinetx/tetrinetx.6
blob: ca9d10f74dd5342bf91220cb03c1a5217ea000d1 (plain)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TETRINETX" 6 "2023-02-13" "1.13.16+qirc_1.40c_15" "SlackBuilds.org"
.SH NAME
tetrinetx \- server for tetrinet game
.\" RST source for tetrinetx(6) man page. Convert with:
.
.\" rst2man.py tetrinetx.rst > tetrinetx.6
.
.SH SYNOPSIS
.sp
/etc/rc.d/rc.tetrinetx [ \fBstart\fP | \fBstop\fP | \fBrestart\fP ]
.SH DESCRIPTION
.sp
\fBtetrinetx\fP provides a server for hosting TetriNET games. TetriNET
is a multiplayer variant of Tetris played over the internet. Up to
six people may simultaneously connect to a server to participate in
a game.
.sp
\fBtetrinetx\fP supports only the original TetriNET game mode, not the
TetriFAST mode. Clients attempting to connect with TetriFAST will be
immediately disconnected.
.sp
The actual \fBtetrinetx\fP binary should not normally be run
directly. Instead, use the startup script. If you want to start the
server at boot, include a call to it in your \fI/etc/rc.d/rc.local\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if [ \-x /etc/rc.d/rc.tetrinetx ]; then
  /etc/rc.d/rc.tetrinetx start
fi
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\&...and possibly in \fI/etc/rc.d/rc.local_shutdown\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if [ \-x /etc/rc.d/rc.tetrinetx ]; then
  /etc/rc.d/rc.tetrinetx stop
fi
.ft P
.fi
.UNINDENT
.UNINDENT
.SH FILES
.sp
All configuration is done via config files; there are no command\-line
options (other than start/stop/restart, for the init script).
.INDENT 0.0
.TP
.B /etc/tetrinetx/game.conf
The main config file for \fBtetrinetx\fP\&. Human\-readable and editable,
with explanatory comments.
.TP
.B /etc/tetrinetx/game.motd
The "message of the day" shown to regular clients when they connect.
.TP
.B /etc/tetrinetx/game.pmotd
Message shown to playback (spectator) service clients.
.TP
.B /etc/tetrinetx/game.secure
Used to define passwords clients can send to authenticate as server
admins. By default, nothing is defined here (everything is commented out).
.TP
.B /etc/tetrinetx/game.ban, game.allow, game.ban.compromise
Controls who is allowed to connect to the server. These files don\(aqt
ship with the package, but ".example" files are included to show you
how they work.
.TP
.B /var/log/tetrinetx/game.log
Log file for \fBtetrinetx\fP\&.
.TP
.B /var/games/tetrinetx/game.winlist, game.winlist2, game.winlist3
Lists of game winners.
.TP
.B /var/run/tetrinetx/game.pid
PID file for the daemon is normally stored here, although this can be
changed in \fBgame.conf\fP\&. The PID file is deleted when \fBtetrinetx\fP
exits normally (including being killed with \fBSIGTERM\fP).
The init script doesn\(aqt actually use the PID file.
.UNINDENT
.SH NETWORK
.sp
\fBtetrinetx\fP uses the following TCP ports:
.INDENT 0.0
.TP
.B 31457
Standard port used for tetrinet clients.
.TP
.B 31456
Query service. Supposedly can be connected to with a standard IRC client.
See:
.INDENT 7.0
.INDENT 3.5
/usr/doc/tetrinetx\-1.13.16+qirc_1.40c_15/README.qirc.spectators
.UNINDENT
.UNINDENT
.TP
.B 31458
"Playback" port, used for connecting as a spectator. \fBtetrinetx\fP must
have a \fIquery_password\fP set in \fB/etc/tetrinetx/game.secure\fP to enable
spectator connections.
.UNINDENT
.SH LIMITATIONS
.sp
\fBtetrinetx\fP can only be compiled for \fIeither\fP IPv4 \fIor\fP IPv6
support, not both. The SlackBuilds.org build allows choosing this at
build time.
.SH COPYRIGHT
.sp
See the file /usr/doc/tetrinetx\-1.13.16+qirc_1.40c_15/COPYING for license information.
.SH AUTHORS
.sp
\fBtetrinetx\fP was written by Brendan Grieve and Roongroj Phoophuangpairoj.
.sp
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH SEE ALSO
.sp
\fBgtetrinet\fP(6)
.sp
The tetrinetx homepage: \fI\%https://tetrinetx.sourceforge.net/\fP
.\" Generated by docutils manpage writer.
.