documentation for 'allow absolute paths for the --config-dir commandline'

This commit is contained in:
Timotei Dolean 2010-07-27 19:07:05 +00:00
parent 89460a7ee9
commit e2a387290c
3 changed files with 24 additions and 19 deletions

View file

@ -199,7 +199,8 @@ Version 1.9.0-svn:
* Fixed picking the proper locale, the problem only occurred on some
systems
* Added a way to compile wesnoth on windows by using CMake + MSVC9.
* Added more command line arguments for starting a campaign+scenario
* Added the possibility to specify absolute paths for "--config-dir"
* Added more command line arguments for starting a campaign + scenario
* Added command line "preprocess" to preprocess a specified file/folder and
output the result
* Added command line "--data-dir" to explicitly override the data directory
@ -238,7 +239,7 @@ Version 1.9.0-svn:
* Fixed attacker still getting resting bonus after attack using movement_used=0
* Fixed [store_time_of_day] for earlier turn
* Fixed _off^_usr not using the tile_image of theme.
* Patch #1727: Fixed revision.hpp generation with cmake 1.8(.2)
* Patch #1727: Fixed revision.hpp generation with cmake 1.8(.2)
Version 1.8.0:
* AI:

View file

@ -30,14 +30,14 @@ 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 on-line players. Create your own custom units, scenarios or
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
@ -48,7 +48,7 @@ sets BitsPerPixel value. Example:
.B --bpp 32
.TP
.B -c, --campaign[[<difficulty>] <id_campaign> [<id_scenario>]]
goes directly to the campaign based on the parameters.
goes directly to the campaign based on the parameters.
The difficulty is a number between 1 and current campaign's difficulties number. The default difficulty is 1.
The scenario must be one of the campaign's child scenarios. The default scenario is campaign's first scenario.
.TP
@ -56,6 +56,8 @@ The scenario must be one of the campaign's child scenarios. The default scenario
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"
.TP
.B --config-path
prints the path of the user configuration directory and exits.
@ -68,9 +70,9 @@ 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
start the in-game map editor directly. If
.I file
is specified, equivalent to
is specified, equivalent to
.B -l --load
.TP
.B --fps
@ -81,13 +83,13 @@ at, in a corner of the screen.
runs the game in full screen mode.
.TP
.BI --gunzip \ infile.gz
decompresses a file which should be in gzip format and stores it
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
compresses a file in gzip format, stores it as
.IR infile .gz
and removes
.IR infile .
@ -99,7 +101,7 @@ displays a summary of command line options to standard output, and exits.
loads the savegame
.I file
from the standard save game directory.
If the
If the
.B -e
or
.B --editor
@ -122,7 +124,7 @@ Dumps a list of all log domains and exits.
.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 .
.BR 50 .
.TP
.B -m, --multiplayer
runs a multiplayer game. There are additional options that can be used
@ -205,13 +207,13 @@ this side. Available values:
.B idle_ai
and
.BR sample_ai .
.TP
.TP
.BI --controller number = value
selects the controller for this side. Available values:
.B human
and
.BR ai .
.TP
.TP
.BI --era= value
use this option to play in the selected era instead of the
.B Default

View file

@ -1764,6 +1764,8 @@ static int process_command_args(int argc, char** argv) {
<< " specified campaign\n"
<< " --config-dir <name> sets the path of the user config directory to\n"
<< " $HOME/<name> or My Documents\\My Games\\<name> for windows.\n"
<< " You can specify also an absolute path outside the\n"
<< " $HOME or My Documents\\My Games directory."
<< " --config-path prints the path of the user config directory and\n"
<< " exits.\n"
<< " --data-dir <directory> overrides the data directory with the one specified.\n"