392
edits
Command line options: Difference between revisions
major update on explaining 'options'
m (moved Command Line Parameters to Command Line Options: 'parameter' is not the common term, most users will search for 'option'. I'll create a #REDIRECT with the old name.) |
(major update on explaining 'options') |
||
| Line 1: | Line 1: | ||
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. | |||
The easiest way to handle those options for FlightGear (''fgfs'') is using a tool with a graphical user interface like ''[[fgrun]]'' on Windows and GNU/Linux or the Mac OS X GUI-Launcher. This way one don't have to bother '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 [[command line]]. | |||
A good place to store the personal options is a file called [[fgfsrc]]. This file is read by ''fgfs'' on each startup. | |||
The following lists show the options for ''fgfs'' including a short description and sorted by categories. Please have in mind that keeping those lists up to date on the 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 fails, you may add the option <code>--fg-root=[path]</code> as well, see below.<BR> | |||
It is sad but true, not even this command 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 ==== | ==== General Options ==== | ||
--help, -h Show the most relevant command line options | --help, -h Show the most relevant command line options | ||
--verbose, -v Show all command line options when combined | --verbose, -v Show all command line options when combined | ||
| Line 12: | Line 21: | ||
--fg-scenery=path[:path...] Specify the base scenery path; | --fg-scenery=path[:path...] Specify the base scenery path; | ||
Defaults to $FG_ROOT/Scenery | 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 | --disable-game-mode Disable full-screen game mode | ||
--enable-game-mode Enable full-screen game mode | --enable-game-mode Enable full-screen game mode | ||
| Line 36: | Line 46: | ||
--control=mode Primary control mode (joystick, keyboard, | --control=mode Primary control mode (joystick, keyboard, | ||
mouse) | mouse) | ||
--enable-auto-coordination Enable auto coordination - rudder and ailerons will be controlled together | --enable-auto-coordination Enable auto coordination - rudder and | ||
ailerons will be controlled together | |||
--disable-auto-coordination Disable auto coordination (default) | --disable-auto-coordination Disable auto coordination (default) | ||
--browser-app=path Specify path to your web browser | --browser-app=path Specify path to your web browser | ||
| Line 43: | Line 54: | ||
--units-feet Use feet for distances | --units-feet Use feet for distances | ||
--units-meters Use meters for distances | --units-meters Use meters for distances | ||
==== Features ==== | ==== Features ==== | ||
--disable-panel Disable instrument panel | --disable-panel Disable instrument panel | ||
--enable-panel Enable instrument panel | --enable-panel Enable instrument panel | ||
| Line 55: | Line 68: | ||
--disable-hud-3d Disable 3D HUD | --disable-hud-3d Disable 3D HUD | ||
--enable-hud-3d Enable 3D HUD | --enable-hud-3d Enable 3D HUD | ||
==== Aircraft ==== | ==== Aircraft ==== | ||
--aircraft=name Select an aircraft profile as defined by a top | --aircraft=name Select an aircraft profile as defined by a top | ||
level -set.xml | level -set.xml | ||
| Line 64: | Line 79: | ||
==== Flight Model ==== | ==== Flight Model ==== | ||
--fdm=name Select the core flight dynamics model | --fdm=name Select the core flight dynamics model | ||
Can be one of jsb, larcsim, yasim, magic, | Can be one of jsb, larcsim, yasim, magic, | ||
| Line 85: | Line 101: | ||
==== Aircraft model directory (UIUC FDM ONLY) ==== | ==== Aircraft model directory (UIUC FDM ONLY) ==== | ||
--aircraft-dir=path Aircraft directory relative to the path of the | --aircraft-dir=path Aircraft directory relative to the path of the | ||
executable | executable | ||
| Line 90: | Line 107: | ||
==== Initial Position and Orientation ==== | ==== Initial Position and Orientation ==== | ||
--airport=ID Specify starting position relative to an | --airport=ID Specify starting position relative to an | ||
airport | airport | ||
| Line 121: | Line 139: | ||
==== Rendering Options ==== | ==== Rendering Options ==== | ||
--bpp=depth Specify the bits per pixel | --bpp=depth Specify the bits per pixel | ||
--fog-disable Disable fog/haze | --fog-disable Disable fog/haze | ||
| Line 165: | Line 184: | ||
--visibility=meters Specify initial visibility | --visibility=meters Specify initial visibility | ||
--visibility-miles=miles Specify initial visibility in miles | --visibility-miles=miles Specify initial visibility in miles | ||
==== Hud Options ==== | ==== Hud Options ==== | ||
--hud-tris Hud displays number of triangles rendered | --hud-tris Hud displays number of triangles rendered | ||
--hud-culled Hud displays percentage of triangles culled | --hud-culled Hud displays percentage of triangles culled | ||
| Line 193: | Line 214: | ||
==== Network Options ==== | ==== Network Options ==== | ||
--httpd=port Enable http server on the specified port | --httpd=port Enable http server on the specified port | ||
--telnet=port Enable telnet server on the specified port | --telnet=port Enable telnet server on the specified port | ||
| Line 200: | Line 222: | ||
==== MultiPlayer Options ==== | ==== MultiPlayer Options ==== | ||
--callsign assign a unique name to a player | --callsign assign a unique name to a player | ||
| Line 208: | Line 231: | ||
==== Route/Way Point Options ==== | ==== Route/Way Point Options ==== | ||
--wp=ID[@alt] Specify a waypoint for the GC autopilot; | --wp=ID[@alt] Specify a waypoint for the GC autopilot; | ||
multiple instances can be used | multiple instances can be used | ||
| Line 214: | Line 238: | ||
==== IO Options ==== | ==== IO Options ==== | ||
--generic=params Open connection using a predefined | --generic=params Open connection using a predefined | ||
communication interface and a preselected | communication interface and a preselected | ||
| Line 234: | Line 259: | ||
--rul=params Open connection using the RUL protocol | --rul=params Open connection using the RUL protocol | ||
--atc610x Enable atc610x interface | --atc610x Enable atc610x interface | ||
==== Avionics Options ==== | ==== Avionics Options ==== | ||
--nav1=[radial:]frequency Set the NAV1 radio frequency, optionally | --nav1=[radial:]frequency Set the NAV1 radio frequency, optionally | ||
preceded by a radial. | preceded by a radial. | ||
| Line 244: | Line 271: | ||
--dme={nav1|nav2|frequency} Slave the ADF to one of the NAV radios, or set | --dme={nav1|nav2|frequency} Slave the ADF to one of the NAV radios, or set | ||
its internal frequency. | its internal frequency. | ||
==== Environment Options ==== | ==== Environment Options ==== | ||
| Line 288: | Line 316: | ||
--trace-write=property Trace the writes for a property; | --trace-write=property Trace the writes for a property; | ||
multiple instances can be used | multiple instances can be used | ||
[[FlightGear 1.0 aircraft names for command line]] can be useful depending on what version and aircraft are installed. | |||
[[Category:List]] | [[Category:List]] | ||