mirror of
https://github.com/wesnoth/wesnoth
synced 2025-05-09 08:08:49 +00:00
0d39e8db17
(no new/changed strings, reference update only, preparing for 1.9.14) regenerated doc files (had to fix manpages for the Serbian (transliterations) manually!)
264 lines
10 KiB
Groff
264 lines
10 KiB
Groff
.\" 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 2011 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\-\-bpp\fP\fI\ number\fP
|
|
sets BitsPerPixel value. Example: \fB\-\-bpp 32\fP
|
|
.TP
|
|
\fB\-c, \-\-campaign \ [<id_campaign>]\fP
|
|
goes directly to the campaign with id <id_campaign>. A selection
|
|
menu will appear if no id was specified. \fBNote:\fP When using this switch
|
|
please ensure that you specify the data directory path as the final argument
|
|
as well, otherwise the game will take the campaign/scenario id as the data
|
|
dir.
|
|
.TP
|
|
\fB\-\-campaign\-difficulty <difficulty>\fP
|
|
The difficulty of the specified campaign (1 to max). If none specified, the
|
|
campaign difficulty selection widget will appear.
|
|
.TP
|
|
\fB\-\-campaign\-scenario <id_scenario>\fP
|
|
The id of the scenario from the specified campaign. The default is the first
|
|
scenario.
|
|
.TP
|
|
\fB\-\-config\-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"
|
|
.TP
|
|
\fB\-\-config\-path\fP
|
|
prints the path of the user configuration directory and exits.
|
|
.TP
|
|
\fB\-\-data\-dir <directory>\fP
|
|
overrides the data directory with the one specified
|
|
.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\-\-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\-\-logdomains\ [filter]\fP
|
|
lists defined log domains (only the ones containing \fBfilter\fP if used) and
|
|
exits
|
|
.TP
|
|
\fB\-\-max\-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. Only these additional
|
|
options can follow \fB\-\-multiplayer\fP.
|
|
.TP
|
|
\fB\-\-no\-delay\fP
|
|
runs the game without any delays for graphic benchmarking. This is
|
|
automatically enabled by \fB\-\-nogui\fP.
|
|
.TP
|
|
\fB\-\-nocache\fP
|
|
disables caching of game data.
|
|
.TP
|
|
\fB\-\-nomusic\fP
|
|
runs the game without music.
|
|
.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\-\-preprocess, \-p[=<define1>,<define2>,...] <file/folder> <target directory>\fP
|
|
preprocesses a specified file/folder. The file(s) will be written in
|
|
specified target directory: a plain cfg file and a processed cfg file. If a
|
|
folder is specified, it will be preprocessed recursively based on the known
|
|
preprocessor rules. The common macroses from the data/core/macros will be
|
|
preprocessed before the specified resources. \fBdefine1,define2,...\fP \- the
|
|
extra defines will be added before processing the files. If you want to add
|
|
them you must add the '=' character before. If 'SKIP_CORE' is in the define
|
|
list the data/core won't be preprocessed. Example: \fB\-p
|
|
~/wesnoth/data/campaigns/tutorial ~/result\fP or
|
|
\fB\-p=MULTIPLAYER,MY_OWN_CAMPAIGN ~/wesnoth/data/campaign/camp ~/result\fP
|
|
.TP
|
|
\fB\-\-preprocess\-input\-macros <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 [<target file>]\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. 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\-s,\ \-\-server\ [host]\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\-\-strict\-validation\fP
|
|
validation errors are treated as fatal errors.
|
|
.TP
|
|
\fB\-t, \-\-test\fP
|
|
runs the game in a small test scenario.
|
|
.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\fInumber\fP\fB=\fP\fIvalue\fP
|
|
selects a configuration file to load for the AI controller for this side.
|
|
.TP
|
|
\fB\-\-algorithm\fP\fInumber\fP\fB=\fP\fIvalue\fP
|
|
selects a non\-standard algorithm to be used by the AI controller for this
|
|
side. Available values: \fBidle_ai\fP and \fBsample_ai\fP.
|
|
.TP
|
|
\fB\-\-controller\fP\fInumber\fP\fB=\fP\fIvalue\fP
|
|
selects the controller for this side. Available values: \fBhuman\fP and \fBai\fP.
|
|
.TP
|
|
\fB\-\-era=\fP\fIvalue\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 scriptable
|
|
benchmarking.
|
|
.TP
|
|
\fB\-\-nogui\fP
|
|
runs the game without the GUI. Must appear before \fB\-\-multiplayer\fP to have
|
|
the desired effect.
|
|
.TP
|
|
\fB\-\-parm\fP\fInumber\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\fIvalue\fP
|
|
selects a multiplayer scenario by id. The default scenario id is
|
|
\fBmultiplayer_The_Freelands\fP.
|
|
.TP
|
|
\fB\-\-side\fP\fInumber\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\fIvalue\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.
|
|
.
|
|
.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\-2011 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).
|