.\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program; if not, write to the Free Software .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .\" . .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .TH WESNOTHD 6 2022 wesnothd "Battle for Wesnoth multiplayer network daemon" . .SH NAME . wesnothd \- Battle for \fBWesnoth\fP multiplayer network daemon . .SH SYNOPSIS . \fBwesnothd\fP [\|\fB\-dvw\fP\|] [\|\fB\-c\fP \fIpath\fP\|] [\|\fB\-p\fP \fIport\fP\|] .br \fBwesnothd\fP \fB\-V\fP . .SH DESCRIPTION . Manages Battle for Wesnoth multiplayer games. See https://www.wesnoth.org/wiki/ServerAdministration on what commands the server accepts via the wesnoth client (/query ...) or the fifo. . .SH OPTIONS . .TP \fB\-c\ \fP\fIpath\fP\fB,\ \-\-config\fP\fI\ path\fP tells wesnothd where to find the config file to use. See the section \fBSERVER CONFIG\fP below for the syntax. You can reload the config with sending SIGHUP to the server process. .TP \fB\-d, \-\-daemon\fP runs wesnothd as a daemon. .TP \fB\-h, \-\-help\fP tells you what the command line options do. .TP \fB\-\-log\-\fP\fIlevel\fP\fB=\fP\fIdomain1\fP\fB,\fP\fIdomain2\fP\fB,\fP\fI...\fP sets the severity level of the log domains. \fBall\fP can be used to match any log domain. Available levels: \fBerror\fP,\ \fBwarning\fP,\ \fBinfo\fP,\ \fBdebug\fP. By default the \fBerror\fP level is used and the \fBinfo\fP level for the \fBserver\fP domain. .TP \fB\-p\ \fP\fIport\fP\fB,\ \-\-port\fP\fI\ port\fP binds the server to the specified port. If no port is specified, port \fB15000\fP will be used. .TP \fB\-V, \-\-version\fP shows version number and exits. .TP \fB\-v, \-\-verbose\fP turns debug logging on. . .SH "SERVER CONFIG" . .SS "The general syntax is:" . .P [\fItag\fP] .IP \fIkey\fP="\fIvalue\fP" .IP \fIkey\fP="\fIvalue\fP,\fIvalue\fP,..." .P [/\fItag\fP] . .SS "Global keys:" . .TP \fBallow_remote_shutdown\fP If set to \fBno\fP (default), shut_down and restart requests are ignored unless they come from the fifo. Set it to \fByes\fP to allow remote shutdown via a /query by an administrator. .TP \fBban_save_file\fP Full or relative path to a (gzip compressed) file that the server can read and write. Bans will be saved to this file and read again on server start. .TP \fBconnections_allowed\fP The number of allowed connections from the same IP. \fB0\fP means infinite. (default: \fB5\fP) .TP \fBdeny_unregistered_login\fP Whether to prevent users who are not registered with the \fBuser_handler\fP being used from logging in. (default: false) .TP \fBdisallow_names\fP Names/nicks that are not accepted by the server. \fB*\fP and \fB?\fP from wild\-card patterns are supported. See \fBglob\fP(7) for more details. Default values (used if nothing is specified) are: \fB*admin*,*admln*,*moderator*,*server*,ai,ai?,computer,human,network,player\fP. .TP \fBfifo_path\fP The path to the fifo you can echo server commands into (same as /query \&... from wesnoth). The compile\-time path is used by default if it is not specified (default: \fB/var/run/wesnothd/socket\fP). .TP \fBid\fP The ID of the server when using the database functionality to store game information. Generally is the major.minor version of accepted clients, such as 1.16 or 1.17. .TP \fBmax_messages\fP The number of allowed messages in \fBmessages_time_period\fP. (default: \fB4\fP) .TP \fBmessages_time_period\fP The time period (in seconds) message flooding is detected in. (default: \fB10\fP seconds) .TP \fBmotd\fP The message of the day. .TP \fBpasswd\fP The password used to gain admin privileges (via \fB/query admin \fP\fIpassword\fP). .TP \fBreplay_save_path\fP The directory where the server stores game replays. (Don't forget the trailing /!) It is set to `' by default, which means the directory wesnothd was started in. .TP \fBrestart_command\fP The command that the server uses to start a new server process via the \fBrestart\fP command. (Can only be issued via the fifo. See the \fBallow_remote_shutdown\fP setting.) .TP \fBsave_replays\fP Defines whether the server will automatically save replays of games. (default: \fBfalse\fP) .TP \fBtls_enabled\fP Enable use of TLS. If true, requires 3 following options to be set too. .TP \fBtls_fullchain\fP TLS full certificate chain in .pem format .TP \fBtls_private_key\fP private key for TLS in .pem format .TP \fBtls_dh\fP TLS DH parameters, as .pem file. Generate with \fBopenssl dhparam \-out filename.pem 4096\fP .TP \fBversions_accepted\fP A comma separated list of version strings to be accepted by the server. \fB*\fP and \fB?\fP from wild\-card patterns are supported. (default is the corresponding wesnoth version) .br Example: \fBversions_accepted="*"\fP accepts any version string. . .SS "Global tags:" . .P \fB[redirect]\fP A tag to specify a server to redirect certain client versions to. Is not used if \fBversions_accepted\fP is not set. .RS .TP \fBhost\fP The address of the server to redirect to. .TP \fBport\fP The port to connect to. .TP \fBversion\fP A comma separated list of versions to redirect. Behaves the same way as \fBversions_accepted\fP in regard to wild\-card patterns. .RE .P \fB[ban_time]\fP A tag to define convenient keywords for temporary ban time lengths. .RS .TP \fBname\fP The name used to reference the ban time. .TP \fBtime\fP The time length definition. The format is: %d[%s[%d%s[...]]] where %s is s (seconds), m (minutes), h (hours), D (days), M (months) or Y (years) and %d is a number. If no time modifier is given minutes (m) are assumed. Example: \fBtime="1D12h30m"\fP results in a ban time of 1 day, 12 hours and 30 minutes. .RE .P \fB[proxy]\fP A tag to tell the server to act as a proxy and forward the connected client's requests to the specified server. Accepts the same keys as \fB[redirect]\fP. .RE .P \fB[user_handler]\fP Configures the user handler. If no \fB[user_handler]\fP section is present in the configuration the server will run without any nick registration service. All additional tables that are needed for the \fBforum_user_handler\fP to function can be found in table_definitions.sql in the Wesnoth source repository. Requires mysql support enabled. For cmake this is \fBENABLE_MYSQL\fP and for scons this is \fBforum_user_handler.\fP .RS .TP \fBdb_host\fP The host name of the database server .TP \fBdb_name\fP The name of the database .TP \fBdb_user\fP The name of the user under which to log into the database .TP \fBdb_password\fP This user's password .TP \fBdb_users_table\fP The name of the table in which your phpbb forum saves its user data. Most likely this will be _users (e.g. phpbb3_users). .TP \fBdb_extra_table\fP The name of the table in which wesnothd will save its own data about users. .TP \fBdb_game_info_table\fP The name of the table in which wesnothd will save its own data about games. .TP \fBdb_game_player_info_table\fP The name of the table in which wesnothd will save its own data about the players in a game. .TP \fBdb_game_content_info_table\fP The name of the table in which wesnothd will save its own data about game content (scenario/era/modifications) used in a game. .TP \fBdb_user_group_table\fP The name of the table in which your phpbb forum saves its user group data. Most likely this will be _user_group (e.g. phpbb3_user_group). .TP \fBdb_tournament_query\fP The SQL query to find tournaments to announce on log\-in. Should return tournament \fBtitle\fP, \fBstatus\fP and \fBurl\fP. .TP \fBdb_connection_history_table\fP The name of the table in which to store log\-in/log\-out times. Also used for matching IPs to users and vice versa. .TP \fBdb_topics_table\fP The name of the table in which your phpbb forum saves its topic (thread) information. Most likely this will be _topics (e.g. phpbb3_topics). .TP \fBdb_banlist_table\fP The name of the table in which your phpbb forum saves its user bans data. Most likely this will be _banlist (e.g. phpbb3_banlist). .TP \fBmp_mod_group\fP The ID of the forum group to be considered as having moderation authority. .RE . .SH "EXIT STATUS" . Normal exit status is 0 when the server was properly shutdown. An exit status of 2 indicates an error with the command line options. . .SH AUTHOR . Written by David White . Edited by Nils Kneuper , ott , Soliton and Thomas Baumhauer . This manual page was originally written by Cyril Bouthors . .br Visit the official homepage: https://www.wesnoth.org/ . .SH COPYRIGHT . Copyright \(co 2003\-2024 David White .br This is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. . .SH "SEE ALSO" . \fBwesnoth\fP(6)