wesnoth/doc/man/en_GB/wesnoth.6

.\" 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 WESNOTH 6 2006 wesnoth "Battle for Wesnoth"
.
.SH NAME
wesnoth \- Battle for Wesnoth, a turn\-based fantasy strategy game
.
.SH SYNOPSIS
.
\fBwesnoth\fP [\fIOPTIONS\fP] [\fIPATH_TO_DATA\fP]
.
.SH DESCRIPTION
.
Battle for \fBWesnoth\fP is a turn\-based fantasy strategy game.

Defeat all enemy leaders using a well\-chosen cadre of troops, taking care to 
manage your resources of gold and villages. All units have their own 
strengths and weaknesses; to win, deploy your forces to their best advantage 
while denying your foes the chance to do the same. As units gain experience, 
they acquire new abilities and become more powerful. Play in your own 
language and test your skill against a smart computer opponent, or join 
Wesnoth's large community of on\-line players. Create your own custom units, 
scenarios or campaigns, and share them with others.
.
.SH OPTIONS
.
.TP 
\fB\-\-bpp\fP\fI\ number\fP
sets BitsPerPixel value. Example: \-\-bpp 32
.TP 
\fB\-\-compress\fP\fI\ <infile>\fP\fB\ \fP\fI<outfile>\fP
compresses a savefile (infile) that is in text WML format into binary WML 
format (outfile).
.TP 
\fB\-d\fP, \fB\-\-debug\fP
shows extra debugging information and enables additional command mode 
options in\-game (see the Wiki at http://www.wesnoth.org/ for more 
information about command mode).
.TP 
\fB\-\-decompress\fP\fI\ <infile>\fP\fB\ \fP\fI<outfile>\fP
decompresses a savefile (infile) that is in binary WML format into text WML 
format (outfile).
.TP 
\fB\-f\fP, \fB\-\-fullscreen\fP
runs the game in full screen mode.
.TP 
\fB\-\-fps\fP
displays the number of frames per second the game is currently running at, 
in a corner of the screen.
.TP 
\fB\-h\fP, \fB\-\-help\fP
displays a summary of command line options to standard output, and exits.
.TP 
\fB\-\-load\fP\fI\ savegame\fP
loads the file savegame from the standard save game directory.
.TP 
\fB\-\-log\-error="domain1,domain2,..."\fP, \fB\-\-log\-warning="..."\fP, \fB\-\-log\-info="..."\fP
sets the severity level of the debug domains. "all" can be used to match any 
debug domain.  \fB\-\-log\-info\fP shows all messages, \fB\-\-log\-warning\fP only 
warnings and errors, and \fB\-\-log\-error\fP just errors.
.TP 
\fB\-\-multiplayer\fP
runs a multiplayer game. There are additional options that can be used 
together with \fB\-\-multiplayer\fP as explained below.
.TP 
\fB\-\-nocache\fP
disables caching of game data.
.TP 
\fB\-\-nosound\fP
runs the game without sounds and music.
.TP 
\fB\-\-path\fP
prints the name of the game data directory and exits.
.TP 
\fB\-r\fP, \fB\-\-resolution\fP\ \fIXxY\fP
sets the screen resolution. Example: \-r 800x600
.TP 
\fB\-t\fP, \fB\-\-test\fP
runs the game in a small test scenario.
.TP 
\fB\-v\fP, \fB\-\-version\fP
shows the version number and exits.
.TP 
\fB\-w\fP, \fB\-\-windowed\fP
runs the game in windowed mode.
.TP 
\fB\-\-no\-delay\fP
runs the game without any delays for graphic benchmarking.  This is 
automatically enabled by \-\-nogui.
.TP 
\fB\-\-exit\-at\-end\fP
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> 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 
\fB\-\-algorithm<number>=value\fP
selects a non\-standard algorithm to be used by the AI controller for this 
side. Available values: "idle_ai" and "sample_ai".
.TP  
\fB\-\-controller<number>=value\fP
selects the controller for this side. Available values: "human" and "ai".
.TP  
\fB\-\-era=value\fP
use this option to play in the selected era instead of the "Default" 
era. The era is chosen by an id. Eras are described in the 
data/multiplayer.cfg file.
.TP 
\fB\-\-nogui\fP
runs the game without the GUI. Must appear before \fB\-\-multiplayer\fP to have 
the desired effect.
.TP 
\fB\-\-parm<number>=name:value\fP
sets additional parameters for this side. This parameter depends on the 
options used with \fB\-\-controller\fP and \fB\-\-algorithm.\fP It should only be 
useful for people designing their own AI. (not yet documented completely)
.TP 
\fB\-\-scenario=value\fP
selects a multiplayer scenario. The default scenario is 
"multiplayer_Charge".
.TP 
\fB\-\-side<number>=value\fP
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 
\fB\-\-turns=value\fP
sets the number of turns for the chosen scenario. The default is "50".
.TP 
Example to test your own AI: 
wesnoth \-\-multiplayer \-\-controller2=python_ai \-\-algorithm2=python_ai 
\-\-parm2=python_script:py/my_own_python_ai.py \-\-side2=Rebels
.
.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>.
.br
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>
.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_editor\fP(6), \fBwesnothd\fP(6)