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 2013 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 online players. Create your own custom units,
scenarios or campaigns, and share them with others.
.
.SH OPTIONS
.
.TP 
\fB\-\-bunzip\fP\fI\ infile.gz\fP
decompresses a file which should be in bzip2 format and stores it without
the .bz2 suffix. The \fIinfile.bz2\fP will be removed.
.TP 
\fB\-\-bzip\fP\fI\ infile\fP
compresses a file in bzip2 format, stores it as \fIinfile\fP.bz2 and removes
\fIinfile\fP.
.TP 
\fB\-c,\ \-\-campaign\ [\fP\fIid_campaign\fP\fB]\fP
goes directly to the campaign with id <id_campaign>. A selection
menu will appear if no id was specified.
.TP 
\fB\-\-core\fP\fI\ id_core\fP
overrides the loaded core with the one whose id is specified.
.TP 
\fB\-\-campaign\-difficulty\ [\fP\fIdifficulty\fP\fB]\fP
The difficulty of the specified campaign (1 to max). If none specified, the
campaign difficulty selection widget will appear.
.TP 
\fB\-\-campaign\-scenario\fP\fI\ id_scenario\fP
The id of the scenario from the specified campaign. The default is the first
scenario.
.TP 
\fB\-\-data\-dir\fP\fI\ directory\fP
overrides the data directory with the one specified
.TP 
\fB\-\-data\-path\fP
print the path of the data directory and exits.
.TP 
\fB\-d, \-\-debug\fP
enables additional command mode options in\-game (see the wiki page at
http://www.wesnoth.org/wiki/CommandMode for more information about command
mode).
.TP 
\fB\-e,\ \-\-editor\fP\fI\ file\fP
start the in\-game map editor directly. If \fIfile\fP is specified, equivalent
to \fB\-l \-\-load\fP
.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\-f, \-\-fullscreen\fP
runs the game in full screen mode.
.TP 
\fB\-\-gunzip\fP\fI\ infile.gz\fP
decompresses a file which should be in gzip format and stores it without the
\&.gz suffix. The \fIinfile.gz\fP will be removed.
.TP 
\fB\-\-gzip\fP\fI\ infile\fP
compresses a file in gzip format, stores it as \fIinfile\fP.gz and removes
\fIinfile\fP.
.TP 
\fB\-h, \-\-help\fP
displays a summary of command line options to standard output, and exits.
.TP 
\fB\-l,\ \-\-load\fP\fI\ file\fP
loads the savegame \fIfile\fP from the standard save game directory.  If the
\fB\-e\fP or \fB\-\-editor\fP option is used as well, starts the editor with the map
from \fIfile\fP open. If it is a directory, the editor will start with a load
map dialog opened there.
.TP 
\fB\-L,\ \-\-language\fP\fI\ lang\fP
uses language \fIlang\fP (symbol) this session.  Example: \fB\-\-language
ang_GB@latin\fP
.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.
.TP 
\fB\-\-log\-precise\fP
shows the timestamps in the logfile with more precision.
.TP 
\fB\-\-log\-strict\fP
sets the strict level of the logger. Any messages sent to log domains of
this level or more severe will cause the unit test to fail regardless of the
victory result. Only relevant when used with \fB\-u\fP.
.TP 
\fB\-\-logdomains\ [\fP\fIfilter\fP\fB]\fP
lists defined log domains (only the ones containing \fBfilter\fP if used) and
exits
.TP 
\fB\-\-max\-fps\fP\fI\ fps\fP
the number of frames per second the game can show, the value should be
between the 1 and 1000, the default is \fB50\fP.
.TP 
\fB\-m, \-\-multiplayer\fP
runs a multiplayer game. There are additional options that can be used
together with \fB\-\-multiplayer\fP as explained below.
.TP 
\fB\-\-mp\-test\fP
load the test mp scenarios.
.TP 
\fB\-\-no\-delay\fP
runs the game without any delays for graphic benchmarking.  This is
automatically enabled by \fB\-\-nogui\fP.
.TP 
\fB\-\-noaddons\fP
disables loading of user add\-ons.
.TP 
\fB\-\-nocache\fP
disables caching of game data.
.TP 
\fB\-\-nogui\fP
runs the game without the GUI.
.TP 
\fB\-\-nomusic\fP
runs the game without music.
.TP 
\fB\-\-noreplaycheck\fP
don't try to validate replay of unit test. Only relevant when used with
\fB\-u\fP.
.TP 
\fB\-\-nosound\fP
runs the game without sounds and music.
.TP 
\fB\-\-password\fP\fI\ password\fP
uses <password> when connecting to a server, ignoring other
preferences. Unsafe.
.TP 
\fB\-\-path\fP
prints the name of the game data directory and exits.
.TP 
\fB\-p,\ \-\-preprocess\fP\fI\ source\-file/folder\fP\fB\ \fP\fItarget\-directory\fP
preprocesses a specified file/folder. For each file, a plain .cfg file and a
processed .cfg file will be written in the specified target directory. If a
folder is specified, it will be preprocessed recursively based on the known
preprocessor rules. The common macros from the "data/core/macros" directory
will be preprocessed before the specified resources.  Example: \fB\-p
~/wesnoth/data/campaigns/tutorial ~/result.\fP For details regarding the
preprocessor, visit:
http://wiki.wesnoth.org/PreprocessorRef#Command\-line_preprocessor

