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

*update and streamline the usage and manpage documentation

Browse source
This commit is contained in:
Gunter Labes 2007-12-10 03:22:10 +00:00
parent 936de5ea3f
commit 2576f8a3d5
4 changed files with 134 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

129
doc/man/wesnoth.6
View file

@ -13,7 +13,7 @@
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\"
.
.TH WESNOTH 6 "2006" "wesnoth" "Battle for Wesnoth"
.TH WESNOTH 6 "2007" "wesnoth" "Battle for Wesnoth"
.
.SH NAME
wesnoth \- Battle for Wesnoth, a turn-based fantasy strategy game
@ -44,52 +44,67 @@ campaigns, and share them with others.
.
.TP
.BI --bpp \ number
sets BitsPerPixel value. Example: --bpp 32
sets BitsPerPixel value. Example:
.B --bpp 32
.TP
.BI --compress \ <infile> \ <outfile>
compresses a savefile (infile) that is in text WML format into binary WML format (outfile).
.BI --compress \ infile\ outfile
compresses a savefile
.RI ( infile )
that is in text WML format into binary WML format
.RI ( outfile ).
.TP
.BR -d ", " --debug
.B -d, --debug
shows extra debugging information and enables additional command mode
options in-game (see the Wiki at http://www.wesnoth.org/ for more
options in-game (see the Wiki at http://wiki.wesnoth.org/ for more
information about command mode).
.TP
.BI --decompress \ <infile> \ <outfile>
decompresses a savefile (infile) that is in binary WML format into text
WML format (outfile).
.BI --decompress \ infile\ outfile
decompresses a savefile
.RI ( infile )
that is in binary WML format into text WML format
.RI ( outfile ).
.TP
.BR -f ", " --fullscreen
.B -f, --fullscreen
runs the game in full screen mode.
.TP
.B --fps
displays the number of frames per second the game is currently running
at, in a corner of the screen.
.TP
.BI --gunzip \ <infile>
decompresses a savefile which should be a .gz file (infile) and stores it
without the .gz suffix. The (infile) will be removed.
.BI --gunzip \ infile.gz
decompresses a file which should be in gzip format and stores it
without the .gz suffix. The
.I infile.gz
will be removed.
.TP
.BI --gzip \ <infile>
compresses a savefile (infile) as gzip file and stores it as (infile.gz)
and removes (infile).
.BI --gzip \ infile
compresses a file in gzip format, stores it as
.IR infile .gz
and removes
.IR infile .
.TP
.BR -h ", " --help
.B -h, --help
displays a summary of command line options to standard output, and exits.
.TP
.BI --load \ <savegame>
.BI --load \ savegame
loads the file savegame from the standard save game directory.
.TP
.BR --log-<level>="domain1,domain2,..."
sets the severity level of the debug domains. "all" can be used to match
any debug domain. Available levels: error, warning, info, debug. By default the
error level is used.
.BI --log- level = domain1 , domain2 , ...
sets the severity level of the log domains.
.B all
can be used to match any log domain. Available levels:
.BR error ,\ warning ,\ info ,\ debug .
By default the
.B error
level is used.
.TP
.B --logdomains
Dumps a list of all log domains and exits.
.TP
.BR --max-fps
.B --max-fps
the number of frames per second the game can show, the value should be between
the 1 and 1000, the default is 50.
the 1 and 1000, the default is
.BR 50 .
.TP
.B --multiplayer
runs a multiplayer game. There are additional options that can be used
@ -106,75 +121,89 @@ runs the game without sounds and music.
.B --path
prints the name of the game data directory and exits.
.TP
.BR -r ", " --resolution \ \fIXxY\fR
sets the screen resolution. Example: -r 800x600
.BI -r\ X x Y ,\ --resolution\ X x Y
sets the screen resolution. Example:
.B -r 800x600
.TP
.BR -t ", " --test
.B -t, --test
runs the game in a small test scenario.
.TP
.BR -v ", " --version
.B -v, --version
shows the version number and exits.
.TP
.BR -w ", " --windowed
.B -w, --windowed
runs the game in windowed mode.
.TP
.BR --no-delay
runs the game without any delays for graphic benchmarking. This is automatically enabled by --nogui.
.B --no-delay
runs the game without any delays for graphic benchmarking. This is automatically enabled by
.BR --nogui .
.TP
.B --nogui
runs the game without the GUI. Must appear before
.B --multiplayer
to have the desired effect.
.TP
.BR --exit-at-end
.B --exit-at-end
exits once the scenario is over, without displaying victory/defeat dialog which requires the user to click OK. This is also used for scriptable benchmarking.
.
.SH Options for --multiplayer
.
The side-specific multiplayer options are marked with <number>. <number>
The side-specific multiplayer options are marked with
.IR number .
.I number
has to be replaced by a side number. It usually is 1 or 2 but depends on
the number of players possible in the chosen scenario.
.TP
.B --algorithm<number>=value
.BI --algorithm number = value
selects a non-standard algorithm to be used by the AI controller for
this side. Available values: "idle_ai" and "sample_ai".
this side. Available values:
.B idle_ai
and
.BR sample_ai .
.TP
.B --controller<number>=value
selects the controller for this side. Available values: "human" and "ai".
.BI --controller number = value
selects the controller for this side. Available values:
.B human
and
.BR ai .
.TP
.B --era=value
use this option to play in the selected era instead of the "Default"
.BI --era= value
use this option to play in the selected era instead of the
.B Default
era. The era is chosen by an id. Eras are described in the
data/multiplayer.cfg file.
.B "data/multiplayer/eras.cfg"
file.
.TP
.B --parm<number>=name:value
.BI --parm number = name : value
sets additional parameters for this side. This parameter depends on the
options used with
.B --controller
and
.B --algorithm.
.BR --algorithm .
It should only be useful for people designing their own AI. (not yet
documented completely)
.TP
.B --scenario=value
selects a multiplayer scenario. The default scenario is "multiplayer_The_Freelands".
.BI --scenario= value
selects a multiplayer scenario by id. The default scenario id is
.BR multiplayer_The_Freelands .
.TP
.B --side<number>=value
.BI --side number = value
selects a faction of the current era for this side. The faction is
chosen by an id. Factions are described in the data/multiplayer.cfg
file.
.TP
.B --turns=value
sets the number of turns for the chosen scenario. The default is "50".
.BI --turns= value
sets the number of turns for the chosen scenario. The default is
.BR 50 .
.TP
Example to test your own AI against the default AI without starting the GUI:
wesnoth --nogui --multiplayer --controller1=ai --controller2=ai --algorithm2=python_ai --parm2=python_script:py/my_own_python_ai.py
.B wesnoth --nogui --multiplayer --controller1=ai --controller2=ai --algorithm2=python_ai --parm2=python_script:py/my_own_python_ai.py
.
.SH AUTHOR
.
Written by David White <davidnwhite@verizon.net>.
.br
Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and Soliton <soliton@sonnenkinder.org>.
Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and Soliton <soliton.de@gmail.com>.
.br
This manual page was originally written by Cyril Bouthors <cyril@bouthors.org>.
.br
@ -182,7 +211,7 @@ Visit the official homepage: http://www.wesnoth.org/
.
.SH COPYRIGHT
.
Copyright \(co 2003-2006 David White <davidnwhite@verizon.net>
Copyright \(co 2003-2007 David White <davidnwhite@verizon.net>
.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.

74
doc/man/wesnothd.6
View file

@ -13,7 +13,7 @@
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\"
.
.TH WESNOTHD 6 "2006" "wesnothd" "Battle for Wesnoth multiplayer network daemon"
.TH WESNOTHD 6 "2007" "wesnothd" "Battle for Wesnoth multiplayer network daemon"
.
.SH NAME
.
@ -24,7 +24,7 @@ multiplayer network daemon
.SH SYNOPSIS
.
.B wesnothd
.RB [\| \-dvV \|]
.RB [\| \-dv \|]
.RB [\| \-c
.IR path \|]
.RB [\| \-p
@ -33,6 +33,9 @@ multiplayer network daemon
.IR number \|]
.RB [\| \-T
.IR number \|]
.br
.B wesnothd
.B \-V
.
.SH DESCRIPTION
.
@ -42,37 +45,52 @@ on what commands the server accepts via the wesnoth client or the socket.
.SH OPTIONS
.
.TP
.BI -c,\ --config \ path
.BI -c\ path ,\ --config \ path
tells wesnothd where to find the config file to use. See the section
.B SERVER CONFIG
below for the syntax. You can reload the config with sending SIGHUP to the server process.
.TP
.B -d,\ --daemon
.B -d, --daemon
runs wesnothd as a daemon.
.TP
.B -h,\ --help
.B -h, --help
tells you what the command line options do.
.TP
.BR --log-<level>="domain1,domain2,..."
sets the severity level of the debug domains. "all" can be used to match
any debug domain. Available levels: error, warning, info, debug.
.BI --log- level = domain1 , domain2 , ...
sets the severity level of the log domains.
.B all
can be used to match
any log domain. Available levels:
.BR error ,\ warning ,\ info ,\ debug .
By default the
.B error
level is used and the
.B info
level for the
.B server
domain.
.TP
.BI -p,\ --port \ port
.BI -p\ port ,\ --port \ port
binds the server to the specified port. If no port is specified, port
15000 will be used.
.B 15000
will be used.
.TP
.BI -t,\ --threads \ number
sets the maximum number of waiting worker threads for network I/O to n (default: 5, max: 30).
.BI -t\ number ,\ --threads \ number
sets the maximum number of waiting worker threads for network I/O to n (default:
.BR 5 ,\ max:\ 30 ).
.TP
.BI -T,\ --max-threads \ number
sets the maximum number of worker threads that will be created
if set to 0 there will be no limit (default: 0).
.BI -T\ number ,\ --max-threads \ number
sets the maximum number of worker threads that will be created.
If set to
.B 0
there will be no limit (default:
.BR 0 ).
.TP
.B -V,\ --version
.B -V, --version
shows version number and exits.
.TP
.B -v,\ --verbose
turns on more verbose logging.
.B -v, --verbose
turns debug logging on.
.
.SH SERVER CONFIG
.
@ -91,31 +109,32 @@ key="\fIvalue\fR,\fIvalue\fR,..."
.
.TP
.B connections_allowed
The number of allowed connections from the same IP. (default: 5)
The number of allowed connections from the same IP. (default: \fB5\fR)
.TP
.B disallow_names
Names/nicks that are not accepted by the server. `*' and `?' from wildcard patterns are supported. See
.BR glob (7)
for more details.
Default values (used if nothing is specified) are: `*admin*,*admln*,*server*,ai,ai?,computer,human,network,player'.
Default values (used if nothing is specified) are:
.BR *admin*,*admln*,*server*,ai,ai?,computer,human,network,player .
.TP
.B max_messages
The number of allowed messages in \fBmessages_time_period\fR. (default: 4)
The number of allowed messages in \fBmessages_time_period\fR. (default: \fB4\fR)
.TP
.B messages_time_period
The time period (in seconds) message flooding is detected in. (default: 10 seconds)
The time period (in seconds) message flooding is detected in. (default: \fB10\fR seconds)
.TP
.B motd
The message of the day.
.TP
.B passwd
The password used to gain admin privileges. Usually it starts with "admin ".
The password used to gain admin privileges. Usually it starts with `admin '.
.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)
.br
Example: versions_accepted="*" accepts any version string.
Example: \fBversions_accepted="*"\fR accepts any version string.
.
.SS "Global tags:"
.
@ -138,19 +157,20 @@ in regard to wildcard patterns.
.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 [redirect].
Accepts the same keys as
.BR [redirect] .
.
.SH AUTHOR
.
Written by David White <davidnwhite@verizon.net>.
Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and Soliton <soliton@sonnenkinder.org>.
Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and Soliton <soliton.de@gmail.com>.
This manual page was originally written by Cyril Bouthors <cyril@bouthors.org>.
.br
Visit the official homepage: http://www.wesnoth.org/
.
.SH COPYRIGHT
.
Copyright \(co 2003-2006 David White <davidnwhite@verizon.net>
Copyright \(co 2003-2007 David White <davidnwhite@verizon.net>
.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.

11
src/game.cpp
View file

@ -1877,18 +1877,19 @@ static int play_game(int argc, char** argv)
<< " -f, --fullscreen runs the game in full screen mode.\n"
<< " --fps displays the number of frames per second the game\n"
<< " is currently running at, in a corner of the screen.\n"
<< " --gunzip INFILE.gz decompresses a savefile (INFILE.gz) in gzip format\n"
<< " --gunzip INFILE.gz decompresses a file (INFILE.gz) in gzip format\n"
<< " and stores it without the .gz suffix.\n"
<< " INFILE.gz will be removed.\n"
<< " --gzip INFILE compresses a savefile (INFILE) in gzip format,\n"
<< " --gzip INFILE compresses a file (INFILE) in gzip format,\n"
<< " stores it as INFILE.gz and removes INFILE.\n"
<< " -h, --help prints this message and exits.\n"
<< " --load SAVEGAME loads the file SAVEGAME from the standard save\n"
<< " game directory.\n"
<< " --log-<level>=\"domain1,domain2,...\"\n"
<< " sets the severity level of the debug domains.\n"
<< " \"all\" can be used to match any debug domain.\n"
<< " --log-<level>=<domain1>,<domain2>,...\n"
<< " sets the severity level of the log domains.\n"
<< " 'all' can be used to match any log domain.\n"
<< " Available levels: error, warning, info, debug.\n"
<< " By default the 'error' level is used.\n"
<< " --logdomains List defined log domains and exit.\n"
<< " --nocache disables caching of game data.\n"
<< " --validcache assume that cache is valid (dangerous)\n"

4
src/server/server.cpp
View file

@ -1394,9 +1394,9 @@ int main(int argc, char** argv) {
<< " -c, --config <path> Tells wesnothd where to find the config file to use.\n"
<< " -d, --daemon Runs wesnothd as a daemon.\n"
<< " -h, --help Shows this usage message.\n"
<< " --log-<level>=\"<domain1>,<domain2>,...\"\n"
<< " --log-<level>=<domain1>,<domain2>,...\n"
<< " sets the severity level of the debug domains.\n"
<< " \"all\" can be used to match any debug domain.\n"
<< " 'all' can be used to match any debug domain.\n"
<< " Available levels: error, warning, info, debug.\n"
<< " -p, --port <port> Binds the server to the specified port.\n"
<< " -t, --threads <n> Uses n worker threads for network I/O (default: 5).\n"