wesnoth/doc/man/wesnoth.6
2005-01-30 17:33:31 +00:00

143 lines
4.2 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
.\"
.TH WESNOTH 6 "January 29th, 2005" "Wesnoth" "Battle for Wesnoth"
.SH NAME
battle for wesnoth \- fantasy turn-based strategy game
.SH SYNOPSIS
.B wesnoth
[\fIOPTION\fR]
[\fIPATH_TO_DATA\fR]
.SH DESCRIPTION
Battle for
.B Wesnoth
is a fantasy turn-based strategy game.
Battle for control of villages, using variety of units which have advantages and disadvantages in different types of terrains and against different types of attacks. Units gain experience, advance levels and can be carried over from one scenario to the next.
Build a Hero, and lead your army. Different races, with distinctive abilities, weapons and spells.
.SH OPTIONS
.TP
.BR --bpp
sets BitsPerPixel value. Example: --bpp 32
.TP
.BR -d , \ --debug
shows some extra debugging informations and options in-game.
.TP
.BR -f , \ --fullscreen
runs the game in full screen mode.
.TP
.BR --fps
displays the number of frames per second the game is currently running at, in a corner of the screen.
.TP
.BR -h , \ --help
tells you what the command line options do.
.TP
.BR --log-error="domain1,domain2,..." , \ --log-warning=... , \ --log-info=...
sets the severity level of the debug domains. "all" can be used to match any debug domain.
.TP
.BR --multiplayer
runs a multiplayer game. There are more extra options that can be used together with --multiplayer. They are explained below.
.TP
.BR --nocache
disables caching of game data.
.TP
.BR --nosound
runs game without sounds and music.
.TP
.BR --path
prints the name of the game data directory and exits.
.TP
.BR -r , \ --resolution
sets screen resolution. Example: -r 800x600
.TP
.BR -t , \ --test
runs the game in a small test scenario.
.TP
.BR -v , \ --version
shows version number and exits.
.TP
.BR -w , \ --windowed
runs the game in windowed mode.
.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 choosen scenario.
.TP
.BR --era=value
use this option to play in the selected era instead of the "Default" era. The era is choosen by an id. Eras and factions are described in the data/multiplayer.cfg file.
.TP
.BR --nogui
runs the game without the GUI.
.TP
.BR --scenario=value
selects a multiplayer scenario. The default scenario is "multiplayer_test".
.TP
.BR --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".
.TP
.BR --controller<number>=value
selects the controller for this side. Available values: "human" and "ai".
.TP
.BR --parm<number>=name:value
sets additional parameters for this side. This parameter depends on the options used with
.B --controller
and
.B --algorithm.
It should only be usefull for people designing their own AI. (not yet documented completely)
.TP
.BR --side<number>=value
selects a faction of the current era for this side. The faction is choosen by an id. Eras and factions are described in the data/multiplayer.cfg file.
.SH AUTHOR
Written by David White <davidnwhite@optusnet.com.au>.
.br
Edited by Nils Kneuper <crazy-ivanovic@gmx.net>.
.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 David White <davidnwhite@optusnet.com.au>
.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.