mirror of
https://github.com/wesnoth/wesnoth
synced 2025-04-26 13:53:18 +00:00
ba51524f6e
using this shell script: find src -type f -print0 | xargs -0 sed -i "s|Copyright (C) \([[:digit:]]*\)\([ ]*\)-\([ ]*\)2015|Copyright (C) \1\2-\32016|g"
335 lines
10 KiB
Groff
335 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
|
|
.\"
|
|
.
|
|
.TH WESNOTH 6 "2013" "wesnoth" "Battle for Wesnoth"
|
|
.
|
|
.SH NAME
|
|
wesnoth \- Battle for Wesnoth, a turn-based fantasy strategy game
|
|
.
|
|
.SH SYNOPSIS
|
|
.
|
|
.B wesnoth
|
|
[\fIOPTIONS\fR]
|
|
[\fIPATH_TO_DATA\fR]
|
|
.
|
|
.SH DESCRIPTION
|
|
.
|
|
Battle for
|
|
.B Wesnoth
|
|
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
|
|
.BI --bpp \ number
|
|
sets BitsPerPixel value. Example:
|
|
.B --bpp 32
|
|
.TP
|
|
.B -c, --campaign \ [<id_campaign>]
|
|
goes directly to the campaign with id <id_campaign>. A selection menu will appear if no id was specified.
|
|
.B Note:
|
|
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
|
|
.B --campaign-difficulty [<difficulty>]
|
|
The difficulty of the specified campaign (1 to max). If none specified, the campaign difficulty selection widget will appear.
|
|
.TP
|
|
.B --campaign-scenario <id_scenario>
|
|
The id of the scenario from the specified campaign. The default is the first scenario.
|
|
.TP
|
|
.B --data-dir <directory>
|
|
overrides the data directory with the one specified
|
|
.TP
|
|
.B --data-path
|
|
path the path of the data directory and exits.
|
|
.TP
|
|
.B -d, --debug
|
|
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
|
|
.BI -e,\ --editor \ file
|
|
start the in-game map editor directly. If
|
|
.I file
|
|
is specified, equivalent to
|
|
.B -l --load
|
|
.TP
|
|
.B --fps
|
|
displays the number of frames per second the game is currently running
|
|
at, in a corner of the screen.
|
|
.TP
|
|
.B -f, --fullscreen
|
|
runs the game in full screen mode.
|
|
.TP
|
|
.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 file in gzip format, stores it as
|
|
.IR infile .gz
|
|
and removes
|
|
.IR infile .
|
|
.TP
|
|
.B -h, --help
|
|
displays a summary of command line options to standard output, and exits.
|
|
.TP
|
|
.BI -l,\ --load \ file
|
|
loads the savegame
|
|
.I file
|
|
from the standard save game directory.
|
|
If the
|
|
.B -e
|
|
or
|
|
.B --editor
|
|
option is used as well, starts the editor with the map from
|
|
.I file
|
|
open. If it is a directory, the editor will start with a load map dialog opened there.
|
|
.TP
|
|
.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\ [filter]
|
|
lists defined log domains (only the ones containing
|
|
.B filter
|
|
if used) and exits
|
|
.TP
|
|
.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
|
|
.BR 50 .
|
|
.TP
|
|
.B -m, --multiplayer
|
|
runs a multiplayer game. There are additional options that can be used
|
|
together with
|
|
.B --multiplayer
|
|
as explained below. Only these additional options can follow
|
|
.BR --multiplayer .
|
|
.TP
|
|
.B --no-delay
|
|
runs the game without any delays for graphic benchmarking. This is automatically enabled by
|
|
.BR --nogui .
|
|
.TP
|
|
.B --nocache
|
|
disables caching of game data.
|
|
.TP
|
|
.B --nomusic
|
|
runs the game without music.
|
|
.TP
|
|
.B --nosound
|
|
runs the game without sounds and music.
|
|
.TP
|
|
.B --path
|
|
prints the name of the game data directory and exits.
|
|
.TP
|
|
.B -p, --preprocess <source file/folder> <target directory>
|
|
preprocesses a specified file/folder. For each file(s) a plain .cfg file and a processed
|
|
.cfg file will be written in specified target directory. If a folder is specified, it will
|
|
be preprocessed recursively based on the known preprocessor rules. The common macroses
|
|
from the "data/core/macros" directory will be preprocessed before the specified resources.
|
|
Example:
|
|
.B -p ~/wesnoth/data/campaigns/tutorial ~/result.
|
|
For details regarding the preprocessor visit:
|
|
http://wiki.wesnoth.org/PreprocessorRef#Command-line_preprocessor
|
|
|
|
.TP
|
|
.B --preprocess-defines=DEFINE1,DEFINE2,etc
|
|
comma separated list of defines to be used by the '--preprocess' command. If
|
|
.B SKIP_CORE
|
|
is in the define list the "data/core" directory won't be preprocessed.
|
|
.TP
|
|
.B --preprocess-input-macros <source file>
|
|
used only by the '--preprocess' command.
|
|
Specifies a file that contains [preproc_define]s to be included before preprocessing.
|
|
.TP
|
|
.B --preprocess-output-macros [<target file>]
|
|
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
|
|
.BI -r\ X x Y ,\ --resolution\ X x Y
|
|
sets the screen resolution. Example:
|
|
.B -r 800x600
|
|
.TP
|
|
.BI -s,\ --server\ [host]
|
|
connects to the specified host if any, otherwise connect to the first server in preferences. Example:
|
|
.B --server server.wesnoth.org
|
|
.TP
|
|
.BI --username <username>
|
|
uses <username> when connecting to a server, ignoring other preferences.
|
|
.TP
|
|
.BI --password <password>
|
|
uses <password> when connecting to a server, ignoring other preferences. Unsafe.
|
|
.TP
|
|
.B --strict-validation
|
|
validation errors are treated as fatal errors.
|
|
.TP
|
|
.B -t, --test
|
|
runs the game in a small test scenario.
|
|
.TP
|
|
.BI --userconfig-dir \ name
|
|
sets the user configuration directory to
|
|
.I name
|
|
under $HOME or "My Documents\\My Games" for windows.
|
|
You can also specify an absolute path for the configuration directory outside
|
|
the $HOME or "My Documents\\My Games". On Windows it is also possible to
|
|
specify a directory relative to the process working directory by using path
|
|
starting with ".\\" or "..\\".
|
|
Under X11 this defaults to $XDG_CONFIG_HOME or $HOME/.config/wesnoth,
|
|
on other systems to the userdata path.
|
|
.TP
|
|
.B --userconfig-path
|
|
prints the path of the user configuration directory and exits.
|
|
.TP
|
|
.BI --userdata-dir \ name
|
|
sets the userdata directory to
|
|
.I name
|
|
under $HOME or "My Documents\\My Games" for windows.
|
|
You can also specify an absolute path for the userdata directory outside
|
|
the $HOME or "My Documents\\My Games". On Windows it is also possible to
|
|
specify a directory relative to the process working directory by using path
|
|
starting with ".\\" or "..\\".
|
|
.TP
|
|
.B --userdata-path
|
|
prints the path of the userdata directory and exits.
|
|
.TP
|
|
.B --validcache
|
|
assumes that the cache is valid. (dangerous)
|
|
.TP
|
|
.B -v, --version
|
|
shows the version number and exits.
|
|
.TP
|
|
.B -w, --windowed
|
|
runs the game in windowed mode.
|
|
.TP
|
|
.B --with-replay
|
|
replays the game loaded with the
|
|
.B --load
|
|
option.
|
|
.
|
|
.SH Options for --multiplayer
|
|
.
|
|
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
|
|
.BI --ai_config number = value
|
|
selects a configuration file to load for the AI controller for this side.
|
|
.TP
|
|
.BI --algorithm number = value
|
|
selects a non-standard algorithm to be used by the AI controller for
|
|
this side. Available values:
|
|
.B idle_ai
|
|
and
|
|
.BR sample_ai .
|
|
.TP
|
|
.BI --controller number = value
|
|
selects the controller for this side. Available values:
|
|
.B human
|
|
and
|
|
.BR ai .
|
|
.TP
|
|
.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
|
|
.B "data/multiplayer/eras.cfg"
|
|
file.
|
|
.TP
|
|
.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.
|
|
.TP
|
|
.B --ignore-map-settings
|
|
do not use map settings, use default values instead.
|
|
.TP
|
|
.BI --multiplayer-repeat= value
|
|
repeats a multiplayer game
|
|
.I value
|
|
times. Best to use with
|
|
.B --nogui
|
|
for scriptable benchmarking.
|
|
.TP
|
|
.B --nogui
|
|
runs the game without the GUI. Must appear before
|
|
.B --multiplayer
|
|
to have the desired effect.
|
|
.TP
|
|
.BI --parm number = name : value
|
|
sets additional parameters for this side. This parameter depends on the
|
|
options used with
|
|
.B --controller
|
|
and
|
|
.BR --algorithm .
|
|
It should only be useful for people designing their own AI. (not yet
|
|
documented completely)
|
|
.TP
|
|
.BI --scenario= value
|
|
selects a multiplayer scenario by id. The default scenario id is
|
|
.BR multiplayer_The_Freelands .
|
|
.TP
|
|
.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
|
|
.BI --turns= value
|
|
sets the number of turns for the chosen scenario. The default is
|
|
.BR 50 .
|
|
.
|
|
.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-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
|
|
.
|
|
.BR wesnothd (6).
|