Command line options: Difference between revisions

m
corrections after proofreading
(major update on explaining 'options')
m (corrections after proofreading)
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.
'''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>
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>
Line 7: Line 7:


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>
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>
It is sad but true, not even this command is, at least in CVS, 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.
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 this, if it is not set as environmental variable or as option in fgfsrc.




Line 22: Line 22:
                                 Defaults to $FG_ROOT/Scenery
                                 Defaults to $FG_ROOT/Scenery
   (--language=code              Select the language for this session
   (--language=code              Select the language for this session
  *Not* supportet in 1.9.1 and CVS atm!)
                                *Not* supported 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 54: 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
  --ai-sc




Line 68: Line 69:
   --disable-hud-3d            Disable 3D HUD
   --disable-hud-3d            Disable 3D HUD
   --enable-hud-3d              Enable 3D HUD
   --enable-hud-3d              Enable 3D HUD
  --ai-scenario=scenario      Add and enable a new scenario. Multiple options
                                are allowed. Scenarios are in /$FG_ROOT/AI/.




Line 94: Line 98:
   --turbulence=0.0 to 1.0      Specify turbulence from 0.0 (calm) to 1.0
   --turbulence=0.0 to 1.0      Specify turbulence from 0.0 (calm) to 1.0
                                 (severe)
                                 (severe)
   --ceiling=FT_ASL[:THICKNESS_FT]
   --ceiling=FT_ASL[:THICKNESS_FT]
                                 Create an overcast ceiling, optionally with a
                                 Create an overcast ceiling, optionally with a
Line 151: Line 154:
   --enable-enhanced-lighting  Enable enhanced runway lighting
   --enable-enhanced-lighting  Enable enhanced runway lighting
   --season=winter              Enable snow (not falling, yet)
   --season=winter              Enable snow (not falling, yet)
   --disable-distance-attenuation
   --disable-distance-attenuation
                                 Disable runway light distance attenuation
                                 Disable runway light distance attenuation
   --enable-distance-attenuation
   --enable-distance-attenuation
                                 Enable runway light distance attenuation
                                 Enable runway light distance attenuation
   --disable-specular-highlight
   --disable-specular-highlight
                                 Disable specular reflections on textured
                                 Disable specular reflections on textured
Line 199: Line 199:
   --time-match-real            Synchronize time with real-world time
   --time-match-real            Synchronize time with real-world time
   --time-match-local          Synchronize time with local real-world time
   --time-match-local          Synchronize time with local real-world time
   --start-date-sys=yyyy:mm:dd:hh:mm:ss
   --start-date-sys=yyyy:mm:dd:hh:mm:ss
                                 Specify a starting date/time with respect to
                                 Specify a starting date/time with respect to
                                 system time
                                 system time
   --start-date-gmt=yyyy:mm:dd:hh:mm:ss
   --start-date-gmt=yyyy:mm:dd:hh:mm:ss
                                 Specify a starting date/time with respect to
                                 Specify a starting date/time with respect to
                                 Greenwich Mean Time
                                 Greenwich Mean Time
   --start-date-lat=yyyy:mm:dd:hh:mm:ss
   --start-date-lat=yyyy:mm:dd:hh:mm:ss
                                 Specify a starting date/time with respect to
                                 Specify a starting date/time with respect to
Line 224: Line 221:


   --callsign                  assign a unique name to a player
   --callsign                  assign a unique name to a player
   --multiplay={in|out},hz,address,port
   --multiplay={in|out},hz,address,port
                                 Specify multipilot communication settings
                                 Specify multipilot communication settings
Line 293: Line 289:
   --turbulence=0.0 to 1.0      Specify turbulence from 0.0 (calm) to 1.0
   --turbulence=0.0 to 1.0      Specify turbulence from 0.0 (calm) to 1.0
                                 (severe)
                                 (severe)
   --ceiling=FT_ASL[:THICKNESS_FT]
   --ceiling=FT_ASL[:THICKNESS_FT]
                                 Create an overcast ceiling, optionally with a
                                 Create an overcast ceiling, optionally with a
                                 specific thickness (defaults to 2000 ft).
                                 specific thickness (defaults to 2000 ft).
  --random-wind




Line 309: Line 305:
==== Debugging Options ====
==== Debugging Options ====


   --log-level={bulk,debug,info,warn,alert}
   --log-level={bulk|debug|info|warn|alert}
                                 Set the logging level for this session.
                                 Set the logging level for this session.
                                 0=verbose, 5=alerts only
                                 0=verbose, 5=alerts only
392

edits