.TP 
\fB\-\-preprocess\-defines=\fP\fIDEFINE1\fP\fB,\fP\fIDEFINE2\fP\fB,\fP\fIetc\fP
comma\-separated list of defines to be used by the '\-\-preprocess' command. If
\fBSKIP_CORE\fP is in the define list the "data/core" directory won't be
preprocessed.
.TP 
\fB\-\-preprocess\-input\-macros\fP\fI\ source\-file\fP
used only by the '\-\-preprocess' command.  Specifies a file that contains
[preproc_define]s to be included before preprocessing.
.TP 
\fB\-\-preprocess\-output\-macros\ [\fP\fItarget\-file\fP\fB]\fP
used only by the '\-\-preprocess' command.  Will output all preprocessed
macros in the target file. If the file is not specified the output will be
file '_MACROS_.cfg' in the target directory of preprocess's command.  The
output file can be passed to \fB\-\-preprocess\-input\-macros\fP This switch should
be typed before the \-\-preprocess command.
.TP 
\fB\-r\ \fP\fIX\fP\fBx\fP\fIY\fP\fB,\ \-\-resolution\ \fP\fIX\fP\fBx\fP\fIY\fP
sets the screen resolution. Example: \fB\-r 800x600\fP
.TP 
\fB\-\-render\-image\fP\fI\ image\fP\fB\ \fP\fIoutput\fP
takes a valid wesnoth 'image path string' with image path functions, and
outputs to a windows .bmp file.
.TP 
\fB\-\-rng\-seed\fP\fI\ seed\fP
seeds the random number generator with number <arg>.  Example:
\fB\-\-rng\-seed 0\fP
.TP 
\fB\-\-screenshot\fP\fI\ map\fP\fB\ \fP\fIoutput\fP
saves a screenshot of <map> to <output> without initializing
a screen.
.TP 
\fB\-s,\ \-\-server\ [\fP\fIhost\fP\fB]\fP
connects to the specified host if any, otherwise connect to the first server
in preferences. Example: \fB\-\-server server.wesnoth.org\fP
.TP 
\fB\-\-showgui\fP
runs the game with the GUI, overriding any implicit \fB\-\-nogui.\fP
.TP 
\fB\-\-strict\-validation\fP
validation errors are treated as fatal errors.
.TP 
\fB\-t,\ \-\-test\ [\fP\fIscenario_id\fP\fB]\fP
runs the game in a small test scenario. The scenario should be one defined
with a \fB[test]\fP WML tag. The default is "test". Implies \fB\-\-nogui.\fP
.TP 
\fB\-u,\ \-\-unit\fP\fI\ scenario\-id\fP
runs the specified test scenario as a unit test. Implies \fB\-\-nogui.\fP
.TP 
\fB\-\-userconfig\-dir\fP\fI\ name\fP
sets the user configuration directory to \fIname\fP under $HOME or "My
Documents\eMy Games" for windows.  You can also specify an absolute path for
the configuration directory outside the $HOME or "My Documents\eMy
Games". On Windows it is also possible to specify a directory relative to
the process working directory by using path starting with ".\e" or "..\e".
Under X11 this is set to $XDG_CONFIG_HOME or $HOME/.config/wesnoth by
default, on other systems to the user data path.
.TP 
\fB\-\-userconfig\-path\fP
prints the path of the user configuration directory and exits.
.TP 
\fB\-\-userdata\-dir\fP\fI\ name\fP
sets the user data directory to \fIname\fP under $HOME or "My Documents\eMy
Games" for windows.  You can also specify an absolute path for the user data
directory outside the $HOME or "My Documents\eMy Games". On Windows it is
also possible to specify a directory relative to the process working
directory by using path starting with ".\e" or "..\e".
.TP 
\fB\-\-username\fP\fI\ username\fP
uses <username> when connecting to a server, ignoring other
preferences.
.TP 
\fB\-\-userdata\-path\fP
prints the path of the user data directory and exits.
.TP 
\fB\-\-validcache\fP
assumes that the cache is valid. (dangerous)
.TP 
\fB\-v, \-\-version\fP
shows the version number and exits.
.TP 
\fB\-w, \-\-windowed\fP
runs the game in windowed mode.
.TP 
\fB\-\-with\-replay\fP
replays the game loaded with the \fB\-\-load\fP option.
.
.SH "Options for \-\-multiplayer"
.
The side\-specific multiplayer options are marked with \fInumber\fP.  \fInumber\fP
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\-\-ai_config\fP\fI\ number\fP\fB:\fP\fIvalue\fP
selects a configuration file to load for the AI controller for this side.
.TP 
\fB\-\-algorithm\fP\fI\ number\fP\fB:\fP\fIvalue\fP
selects a non\-standard algorithm to be used by the AI controller for this
side. The algorithm is defined by an \fB[ai]\fP tag, which can be a core one
either in "data/ai/ais" or "data/ai/dev" or an algorithm defined by an
add\-on. Available values include: \fBidle_ai\fP and \fBexperimental_ai\fP.
.TP 
\fB\-\-controller\fP\fI\ number\fP\fB:\fP\fIvalue\fP
selects the controller for this side. Available values: \fBhuman\fP and \fBai\fP.
.TP 
\fB\-\-era\fP\fI\ value\fP
use this option to play in the selected era instead of the \fBDefault\fP
era. The era is chosen by an id. Eras are described in the
\fBdata/multiplayer/eras.cfg\fP file.
.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 script\-based
benchmarking.
.TP 
\fB\-\-ignore\-map\-settings\fP
do not use map settings, use default values instead.
.TP 
\fB\-\-multiplayer\-repeat\fP\fI\ value\fP
repeats a multiplayer game \fIvalue\fP times. Best to use with \fB\-\-nogui\fP for
script\-based benchmarking.
.TP 
\fB\-\-parm\fP\fI\ number\fP\fB:\fP\fIname\fP\fB:\fP\fIvalue\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\fP\fI\ value\fP
selects a multiplayer scenario by id. The default scenario id is
\fBmultiplayer_The_Freelands\fP.
.TP 
\fB\-\-side\fP\fI\ number\fP\fB:\fP\fIvalue\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\fP\fI\ value\fP
sets the number of turns for the chosen scenario. The default is \fB50\fP.
.
.SH "EXIT STATUS"
.
Normal exit status is 0.  An exit status of 1 indicates an (SDL, video,
fonts, etc) initialization error.  An exit status of 2 indicates an error
with the command line options.
.br
When running unit tests (with\fB\ \-u\fP), the exit status is different.  An
exit status of 0 indicates that the test passed, and 1 indicates that the
test failed.  An exit status of 3 indicates that the test passed, but
produced an invalid replay file.  An exit status of 4 indicates that the
test passed, but the replay produced errors.  These latter two are only
returned if \fB\-\-noreplaycheck\fP is not passed.  An exit status of 2 indicates
that the test reached a time out, when used with the deprecated \fB\-\-timeout\fP
option.
.
.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.de@gmail.com>.
.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\-2016 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"
.
\fBwesnothd\fP(6).