diff options
Diffstat (limited to 'games/tetrinetx/tetrinetx.6')
| -rw-r--r-- | games/tetrinetx/tetrinetx.6 | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/games/tetrinetx/tetrinetx.6 b/games/tetrinetx/tetrinetx.6 new file mode 100644 index 0000000000..ca9d10f74d --- /dev/null +++ b/games/tetrinetx/tetrinetx.6 @@ -0,0 +1,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. +. |