1
0
Fork 0
fgdata/options.xml
Florent Rougon afec939218 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).
2015-12-24 12:11:54 +01:00

1186 lines
25 KiB
XML

<?xml version="1.0"?>
<PropertyList>
<copyright>
Copyright (C) 2002 Cameron Moore
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.
Or try here: http://www.fsf.org/copyleft/gpl.html
</copyright>
<description>
The FlightGear flight simulator project is an open-source, multi-platform,
cooperative flight simulator development project. Source code for the entire
project is available and licensed under the GNU General Public License.
The goal of the FlightGear project is to create a sophisticated flight
simulator framework for use in research or academic environments, for the
development and pursuit of other interesting flight simulation ideas, and as
an end-user application. We are developing a sophisticated, open simulation
framework that can be expanded and improved upon by anyone interested in
contributing.
There are many exciting possibilities for an open, free flight sim. We hope
that this project will be interesting and useful to many people in many areas.
</description>
<options>
<usage>usage</usage>
<verbose-help>verbose-help</verbose-help>
<section>
<name>general-options</name>
<option>
<name>help</name>
<short>h</short>
<description>help-desc</description>
<brief/>
</option>
<option>
<name>verbose</name>
<short>v</short>
<description>verbose-desc</description>
<brief/>
</option>
<option>
<name>version</name>
<description>version-desc</description>
</option>
<option>
<name>fg-root</name>
<arg>path</arg>
<description>fg-root-desc</description>
<brief/>
</option>
<option>
<name>fg-scenery</name>
<arg>path</arg>
<description>fg-scenery-desc</description>
<brief/>
</option>
<option>
<name>fg-aircraft</name>
<arg>path</arg>
<description>fg-aircraft-desc</description>
<brief/>
</option>
<option>
<name>language</name>
<arg>code</arg>
<description>language-desc</description>
<brief/>
</option>
<option>
<name>restore-defaults</name>
<description>restore-defaults-desc</description>
</option>
<option>
<name>disable-save-on-exit</name>
<description>disable-save-on-exit</description>
</option>
<option>
<name>enable-save-on-exit</name>
<description>enable-save-on-exit</description>
</option>
<option>
<name>browser-app</name>
<arg>path</arg>
<description>browser-app-desc</description>
</option>
<option>
<name>prop:[type:]name</name>
<arg>value</arg>
<description>prop-desc</description>
</option>
<option>
<name>config</name>
<arg>path</arg>
<description>config-desc</description>
</option>
<option>
<name>units-feet</name>
<description>units-feet-desc</description>
</option>
<option>
<name>units-meters</name>
<description>units-meters-desc</description>
</option>
<option>
<name>console</name>
<description>console-desc</description>
</option>
</section>
<section>
<name>features-options</name>
<option>
<name>disable-panel</name>
<description>disable-panel-desc</description>
</option>
<option>
<name>enable-panel</name>
<description>enable-panel-desc</description>
</option>
<option>
<name>disable-hud</name>
<description>disable-hud-desc</description>
</option>
<option>
<name>enable-hud</name>
<description>enable-hud-desc</description>
</option>
<option>
<name>disable-anti-alias-hud</name>
<description>disable-anti-alias-hud-desc</description>
</option>
<option>
<name>enable-anti-alias-hud</name>
<description>enable-anti-alias-hud-desc</description>
</option>
<option>
<name>disable-hud-3d</name>
<description>disable-hud-3d-desc</description>
</option>
<option>
<name>enable-hud-3d</name>
<description>enable-hud-3d-desc</description>
</option>
<option>
<name>hud-tris</name>
<description>hud-tris-desc</description>
</option>
<option>
<name>hud-culled</name>
<description>hud-culled-desc</description>
</option>
<option>
<name>disable-random-objects</name>
<description>disable-random-objects-desc</description>
<description>random-objects-desc</description>
</option>
<option>
<name>enable-random-objects</name>
<description>enable-random-objects-desc</description>
<description>random-objects-desc</description>
</option>
<option>
<name>disable-random-vegetation</name>
<description>disable-random-vegetation-desc</description>
<description>random-vegetation-desc</description>
</option>
<option>
<name>enable-random-vegetation</name>
<description>enable-random-vegetation-desc</description>
<description>random-vegetation-desc</description>
</option>
<option>
<name>disable-random-buildings</name>
<description>disable-random-buildings-desc</description>
<description>random-buildings-desc</description>
</option>
<option>
<name>enable-random-buildings</name>
<description>enable-random-buildings-desc</description>
<description>random-buildings-desc</description>
</option>
<option>
<name>disable-ai-models</name>
<description>disable-ai-models-desc</description>
</option>
<option>
<name>enable-ai-models</name>
<description>enable-ai-models-desc</description>
</option>
<option>
<name>disable-ai-traffic</name>
<description>disable-ai-traffic-desc</description>
</option>
<option>
<name>enable-ai-traffic</name>
<description>enable-ai-traffic-desc</description>
</option>
<option>
<name>ai-scenario</name>
<arg>scenario</arg>
<description>ai-scenario</description>
</option>
<option>
<name>disable-freeze</name>
<description>disable-freeze-desc</description>
</option>
<option>
<name>enable-freeze</name>
<description>enable-freeze-desc</description>
</option>
<option>
<name>disable-fuel-freeze</name>
<description>disable-fuel-freeze-desc</description>
</option>
<option>
<name>enable-fuel-freeze</name>
<description>enable-fuel-freeze-desc</description>
</option>
<option>
<name>disable-clock-freeze</name>
<description>disable-clock-freeze-desc</description>
</option>
<option>
<name>enable-clock-freeze</name>
<description>enable-clock-freeze-desc</description>
</option>
<option>
<name>failure</name>
<arg>{pitot|static|vacuum|electrical}</arg>
<description>failure-desc</description>
</option>
</section>
<section>
<name>audio-options</name>
<option>
<name>show-sound-devices</name>
<description>show-sound-devices-desc</description>
</option>
<option>
<name>sound-device</name>
<description>sound-device-desc</description>
</option>
<option>
<name>disable-sound</name>
<description>disable-sound-desc</description>
</option>
<option>
<name>enable-sound</name>
<description>enable-sound-desc</description>
</option>
</section>
<section>
<name>rendering-options</name>
<option>
<name>enable-rembrandt</name>
<description>enable-rembrandt-desc</description>
</option>
<option>
<name>disable-rembrandt</name>
<description>disable-rembrandt-desc</description>
</option>
<option>
<name>disable-splash-screen</name>
<description>disable-splash-screen-desc</description>
</option>
<option>
<name>enable-splash-screen</name>
<description>enable-splash-screen-desc</description>
</option>
<option>
<name>disable-mouse-pointer</name>
<description>disable-mouse-pointer-desc</description>
</option>
<option>
<name>enable-mouse-pointer</name>
<description>enable-mouse-pointer-desc</description>
</option>
<option>
<name>max-fps</name>
<arg>Hz</arg>
<description>max-fps-desc</description>
</option>
<option>
<name>bpp</name>
<arg>depth</arg>
<description>bpp-desc</description>
</option>
<option>
<name>fog-disable</name>
<description>fog-disable-desc</description>
</option>
<option>
<name>fog-fastest</name>
<description>fog-fastest-desc</description>
</option>
<option>
<name>fog-nicest</name>
<description>fog-nicest-desc</description>
</option>
<option>
<name>disable-enhanced-lighting</name>
<description>disable-enhanced-lighting</description>
</option>
<option>
<name>enable-enhanced-lighting</name>
<description>enable-enhanced-lighting</description>
</option>
<option>
<name>disable-distance-attenuation</name>
<description>disable-distance-attenuation</description>
</option>
<option>
<name>enable-distance-attenuation</name>
<description>enable-distance-attenuation</description>
</option>
<option>
<name>disable-horizon-effect</name>
<description>disable-horizon-effect</description>
</option>
<option>
<name>enable-horizon-effect</name>
<description>enable-horizon-effect</description>
</option>
<option>
<name>disable-specular-highlight</name>
<description>disable-specular-highlight</description>
</option>
<option>
<name>enable-specular-highlight</name>
<description>enable-specular-highlight</description>
</option>
<option>
<name>fov</name>
<arg>degrees</arg>
<description>fov-desc</description>
</option>
<option>
<name>aspect-ratio-multiplier</name>
<arg>factor</arg>
<description>arm-desc</description>
</option>
<option>
<name>disable-fullscreen</name>
<description>disable-fullscreen-desc</description>
</option>
<option>
<name>enable-fullscreen</name>
<description>enable-fullscreen-desc</description>
</option>
<option>
<name>shading-flat</name>
<description>shading-flat-desc</description>
</option>
<option>
<name>shading-smooth</name>
<description>shading-smooth-desc</description>
</option>
<option>
<name>materials-file</name>
<arg>file</arg>
<description>materials-file-desc</description>
</option>
<option>
<name>texture-filtering</name>
<arg>value</arg>
<description>texture-filtering-desc</description>
</option>
<option>
<name>disable-wireframe</name>
<description>disable-wireframe-desc</description>
</option>
<option>
<name>enable-wireframe</name>
<description>enable-wireframe-desc</description>
</option>
<option>
<name>geometry</name>
<arg>WxH</arg>
<description>geometry-desc</description>
</option>
<option>
<name>view-offset</name>
<arg>value</arg>
<description>view-offset-desc</description>
</option>
</section>
<section>
<name>aircraft-options</name>
<option>
<name>aircraft</name>
<arg>name</arg>
<description>aircraft-desc</description>
<brief/>
</option>
<option>
<name>aircraft-dir</name>
<arg>path</arg>
<description>aircraft-dir-desc</description>
</option>
<option>
<name>show-aircraft</name>
<description>show-aircraft-desc</description>
<brief/>
</option>
<option>
<name>min-status</name>
<arg>{alpha,beta,early-production,production}</arg>
<description>min-aircraft-status</description>
<brief/>
</option>
<option>
<name>fdm</name>
<arg>name</arg>
<description>fdm-desc</description>
</option>
<option>
<name>aero</name>
<arg>name</arg>
<description>aero-desc</description>
</option>
<option>
<name>model-hz</name>
<arg>n</arg>
<description>model-hz-desc</description>
</option>
<option>
<name>speed</name>
<arg>n</arg>
<description>speed-desc</description>
</option>
<option>
<name>trim</name>
<description>trim-desc</description>
</option>
<option>
<name>notrim</name>
<description>notrim-desc</description>
</option>
<option>
<name>on-ground</name>
<description>on-ground-desc</description>
</option>
<option>
<name>in-air</name>
<description>in-air-desc</description>
</option>
<option>
<name>enable-auto-coordination</name>
<description>enable-auto-coordination-desc</description>
</option>
<option>
<name>disable-auto-coordination</name>
<description>disable-auto-coordination-desc</description>
</option>
<option>
<name>livery</name>
<arg>name</arg>
<description>livery-desc</description>
</option>
<option>
<name>vehicle</name>
<arg>name</arg>
<description>vehicle-desc</description>
</option>
</section>
<section>
<name>time-options</name>
<option>
<name>timeofday</name>
<arg>{real,dawn,morning,noon,afternoon,dusk,evening,midnight}</arg>
<description>timeofday-desc</description>
</option>
<option>
<name>season</name>
<arg>{summer,winter}</arg>
<description>season-desc</description>
</option>
<option>
<name>time-offset</name>
<arg>[+-]hh:mm:ss</arg>
<description>time-offset-desc</description>
</option>
<option>
<name>time-match-real</name>
<description>time-match-real-desc</description>
</option>
<option>
<name>time-match-local</name>
<description>time-match-local-desc</description>
</option>
<option>
<name>start-date-sys</name>
<arg>yyyy:mm:dd:hh:mm:ss</arg>
<description>start-date-desc</description>
<description>system-time</description>
</option>
<option>
<name>start-date-gmt</name>
<arg>yyyy:mm:dd:hh:mm:ss</arg>
<description>start-date-desc</description>
<description>gmt</description>
</option>
<option>
<name>start-date-lat</name>
<arg>yyyy:mm:dd:hh:mm:ss</arg>
<description>start-date-desc</description>
<description>locale-aircraft-time</description>
</option>
</section>
<section>
<name>position-options</name>
<option>
<name>airport</name>
<arg>ID</arg>
<description>airport-desc</description>
<brief/>
</option>
<option>
<name>parking-id</name>
<arg>name</arg>
<description>parking-id-desc</description>
</option>
<option>
<name>runway</name>
<arg>rwy_no</arg>
<description>runway-no-desc</description>
<brief/>
</option>
<option>
<name>carrier</name>
<arg>[name|ID]</arg>
<description>carrier-desc</description>
<brief/>
</option>
<option>
<name>parkpos</name>
<arg>name</arg>
<description>parkpos-desc</description>
</option>
<option>
<name>vor</name>
<arg>ID</arg>
<description>vor-desc</description>
</option>
<option>
<name>vor-frequency</name>
<arg>frequency</arg>
<description>vor-freq-desc</description>
</option>
<option>
<name>ndb</name>
<arg>ID</arg>
<description>ndb-desc</description>
</option>
<option>
<name>ndb-frequency</name>
<arg>frequency</arg>
<description>ndb-freq-desc</description>
</option>
<option>
<name>fix</name>
<arg>ID</arg>
<description>fix-desc</description>
</option>
<option>
<name>offset-distance</name>
<arg>nm</arg>
<description>offset-distance-desc</description>
</option>
<option>
<name>offset-azimuth</name>
<arg>degrees</arg>
<description>offset-azimuth-desc</description>
</option>
<option>
<name>lon</name>
<arg>degrees</arg>
<description>lon-desc</description>
</option>
<option>
<name>lat</name>
<arg>degrees</arg>
<description>lat-desc</description>
</option>
<option>
<name>altitude</name>
<arg>value</arg>
<description>altitude-desc</description>
<description>units-feet</description>
</option>
<option>
<name>heading</name>
<arg>degrees</arg>
<description>heading-desc</description>
</option>
<option>
<name>roll</name>
<arg>degrees</arg>
<description>roll-desc</description>
</option>
<option>
<name>pitch</name>
<arg>degrees</arg>
<description>pitch-desc</description>
</option>
<option>
<name>uBody</name>
<arg>units_per_sec</arg>
<description>uBody-desc</description>
<description>units-feet</description>
</option>
<option>
<name>vBody</name>
<arg>units_per_sec</arg>
<description>vBody-desc</description>
<description>units-feet</description>
</option>
<option>
<name>wBody</name>
<arg>units_per_sec</arg>
<description>wBody-desc</description>
<description>units-feet</description>
</option>
<option>
<name>vNorth</name>
<arg>units_per_sec</arg>
<description>vNorth-desc</description>
<description>units-feet</description>
</option>
<option>
<name>vEast</name>
<arg>units_per_sec</arg>
<description>vEast-desc</description>
<description>units-feet</description>
</option>
<option>
<name>vDown</name>
<arg>units_per_sec</arg>
<description>vDown-desc</description>
<description>units-feet</description>
</option>
<option>
<name>vc</name>
<arg>knots</arg>
<description>vc-desc</description>
</option>
<option>
<name>mach</name>
<arg>num</arg>
<description>mach-desc</description>
</option>
<option>
<name>glideslope</name>
<arg>degrees</arg>
<description>glideslope-desc</description>
</option>
<option>
<name>roc</name>
<arg>fpm</arg>
<description>roc-desc</description>
</option>
</section>
<section>
<name>route-options</name>
<option>
<name>wp</name>
<arg>ID[@alt]</arg>
<description>wp-desc</description>
<description>multiple-instance</description>
</option>
<option>
<name>flight-plan</name>
<arg>file</arg>
<description>flight-plan-desc</description>
</option>
</section>
<section>
<name>avionics-options</name>
<option>
<name>com1</name>
<arg>frequency</arg>
<description>com1-desc</description>
</option>
<option>
<name>com2</name>
<arg>frequency</arg>
<description>com2-desc</description>
</option>
<option>
<name>nav1</name>
<arg>[radial:]frequency</arg>
<description>nav1-desc</description>
</option>
<option>
<name>nav2</name>
<arg>[radial:]frequency</arg>
<description>nav2-desc</description>
</option>
<option>
<name>adf1</name>
<arg>[rotation:]frequency</arg>
<description>adf1-desc</description>
</option>
<option>
<name>adf2</name>
<arg>[rotation:]frequency</arg>
<description>adf2-desc</description>
</option>
<option>
<name>dme</name>
<arg>{nav1|nav2|frequency}</arg>
<description>dme-desc</description>
</option>
</section>
<section>
<name>environment-options</name>
<option>
<name>metar</name>
<arg>METAR</arg>
<description>metar-desc</description>
</option>
<option>
<name>disable-real-weather-fetch</name>
<description>disable-real-weather-fetch-desc</description>
</option>
<option>
<name>enable-real-weather-fetch</name>
<description>enable-real-weather-fetch-desc</description>
</option>
<option>
<name>enable-clouds</name>
<description>enable-clouds-desc</description>
</option>
<option>
<name>disable-clouds</name>
<description>disable-clouds-desc</description>
</option>
<option>
<name>enable-clouds3d</name>
<description>enable-clouds3d-desc</description>
</option>
<option>
<name>disable-clouds3d</name>
<description>disable-clouds3d-desc</description>
</option>
<option>
<name>visibility</name>
<arg>meters</arg>
<description>visibility-desc</description>
</option>
<option>
<name>visibility-miles</name>
<arg>miles</arg>
<description>visibility-miles-desc</description>
</option>
<option>
<name>wind</name>
<arg>DIR[:MAXDIR]@SPEED[:GUST]</arg>
<description>wind-desc</description>
</option>
<option>
<name>random-wind</name>
<description>random-wind-desc</description>
</option>
<option>
<name>turbulence</name>
<arg>0.0 to 1.0</arg>
<description>turbulence-desc</description>
</option>
<option>
<name>ceiling</name>
<arg>FT_ASL[:THICKNESS_FT]</arg>
<description>ceiling-desc</description>
</option>
</section>
<section>
<name>network-options</name>
<option>
<name>callsign</name>
<description>callsign-desc</description>
</option>
<option>
<name>multiplay</name>
<arg>{in|out},hz,address,port</arg>
<description>multiplay-desc</description>
<description>multiple-instance</description>
</option>
<option>
<name>proxy</name>
<arg>[user:pwd@]host:port</arg>
<description>proxy-desc</description>
</option>
<option>
<name>httpd</name>
<arg>port</arg>
<description>httpd-desc</description>
</option>
<option>
<name>telnet</name>
<arg>port</arg>
<description>telnet-desc</description>
</option>
<option>
<name>jpg-httpd</name>
<arg>port</arg>
<description>jpg-httpd-desc</description>
</option>
<option>
<name>disable-terrasync</name>
<description>disable-terrasync-desc</description>
</option>
<option>
<name>enable-terrasync</name>
<description>enable-terrasync-desc</description>
</option>
<option>
<name>terrasync-dir</name>
<description>terrasync-dir-desc</description>
</option>
<option>
<name>enable-fgcom</name>
<description>enable-fgcom-desc</description>
</option>
<option>
<name>disable-fgcom</name>
<description>disable-fgcom-desc</description>
</option>
</section>
<section>
<name>io-options</name>
<option>
<name>generic</name>
<arg>params</arg>
<description>generic-desc</description>
</option>
<option>
<name>atlas</name>
<arg>params</arg>
<description>atlas-desc</description>
</option>
<option>
<name>atcsim</name>
<arg>params</arg>
<description>atcsim-desc</description>
</option>
<option>
<name>AV400</name>
<arg>params</arg>
<description>AV400-desc</description>
</option>
<option>
<name>AV400Sim</name>
<arg>params</arg>
<description>AV400Sim-desc</description>
</option>
<option>
<name>garmin</name>
<arg>params</arg>
<description>garmin-desc</description>
</option>
<option>
<name>joyclient</name>
<arg>params</arg>
<description>joyclient-desc</description>
</option>
<option>
<name>jsclient</name>
<arg>params</arg>
<description>jsclient-desc</description>
</option>
<option>
<name>native-ctrls</name>
<arg>params</arg>
<description>native-ctrls-desc</description>
</option>
<option>
<name>native-gui</name>
<arg>params</arg>
<description>native-gui-desc</description>
</option>
<option>
<name>native-fdm</name>
<arg>params</arg>
<description>native-fdm-desc</description>
</option>
<option>
<name>native</name>
<arg>params</arg>
<description>native-desc</description>
</option>
<option>
<name>nmea</name>
<arg>params</arg>
<description>nmea-desc</description>
</option>
<option>
<name>opengc</name>
<arg>params</arg>
<description>opengc-desc</description>
</option>
<option>
<name>props</name>
<arg>params</arg>
<description>props-desc</description>
</option>
<option>
<name>pve</name>
<arg>params</arg>
<description>pve-desc</description>
</option>
<option>
<name>ray</name>
<arg>params</arg>
<description>ray-desc</description>
</option>
<option>
<name>rul</name>
<arg>params</arg>
<description>rul-desc</description>
</option>
</section>
<section>
<name>debugging-options</name>
<option>
<name>enable-fpe</name>
<description>fpe-desc</description>
</option>
<option>
<name>fgviewer</name>
<description>fgviewer-desc</description>
</option>
<option>
<name>log-level</name>
<arg>{bulk,debug,info,warn,alert}</arg>
<description>log-level-desc</description>
</option>
<option>
<name>log-class</name>
<arg>[ai,environment,flight,general,io,network,sound,terrain,...]</arg>
<description>log-class-desc</description>
</option>
<option>
<name>trace-read</name>
<arg>property</arg>
<description>trace-read-desc</description>
<description>multiple-instance</description>
</option>
<option>
<name>trace-write</name>
<arg>property</arg>
<description>trace-write-desc</description>
<description>multiple-instance</description>
</option>
</section>
</options>
</PropertyList>