0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

documented the new 'fifo_path' config key

Browse source 
more documentations updates
This commit is contained in:
Gunter Labes 2008-09-04 18:17:21 +00:00
parent e813240e4b
commit fcdaed7aa7
1 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/man/wesnothd.6
View file

@ -40,7 +40,7 @@ multiplayer network daemon
.SH DESCRIPTION
.
Manages Battle for Wesnoth multiplayer games. See http://www.wesnoth.org/wiki/ServerAdministration
on what commands the server accepts via the wesnoth client or the socket.
on what commands the server accepts via the wesnoth client (/query ...) or the fifo.
.
.SH OPTIONS
.
@ -108,6 +108,10 @@ key="\fIvalue\fR,\fIvalue\fR,..."
.SS "Global keys:"
.
.TP
.B ban_save_file
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
.B connections_allowed
The number of allowed connections from the same IP. \fB0\fR means infinite. (default: \fB5\fR)
.TP
@ -118,6 +122,10 @@ for more details.
Default values (used if nothing is specified) are:
.BR *admin*,*admln*,*server*,ai,ai?,computer,human,network,player .
.TP
.B fifo_path
The path to the fifo you can echo server commands into (same as /query ... from wesnoth).
If not specified defaults to the compile-time specified path (default: /var/run/socket/wesnothd/socket).
.TP
.B max_messages
The number of allowed messages in \fBmessages_time_period\fR. (default: \fB4\fR)
.TP
@ -130,6 +138,9 @@ The message of the day.
.B passwd
The password used to gain admin privileges. Usually it starts with `admin '.
.TP
.B restart_command
The command that the server uses to start a new server process via the `restart' command. (Can only be issued via the fifo.)
.TP
.B versions_accepted
A comma separated list of version strings to be accepted by the server. `*' and `?' from wildcard patterns are supported.
(defaults to the corresponding wesnoth version)
@ -155,6 +166,20 @@ A comma separated list of versions to redirect. Behaves the same way as
in regard to wildcard patterns.
.RE
.P
.B [ban_time]
A tag to define convenient keywords for temporary ban time lengths.
.RS
.TP
.B name
The name used to reference the ban time.
.TP
.B time
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: time="1D12h30m" results in a ban time of 1 day, 12 hours and 30 minutes.
.RE
.P
.B [proxy]
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