Command line options

2,007 bytes added, 17:15, 13 October 2009
major update on explaining 'options'
Usage: fgfs [ option ..Command line options are a common way to tell applications what to do/how to act on startup. With [[FlightGear]] they are used for many things, from simple ones like selecting an aircraft up to complex stuff like network traffic and weather parameters.
These parameters can be used in the The easiest way to handle those options for FlightGear (''fgfs'') is using a tool with a graphical user interface like ''[[FlightGear Wizardfgrun]] '' on Windows and GNU/Linux or the Mac OS X GUI-Launcher. This way one don't have tobother 'bout them at all. <BR>However, there are users who don't want or are not able to run a GUI and therefore are interested in this. Those who need them or just want to learn more about GlightGear, but have no idea what we are talking about, may read the wiki page on the general usage of the [[FlightGear 1.0 aircraft names for command line]] can be useful depending on what version and aircraft are installed.
ThereA good place to store the personal options is a file called [[fgfsrc]]. This file is read by 's also 'fgfs'' on each startup. The following lists show the options for ''fgfs'' including a wiki page short description and sorted by categories. Please have in mind that keeping those lists up to date on the general usage wiki is not an easy task. Also there are different versions of FlightGear out there which don't share exactly the [[same options. Therefore you better also check your versions ones with <code>fgfs --help --verbose</code>. If this command line]fails, you may add the option <code>--fg-root=[path]</code> as well, see below.<BR>It is sad but true, for those who might not know about even this magic thing yetcommand is up to date all the time.At the time of writing at least one option which is supported is not shown with <code>fgfs --help --verbose</code>. So if you have serious issues with an option, the source code is, as always, also the best source for info. In the file ''src/Main/options.cxx'' all the options are listed with their hard coded ''default'' setting and type.<BR>The file $FG_ROOT/options.xml is used to generate the output for <code>fgfs --help [--verbose]</code>. That's the reason why <code>--fg-root=[path]</code> has to be added to <code>fgfs --help --verbose</code> if it is not set as environmental variable or in fgfsrc.  Usage: <code>fgfs [OPTION [OPTION ...]]</code>
==== General Options ====
--help, -h Show the most relevant command line options
--verbose, -v Show all command line options when combined
--fg-scenery=path[:path...] Specify the base scenery path;
Defaults to $FG_ROOT/Scenery
(--language=code Select the language for this session *Not* supportet in 1.9.1 and CVS atm!)
--disable-game-mode Disable full-screen game mode
--enable-game-mode Enable full-screen game mode
--control=mode Primary control mode (joystick, keyboard,
--enable-auto-coordination Enable auto coordination - rudder and ailerons will be controlled together
--disable-auto-coordination Disable auto coordination (default)
--browser-app=path Specify path to your web browser
--units-feet Use feet for distances
--units-meters Use meters for distances
==== Features ====
--disable-panel Disable instrument panel
--enable-panel Enable instrument panel
--disable-hud-3d Disable 3D HUD
--enable-hud-3d Enable 3D HUD
==== Aircraft ====
--aircraft=name Select an aircraft profile as defined by a top
level -set.xml
==== Flight Model ====
--fdm=name Select the core flight dynamics model
Can be one of jsb, larcsim, yasim, magic,
==== Aircraft model directory (UIUC FDM ONLY) ====
--aircraft-dir=path Aircraft directory relative to the path of the
==== Initial Position and Orientation ====
--airport=ID Specify starting position relative to an
==== Rendering Options ====
--bpp=depth Specify the bits per pixel
--fog-disable Disable fog/haze
--visibility=meters Specify initial visibility
--visibility-miles=miles Specify initial visibility in miles
==== Hud Options ====
--hud-tris Hud displays number of triangles rendered
--hud-culled Hud displays percentage of triangles culled
==== Network Options ====
--httpd=port Enable http server on the specified port
--telnet=port Enable telnet server on the specified port
==== MultiPlayer Options ====
--callsign assign a unique name to a player
==== Route/Way Point Options ====
--wp=ID[@alt] Specify a waypoint for the GC autopilot;
multiple instances can be used
==== IO Options ====
--generic=params Open connection using a predefined
communication interface and a preselected
--rul=params Open connection using the RUL protocol
--atc610x Enable atc610x interface
==== Avionics Options ====
--nav1=[radial:]frequency Set the NAV1 radio frequency, optionally
preceded by a radial.
--dme={nav1|nav2|frequency} Slave the ADF to one of the NAV radios, or set
its internal frequency.
==== Environment Options ====
--trace-write=property Trace the writes for a property;
multiple instances can be used
[[FlightGear 1.0 aircraft names for command line]] can be useful depending on what version and aircraft are installed.