1
0
Fork 0

Proper 'fgfs --help -v' documentation for --aircraft-dir

- Fix documentation for --aircraft-dir: the specified path is
  interpreted relatively to the current directory, not to the path of
  the fgfs executable.

- Add a few precisions (the option bypasses the <path-cache> from
  autosave_X_Y.xml, as well as --fg-aircraft and FG_AIRCRAFT).

- Show the option documentation in 'fgfs --help -v' output (it was
  "hidden" since 2010, but it works very well; cf.
  <https://sourceforge.net/p/flightgear/mailman/message/34494887/> for
  the most recent discussion about this option).

- Show the doc for --aircraft-dir right below that of --aircraft (both
  being closely related).

- Add a pointer to --aircraft-dir in --fg-aircraft's doc, since the
  former can be used as an alternative to the latter (or at least a
  complement, since --fg-aircraft is used to determine some
  permissions).
This commit is contained in:
Florent Rougon 2015-12-24 12:11:54 +01:00
parent 88bc96d346
commit afec939218
2 changed files with 8 additions and 9 deletions

View file

@ -15,7 +15,7 @@
<fg-root-desc>Specify the root data path</fg-root-desc> <fg-root-desc>Specify the root data path</fg-root-desc>
<fg-scenery-desc n="0">Specify the scenery path(s);</fg-scenery-desc> <fg-scenery-desc n="0">Specify the scenery path(s);</fg-scenery-desc>
<fg-scenery-desc n="1">Defaults to $FG_ROOT/Scenery</fg-scenery-desc> <fg-scenery-desc n="1">Defaults to $FG_ROOT/Scenery</fg-scenery-desc>
<fg-aircraft-desc>Specify additional aircraft directory path(s)</fg-aircraft-desc> <fg-aircraft-desc>Specify additional aircraft directory path(s) (alternatively, you can use --aircraft-dir to target a specific aircraft in a given directory)</fg-aircraft-desc>
<language-desc>Select the language for this session</language-desc> <language-desc>Select the language for this session</language-desc>
<disable-splash-screen-desc>Disable splash screen</disable-splash-screen-desc> <disable-splash-screen-desc>Disable splash screen</disable-splash-screen-desc>
<enable-splash-screen-desc>Enable splash screen</enable-splash-screen-desc> <enable-splash-screen-desc>Enable splash screen</enable-splash-screen-desc>
@ -92,7 +92,7 @@
<random-wind-desc>Set up random wind direction and speed</random-wind-desc> <random-wind-desc>Set up random wind direction and speed</random-wind-desc>
<turbulence-desc>Specify turbulence from 0.0 (calm) to 1.0 (severe)</turbulence-desc> <turbulence-desc>Specify turbulence from 0.0 (calm) to 1.0 (severe)</turbulence-desc>
<ceiling-desc>Create an overcast ceiling, optionally with a specific thickness (defaults to 2000 ft).</ceiling-desc> <ceiling-desc>Create an overcast ceiling, optionally with a specific thickness (defaults to 2000 ft).</ceiling-desc>
<aircraft-dir-desc>Aircraft directory relative to the path of the executable</aircraft-dir-desc> <aircraft-dir-desc>Specify the exact directory to use for the aircraft (normally not required, but may be useful). Interpreted relatively to the current directory. Causes the &lt;path-cache&gt; from autosave_X_Y.xml, as well as --fg-aircraft and the FG_AIRCRAFT environment variable to be bypassed.</aircraft-dir-desc>
<aircraft-model-options>Aircraft model directory (UIUC FDM ONLY)</aircraft-model-options> <aircraft-model-options>Aircraft model directory (UIUC FDM ONLY)</aircraft-model-options>

View file

@ -498,6 +498,12 @@
<brief/> <brief/>
</option> </option>
<option>
<name>aircraft-dir</name>
<arg>path</arg>
<description>aircraft-dir-desc</description>
</option>
<option> <option>
<name>show-aircraft</name> <name>show-aircraft</name>
<description>show-aircraft-desc</description> <description>show-aircraft-desc</description>
@ -565,13 +571,6 @@
<description>disable-auto-coordination-desc</description> <description>disable-auto-coordination-desc</description>
</option> </option>
<!--
<option>
<name>aircraft-dir</name>
<arg>path</arg>
<description>aircraft-dir-desc</description>
</option> -->
<option> <option>
<name>livery</name> <name>livery</name>
<arg>name</arg> <arg>name</arg>