documentation about --user{config,data}-{dir,path}

This commit is contained in:
Alexander van Gessel 2013-12-28 14:12:23 +01:00
parent bf8b05ff31
commit 63cf0fe6e3
2 changed files with 25 additions and 10 deletions

View file

@ -22,6 +22,9 @@ Example contents.
Rebalancing of the campaign continues and is mostly done for Scenarios 1 (End of Peace) through 8 (Silent Forest) with only some fine tuning left to do. Play testing and feedback by others would be extremely helpful for this process. The first newly rebalanced scenario of this release is 'The Siege of Barag Gor'. Scenarios after 'Silent Forest' have also seen some changes but are not balanced yet.
[/section]
[section="Userdata command line options"]
Since 1.9.0, Wesnoth obeys the XDG Basedir Specification, meaning that on X11-based systems, such as most linux distros, the userdata and the preferences have been split between $HOME/.local/share/wesnoth/<version> and $HOME/.config/wesnoth. The old command line options --config-dir and --config-path remained in place, referring to the userdata though. New options, --userdata-dir, --userdata-path, --userconfig-dir and --userconfig-path now replace these old ones.
[/section]
==========

View file

@ -58,16 +58,6 @@ The difficulty of the specified campaign (1 to max). If none specified, the camp
.B --campaign-scenario <id_scenario>
The id of the scenario from the specified campaign. The default is the first scenario.
.TP
.BI --config-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"
.TP
.B --config-path
prints the path of the user configuration directory and exits.
.TP
.B --data-dir <directory>
overrides the data directory with the one specified
.TP
@ -203,6 +193,28 @@ validation errors are treated as fatal errors.
.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".
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".
.TP
.B --userdata-path
prints the path of the userdata directory and exits.
.TP
.B --validcache
assumes that the cache is valid. (dangerous)
.TP