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

fixed/unified formatting

Browse source
This commit is contained in:
Gunter Labes 2009-09-27 16:37:30 +00:00
parent 5bb2d9d1b1
commit 639b62283d
1 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
doc/man/wesnothd.6
View file

@ -99,9 +99,9 @@ turns debug logging on.
.P
[\fItag\fR]
.IP
key="\fIvalue\fR"
\fIkey\fR="\fIvalue\fR"
.IP
key="\fIvalue\fR,\fIvalue\fR,..."
\fIkey\fR="\fIvalue\fR,\fIvalue\fR,..."
.P
[/\fItag\fR]
.
@ -109,21 +109,21 @@ key="\fIvalue\fR,\fIvalue\fR,..."
.
.TP
.B allow_remote_shutdown
If set to `no' (default), shut_down and restart requests are ignored unless the come from the fifo.
Set it to `yes' to allow remote shutdown via a /query by an administrator.
If set to \fBno\fR (default), shut_down and restart requests are ignored unless they come from the fifo.
Set it to \fByes\fR to allow remote shutdown via a /query by an administrator.
.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 compress_stored_rooms
Determines whether the rooms file should be read and written to in compressed form. Defaults to `yes'.
Determines whether the rooms file should be read and written to in compressed form. Defaults to \fByes\fR.
.TP
.B connections_allowed
The number of allowed connections from the same IP. \fB0\fR means infinite. (default: \fB5\fR)
.TP
.B disallow_names
Names/nicks that are not accepted by the server. `*' and `?' from wildcard patterns are supported. See
Names/nicks that are not accepted by the server. \fB*\fR and \fB?\fR from wildcard patterns are supported. See
.BR glob (7)
for more details.
Default values (used if nothing is specified) are:
@ -131,7 +131,7 @@ Default values (used if nothing is specified) are:
.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).
If not specified defaults to the compile-time path (default: \fB/var/run/socket/wesnothd/socket\fR).
.TP
.B max_messages
The number of allowed messages in \fBmessages_time_period\fR. (default: \fB4\fR)
@ -143,16 +143,16 @@ The time period (in seconds) message flooding is detected in. (default: \fB10\fR
The message of the day.
.TP
.B new_room_policy
Determines who can create new rooms on the server. Available values are `everyone', `registered', `admin' and `nobody', and give the permission respectively to everyone, registered users, admin users or disables new room creation. Default value is `everyone'.
Determines who can create new rooms on the server. Available values are \fBeveryone\fR, \fBregistered\fR, \fBadmin\fR and \fBnobody\fR, and give the permission respectively to everyone, registered users, admin users or disables new room creation. Default value is \fBeveryone\fR.
.TP
.B passwd
The password used to gain admin privileges. Usually it starts with `admin '.
The password used to gain admin privileges (via \fB/query admin \fIpassword\fR).
.TP
.B replay_save_path
The directory where the server stores game replays. (Don't forget the trailing /!) Defaults to `' which means the directory wesnothd was started in.
.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.)
The command that the server uses to start a new server process via the \fBrestart\fR command. (Can only be issued via the fifo. See the \fBallow_remote_shutdown\fR setting.)
.TP
.B room_save_file
Path to a file where the room info should be stored. This file is read on server startup and written to later. If empty or not set, rooms are not loaded and not saved.
@ -161,13 +161,13 @@ Path to a file where the room info should be stored. This file is read on server
Defines whether the server will automatically save replays of games. (default: \fBfalse\fR)
.TP
.B versions_accepted
A comma separated list of version strings to be accepted by the server. `*' and `?' from wildcard patterns are supported.
A comma separated list of version strings to be accepted by the server. \fB*\fR and \fB?\fR from wildcard patterns are supported.
(defaults to the corresponding wesnoth version)
.br
Example: \fBversions_accepted="*"\fR accepts any version string.
.TP
.B user_handler
The name of the user handler to use. Currently available user handlers are 'forum' (to connect wesnothd to a phpbb forum database) and 'sample' (a sample implementation of the user handler interface, if you use this on anything real you are insane). The default value is 'forum'. You must also add a
The name of the user handler to use. Currently available user handlers are \fBforum\fR (to connect wesnothd to a phpbb forum database) and \fBsample\fR (a sample implementation of the user handler interface, if you use this on anything real you are insane). The default value is \fBforum\fR. You must also add a
.B [user_handler]
section, see below.
.
@ -201,7 +201,9 @@ The name used to reference the ban 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.
Example:
.B time="1D12h30m"
results in a ban time of 1 day, 12 hours and 30 minutes.
.RE
.P
.B [proxy]
@ -213,7 +215,9 @@ Accepts the same keys as
.B [user_handler]
Configures the user handler. Available keys vary depending on which user handler is set with the
.B user_handler
key. If no [user_handler] section is present in the configuration the server will run without any nick registration service.
key. If no
.B [user_handler]
section is present in the configuration the server will run without any nick registration service.
.RS
.TP
.B db_host
@ -233,7 +237,7 @@ key. If no [user_handler] section is present in the configuration the server wil
.TP
.B db_extra_table
(for user_handler=forum) The name of the table in which wesnothd will save its own data about users. You will have to create this table manually, e.g.:
CREATE TABLE <table-name>(username VARCHAR(255) PRIMARY KEY, user_lastvisit INT UNSIGNED NOT NULL DEFAULT 0, user_is_moderator TINYINT(4) NOT NULL DEFAULT 0);
.B CREATE TABLE <table-name>(username VARCHAR(255) PRIMARY KEY, user_lastvisit INT UNSIGNED NOT NULL DEFAULT 0, user_is_moderator TINYINT(4) NOT NULL DEFAULT 0);
.TP
.B user_expiration
(for user_handler=sample) The time after which a registered nick expires (in days).