Difference between revisions of "Command line options"

From FlightGear wiki
Jump to: navigation, search
(Avionics Options: com1 and com2 missing from the list)
(Debugging Options: See also Commonly used debugging tools#fgfs.log)
 
(26 intermediate revisions by 3 users not shown)
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 is using a tool with a graphical user interface like the [[FlightGear Qt launcher]]. This way one don't have to bother about them at all.
+
The easiest way to handle those options for FlightGear is using a tool with a graphical user interface like the [[FlightGear Qt launcher]]. This way one doesn't have to bother about them at all.
  
 
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 FlightGear, but have no idea what we are talking about, may read the wiki page on the general usage of the [[command line]].
 
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 FlightGear, but have no idea what we are talking about, may read the wiki page on the general usage of the [[command line]].
Line 23: Line 23:
 
  --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
+
  --fg-aircraft=path          Specify additional aircraft directory path(s)
                                *Not* supported in 1.9.1 and Git atm!)
+
                                (alternatively, you can use --aircraft-dir to
 +
                                target a specific aircraft in a given
 +
                                directory)
 +
--language=code              Select the language for this session
 
  --launcher                  Enable Qt launcher  
 
  --launcher                  Enable Qt launcher  
--disable-fullscreen        Disable full-screen game mode
 
--enable-fullscreen          Enable full-screen game mode
 
 
  --disable-splash-screen      Disable splash screen
 
  --disable-splash-screen      Disable splash screen
 
  --enable-splash-screen      Enable splash screen
 
  --enable-splash-screen      Enable splash screen
Line 40: Line 41:
 
                                 (This also disables showing the models of other
 
                                 (This also disables showing the models of other
 
                                 multiplayer aircraft)
 
                                 multiplayer aircraft)
  --enable-ai-models          Enable the AI subsystem.
+
--enable-ai-models          Enable the AI subsystem.
  --disable-ai-traffic        Disable the autogenerated traffic subsystem.
+
--disable-ai-traffic        Disable the autogenerated traffic subsystem.
  --enable-ai-traffic          Enable the autogenerated traffic subsystem.
+
--enable-ai-traffic          Enable the autogenerated traffic subsystem.
  --disable-freeze            Start in a running state
+
--disable-freeze            Start in a running state
  --enable-freeze              Start in a frozen state
+
--enable-freeze              Start in a frozen state
  --disable-fuel-freeze        Fuel is consumed normally
+
--disable-fuel-freeze        Fuel is consumed normally
  --enable-fuel-freeze        Fuel tank quantity forced to remain constant
+
--enable-fuel-freeze        Fuel tank quantity forced to remain constant
  --disable-clock-freeze      Clock advances normally
+
--disable-clock-freeze      Clock advances normally
  --enable-clock-freeze        Do not advance clock
+
--enable-clock-freeze        Do not advance clock
  --enable-auto-coordination  Enable auto coordination - rudder and
+
--enable-auto-coordination  Enable auto coordination - rudder and
                                ailerons will be controlled together
+
                              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
  --prop:name=value            Set property to  
+
--prop:foo=bar              Set property named "foo" to value "bar"
  --config=path                Load additional properties from path
+
--config=path                Load additional properties from path
  --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
+
  
 
==== Features ====
 
==== Features ====
  
  --disable-panel              Disable instrument panel
+
--disable-panel              Disable instrument panel
  --enable-panel              Enable instrument panel
+
--enable-panel              Enable instrument panel
  --disable-sound              Disable sound effects
+
--disable-sound              Disable sound effects
  --enable-sound              Enable sound effects
+
--enable-sound              Enable sound effects
  --disable-hud                Disable Heads Up Display (HUD)
+
--ai-scenario=scenario      Add and enable a new scenario. Multiple options
  --enable-hud                Enable Heads Up Display (HUD)
+
                              are allowed. Scenarios are in /[[$FG_ROOT]]/AI/.
  --disable-anti-alias-hud    Disable anti-aliased HUD
+
  --enable-anti-alias-hud      Enable anti-aliased HUD
+
  --disable-hud-3d            Disable 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/.
+
 
+
 
+
  
 
==== 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
  --aircraft-dir=path          Specify the exact directory to use for the
+
--aircraft-dir=path          Specify the exact directory to use for the
                                aircraft (normally not required, but may be
+
                              aircraft (normally not required, but may be
                                useful). Interpreted relatively to the
+
                              useful). Interpreted relatively to the
                                current directory. Causes the <path-cache>
+
                              current directory. Causes the <path-cache>
                                from autosave_X_Y.xml, as well as
+
                              from autosave_X_Y.xml, as well as
                                --fg-aircraft options and the FG_AIRCRAFT
+
                              --fg-aircraft options and the FG_AIRCRAFT
                                environment variable to be bypassed.
+
                              environment variable to be bypassed.
  --show-aircraft              Print a list of the currently available
+
--show-aircraft              Print a list of the currently available
                                aircraft types
+
                              aircraft types
  
 
==== 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,
                                balloon, ada, external, or null
+
                              balloon, ada, external, or null
  --aero=name                  Select aircraft aerodynamics model to load
+
--aero=name                  Select aircraft aerodynamics model to load
  --model-hz=n                Run the FDM this rate (iterations per second)
+
--model-hz=n                Run the FDM this rate (iterations per second)
  --speed=n                    Run the FDM 'n' times faster than real time
+
--speed=n                    Run the FDM 'n' times faster than real time
  --notrim                    Do NOT attempt to trim the model
+
--notrim                    Do NOT attempt to trim the model
                                (only with fdm=jsbsim)
+
                              (only with fdm=jsbsim)
  --on-ground                  Start at ground level (default)
+
--on-ground                  Start at ground level (default)
  --in-air                    Start in air (implied when using --altitude)
+
--in-air                    Start in air (implied when using --altitude)
  --wind=DIR@SPEED            Specify wind coming from DIR (degrees) at SPEED
+
                                (knots)
+
  --turbulence=0.0 to 1.0      Specify turbulence from 0.0 (calm) to 1.0
+
                                (severe)
+
  --ceiling=FT_ASL[:THICKNESS_FT]
+
                                Create an overcast ceiling, optionally with a
+
                                specific thickness (defaults to 2000 ft).
+
 
+
  
 
==== Initial Position and Orientation ====
 
==== Initial Position and Orientation ====
  
  --airport=ID                Specify airport (e.g. KOAK)
+
--airport=ID                Specify airport (e.g. KOAK)
  --runway=rwy_no              Specify starting runway (must also specify an
+
--runway=rwy_no              Specify starting runway (must also specify an
                                airport)
+
                              airport)
  --vor=ID                    Specify starting position relative to a VOR
+
--vor=ID                    Specify starting position relative to a VOR
  --ndb=ID                    Specify starting position relative to an NDB
+
--ndb=ID                    Specify starting position relative to an NDB
  --fix=ID                    Specify starting position relative to a fix
+
--fix=ID                    Specify starting position relative to a fix
  --parkpos=NAME              Specify a gate at the airport (e.g. 747d11)
+
--parkpos=NAME              Specify a gate at the airport (e.g. 747d11)
  --offset-distance=nm        Specify distance to reference point (statute
+
--offset-distance=nm        Specify distance to reference point (statute
                                miles)
+
                              miles)
  --offset-azimuth=degrees    Specify heading to reference point
+
--offset-azimuth=degrees    Specify heading to reference point
  --lon=degrees                Starting longitude (west = -)
+
--lon=degrees                Starting longitude (west = -)
  --lat=degrees                Starting latitude (south = -)
+
--lat=degrees                Starting latitude (south = -)
  --altitude=value            Starting altitude
+
--altitude=value            Starting altitude
                                (in feet unless --units-meters specified)
+
                              (in feet unless --units-meters specified)
  --heading=degrees            Specify heading (yaw) angle (Psi)
+
--heading=degrees            Specify heading (yaw) angle (Psi)
  --roll=degrees              Specify roll angle (Phi)
+
--roll=degrees              Specify roll angle (Phi)
  --pitch=degrees              Specify pitch angle (Theta)
+
--pitch=degrees              Specify pitch angle (Theta)
  --uBody=units_per_sec        Specify velocity along the body X axis
+
--uBody=units_per_sec        Specify velocity along the body X axis
                                (in feet unless --units-meters specified)
+
                              (in feet unless --units-meters specified)
  --vBody=units_per_sec        Specify velocity along the body Y axis
+
--vBody=units_per_sec        Specify velocity along the body Y axis
                                (in feet unless --units-meters specified)
+
                              (in feet unless --units-meters specified)
  --wBody=units_per_sec        Specify velocity along the body Z axis
+
--wBody=units_per_sec        Specify velocity along the body Z axis
                                (in feet unless --units-meters specified)
+
                              (in feet unless --units-meters specified)
  --vc=knots                  Specify initial airspeed
+
--vc=knots                  Specify initial airspeed
  --mach=num                  Specify initial mach number
+
--mach=num                  Specify initial mach number
  --glideslope=degrees        Specify flight path angle (can be positive)
+
--glideslope=degrees        Specify flight path angle (can be positive)
  --roc=fpm                    Specify initial climb rate (can be negative)
+
--roc=fpm                    Specify initial climb rate (can be negative)
  
 
==== 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
  --fog-fastest                Enable fastest fog/haze
+
--fog-fastest                Enable fastest fog/haze
  --fog-nicest                Enable nicest fog/haze
+
--fog-nicest                Enable nicest fog/haze
  --disable-horizon-effect    Disable celestial body growth illusion near the
+
--disable-horizon-effect    Disable celestial body growth illusion near the
                                horizon
+
                              horizon
  --enable-horizon-effect      Enable celestial body growth illusion near the
+
--enable-horizon-effect      Enable celestial body growth illusion near the
                                horizon
+
                              horizon
  --disable-enhanced-lighting  Disable enhanced runway lighting
+
--disable-enhanced-lighting  Disable enhanced runway lighting
  --enable-enhanced-lighting  Enable enhanced runway lighting
+
--enable-enhanced-lighting  Enable enhanced runway lighting
  --season=winter              Enable snow covered scenery
+
--season=winter              Enable snow covered scenery
  --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
                                objects
+
                              objects
  --enable-specular-highlight  Enable specular reflections on textured objects
+
--enable-specular-highlight  Enable specular reflections on textured objects
  --enable-clouds              Enable 2D (flat) cloud layers
+
--enable-clouds              Enable 2D (flat) cloud layers
  --disable-clouds            Disable 2D (flat) cloud layers
+
--disable-clouds            Disable 2D (flat) cloud layers
  --enable-clouds3d            Enable 3D (volumetric) cloud layers
+
--enable-clouds3d            Enable 3D (volumetric) cloud layers
  --disable-clouds3d          Disable 3D (volumetric) cloud layers
+
--disable-clouds3d          Disable 3D (volumetric) cloud layers
  --fov=degrees                Specify field of view angle
+
--fov=degrees                Specify field of view angle
  --disable-fullscreen        Disable fullscreen mode
+
--disable-fullscreen        Disable fullscreen mode
  --enable-fullscreen          Enable fullscreen mode
+
--enable-fullscreen          Enable fullscreen mode
  --shading-flat              Enable flat shading
+
--shading-flat              Enable flat shading
  --shading-smooth            Enable smooth shading
+
--shading-smooth            Enable smooth shading
  --disable-wireframe          Disable wireframe drawing mode
+
--disable-wireframe          Disable wireframe drawing mode
  --enable-wireframe          Enable wireframe drawing mode
+
--enable-wireframe          Enable wireframe drawing mode
  --geometry=WxH              Specify window geometry (640x480, etc)
+
--geometry=WxH              Specify window geometry/resolution (640x480, etc)
  --view-offset=value          Specify the default forward view direction as
+
--view-offset=value          Specify the default forward view direction as
                                an offset from straight ahead. Allowable values
+
                              an offset from straight ahead. Allowable values
                                are LEFT, RIGHT, CENTER, or a specific number
+
                              are LEFT, RIGHT, CENTER, or a specific number
                                in degrees
+
                              in degrees
  --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
  --texture-filtering=number  Specify anisotropic filtering of terrain textures. Valid values is 1, 2, 4, 8, 16. Default is 1.
+
--texture-filtering=number  Specify anisotropic filtering of terrain textures. Valid values is 1, 2, 4, 8, 16. Default is 1.
  
 
==== Hud Options ====
 
==== Hud Options ====
  
  --hud-tris                  Hud displays number of triangles rendered
+
--disable-hud                Disable Heads Up Display (HUD)
  --hud-culled                Hud displays percentage of triangles culled
+
--enable-hud                Enable Heads Up Display (HUD)
 
+
--disable-anti-alias-hud    Disable anti-aliased HUD
 +
--enable-anti-alias-hud      Enable anti-aliased HUD
 +
--disable-hud-3d            Disable 3D HUD
 +
--enable-hud-3d              Enable 3D HUD
 +
--hud-tris                  Hud displays number of triangles rendered
 +
--hud-culled                Hud displays percentage of triangles culled
  
 
==== Time Options ====
 
==== Time Options ====
  
  --timeofday={dawn,noon,dusk,midnight}
+
--timeofday={dawn,noon,dusk,midnight}
                                Specify a time of day
+
                              Specify a time of day
  --time-offset=[+-]hh:mm:ss  Add this time offset
+
--time-offset=[+-]hh:mm:ss  Add this time offset
  --time-match-real            Synchronize time with current time at chosen airport
+
--time-match-real            Synchronize time with current time at chosen airport
  --time-match-local          Synchronize time with system time of computer
+
--time-match-local          Synchronize time with system time of computer
  --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
                                Local Aircraft Time
+
                              Local Aircraft Time
  
 
==== 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
  --jpg-httpd=port            Enable screen shot http server on the specified
+
--jpg-httpd=port            Enable screen shot http server on the specified
 
                                 port
 
                                 port
 
  
 
==== MultiPlayer Options ====
 
==== MultiPlayer Options ====
  
  --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
                                multiple instances can be used
+
                              multiple instances can be used
 
+
  
 
==== 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
  --flight-plan=file          Read all waypoints from a file
+
--flight-plan=file          Read all waypoints from a file
 
+
  
 
==== 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
                                communication protocol
+
                              communication protocol
  --garmin=params              Open connection using the Garmin GPS protocol
+
--garmin=params              Open connection using the Garmin GPS protocol
  --joyclient=params          Open connection to an Agwagon joystick
+
--joyclient=params          Open connection to an Agwagon joystick
  --jsclient=params            Open connection to a remote joystick
+
--jsclient=params            Open connection to a remote joystick
  --native-ctrls=params        Open connection using the FG Native Controls
+
--native-ctrls=params        Open connection using the FG Native Controls
                                protocol
+
                              protocol
  --native-fdm=params          Open connection using the FG Native FDM
+
--native-fdm=params          Open connection using the FG Native FDM
                                protocol
+
                              protocol
  --native=params              Open connection using the FG Native protocol
+
--native=params              Open connection using the FG Native protocol
  --nmea=params                Open connection using the NMEA protocol
+
--nmea=params                Open connection using the NMEA protocol
  --opengc=params              Open connection using the OpenGC protocol
+
--opengc=params              Open connection using the OpenGC protocol
  --props=params              Open connection using the interactive property
+
--props=params              Open connection using the interactive property
                                manager (LEGACY/DEAD DO NOT USE same as --telnet)
+
                              manager (LEGACY/DEAD DO NOT USE same as --telnet)
  --pve=params                Open connection using the PVE protocol
+
--pve=params                Open connection using the PVE protocol
  --ray=params                Open connection using the Ray Woodworth motion
+
--ray=params                Open connection using the Ray Woodworth motion
                                chair protocol
+
                              chair protocol
  --rul=params                Open connection using the RUL protocol
+
--rul=params                Open connection using the RUL protocol
  --atc610x                    Enable atc610x interface
+
--atc610x                    Enable atc610x interface
  
 
Under Windows, you must use a special escape sequence if you need to specify a COM port higher than 9.
 
Under Windows, you must use a special escape sequence if you need to specify a COM port higher than 9.
Line 259: Line 245:
 
==== Avionics Options ====
 
==== Avionics Options ====
  
  --com1=frequency            Set the COM1 radio frequency.
+
--com1=frequency            Set the COM1 radio frequency.
  --com2=frequency            Set the COM2 radio frequency.
+
--com2=frequency            Set the COM2 radio frequency.
  --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.
  --nav2=[radial:]frequency    Set the NAV2 radio frequency, optionally
+
--nav2=[radial:]frequency    Set the NAV2 radio frequency, optionally
                                preceded by a radial.
+
                              preceded by a radial.
  --adf=[rotation:]frequency  Set the ADF radio frequency, optionally
+
--adf=[rotation:]frequency  Set the ADF radio frequency, optionally
                                preceded by a card rotation.
+
                              preceded by a card rotation.
  --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 ====
  
  --disable-real-weather-fetch
+
--disable-real-weather-fetch Disable METAR based real weather fetching
                                Disable METAR based real weather fetching
+
--enable-real-weather-fetch  Enable METAR based real weather fetching (this
  --enable-real-weather-fetch  Enable METAR based real weather fetching (this
+
                              requires an open internet connection)
                                requires an open internet connection)
+
--disable-horizon-effect    Disable celestial body growth illusion near the
  --disable-horizon-effect    Disable celestial body growth illusion near the
+
                              horizon
                                horizon
+
--enable-horizon-effect      Enable celestial body growth illusion near the
  --enable-horizon-effect      Enable celestial body growth illusion near the
+
                              horizon
                                horizon
+
--enable-clouds              Enable 2D (flat) cloud layers
  --enable-clouds              Enable 2D (flat) cloud layers
+
--disable-clouds            Disable 2D (flat) cloud layers
  --disable-clouds            Disable 2D (flat) cloud layers
+
--enable-clouds3d            Enable 3D (volumetric) cloud layers
  --enable-clouds3d            Enable 3D (volumetric) cloud layers
+
--disable-clouds3d          Disable 3D (volumetric) cloud layers
  --disable-clouds3d          Disable 3D (volumetric) cloud layers
+
--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
+
--wind=DIR@SPEED            Specify wind coming from DIR (degrees) at SPEED
  --wind=DIR@SPEED            Specify wind coming from DIR (degrees) at SPEED
+
                              (knots)
                                (knots)
+
--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
  --random-wind
+
--metar="metar string"      Starts with a certain METAR string. Only works if live weather is disabled.
  --metar="metar string"      Starts with a certain METAR string. Only works if live weather is disabled.
+
  
 
==== Situation Options ====
 
==== Situation Options ====
  
  --failure={pitot|static|system|vacuum}
+
--failure={pitot|static|system|vacuum}
                                Fail the pitot, static, vacuum, or electrical
+
                              Fail the pitot, static, vacuum, or electrical
                                system (repeat the option for multiple system
+
                              system (repeat the option for multiple system
                                failures).
+
                              failures).
 
+
  
 
==== 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
  --pid=/pathto/some/file.pid  Write current PID into file.
+
                              See also [[Commonly used debugging tools#fgfs.log]]
  --trace-read=property        Trace the reads for a property;
+
--pid=/pathto/some/file.pid  Write current PID into file.
                                multiple instances can be used
+
--trace-read=property        Trace the reads for a property;
  --trace-write=property      Trace the writes for a property;
+
                              multiple instances can be used
                                multiple instances can be used
+
--trace-write=property      Trace the writes for a property;
 +
                              multiple instances can be used
  
 
== Related content ==
 
== Related content ==
Line 324: Line 309:
 
* {{flightgear file|src/Main/options.cxx}}
 
* {{flightgear file|src/Main/options.cxx}}
  
 +
[[Category:FlightGear]]
 
[[Category:Lists]]
 
[[Category:Lists]]
  
 
[[de:Command Line Options]]
 
[[de:Command Line Options]]
 
[[fr:Options de ligne de commande]]
 
[[fr:Options de ligne de commande]]

Latest revision as of 04:22, 27 September 2020

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 is using a tool with a graphical user interface like the FlightGear Qt launcher. This way one doesn't have to bother about them at all.

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 FlightGear, 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 FlightGear on each startup.

The following lists show the options for FlightGear 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 fgfs --help --verbose. If this command fails, you may add the option --fg-root=[path] as well, see below.

It is sad but true, not even this command is, at least in Git, up to date all the time. At the time of writing at least one option which is supported is not shown with fgfs --help --verbose. 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.

The file $FG_ROOT/options.xml is used to generate the output for fgfs --help [--verbose]. That's the reason why --fg-root=[path] has to be added to this, if it is not set as environmental variable or as option in fgfsrc.


Usage: fgfs [OPTION [OPTION ...]]

General Options

--help, -h                   Show the most relevant command line options
--verbose, -v                Show all command line options when combined with --help or -h
--fg-root=path               Specify the root data path
--fg-scenery=path[:path...]  Specify the base scenery path;
                               Defaults to $FG_ROOT/Scenery
--fg-aircraft=path           Specify additional aircraft directory path(s)
                               (alternatively, you can use --aircraft-dir to
                               target a specific aircraft in a given
                               directory)
--language=code              Select the language for this session
--launcher                   Enable Qt launcher 
--disable-splash-screen      Disable splash screen
--enable-splash-screen       Enable splash screen
--disable-mouse-pointer      Disable extra mouse pointer
--enable-mouse-pointer       Enable extra mouse pointer
                               (i.e. for full screen Voodoo based cards)
--disable-random-objects     Exclude random scenery objects
                               (buildings, etc.)
--enable-random-objects      Include random scenery objects
                               (buildings, etc.)
--disable-ai-models          Disable the AI subsystem.
                               (This also disables showing the models of other
                                multiplayer aircraft)
--enable-ai-models           Enable the AI subsystem.
--disable-ai-traffic         Disable the autogenerated traffic subsystem.
--enable-ai-traffic          Enable the autogenerated traffic subsystem.
--disable-freeze             Start in a running state
--enable-freeze              Start in a frozen state
--disable-fuel-freeze        Fuel is consumed normally
--enable-fuel-freeze         Fuel tank quantity forced to remain constant
--disable-clock-freeze       Clock advances normally
--enable-clock-freeze        Do not advance clock
--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
--prop:foo=bar               Set property named "foo" to value "bar"
--config=path                Load additional properties from path
--units-feet                 Use feet for distances
--units-meters               Use meters for distances

Features

--disable-panel              Disable instrument panel
--enable-panel               Enable instrument panel
--disable-sound              Disable sound effects
--enable-sound               Enable sound effects
--ai-scenario=scenario       Add and enable a new scenario. Multiple options
                             are allowed. Scenarios are in /$FG_ROOT/AI/.

Aircraft

--aircraft=name              Select an aircraft profile as defined by a top
                             level -set.xml
--aircraft-dir=path          Specify the exact directory to use for the
                             aircraft (normally not required, but may be
                             useful). Interpreted relatively to the
                             current directory. Causes the <path-cache>
                             from autosave_X_Y.xml, as well as
                             --fg-aircraft options and the FG_AIRCRAFT
                             environment variable to be bypassed.
--show-aircraft              Print a list of the currently available
                             aircraft types

Flight Model

--fdm=name                   Select the core flight dynamics model
                             Can be one of jsb, larcsim, yasim, magic,
                             balloon, ada, external, or null
--aero=name                  Select aircraft aerodynamics model to load
--model-hz=n                 Run the FDM this rate (iterations per second)
--speed=n                    Run the FDM 'n' times faster than real time
--notrim                     Do NOT attempt to trim the model
                             (only with fdm=jsbsim)
--on-ground                  Start at ground level (default)
--in-air                     Start in air (implied when using --altitude)

Initial Position and Orientation

--airport=ID                 Specify airport (e.g. KOAK)
--runway=rwy_no              Specify starting runway (must also specify an
                             airport)
--vor=ID                     Specify starting position relative to a VOR
--ndb=ID                     Specify starting position relative to an NDB
--fix=ID                     Specify starting position relative to a fix
--parkpos=NAME               Specify a gate at the airport (e.g. 747d11)
--offset-distance=nm         Specify distance to reference point (statute
                             miles)
--offset-azimuth=degrees     Specify heading to reference point
--lon=degrees                Starting longitude (west = -)
--lat=degrees                Starting latitude (south = -)
--altitude=value             Starting altitude
                             (in feet unless --units-meters specified)
--heading=degrees            Specify heading (yaw) angle (Psi)
--roll=degrees               Specify roll angle (Phi)
--pitch=degrees              Specify pitch angle (Theta)
--uBody=units_per_sec        Specify velocity along the body X axis
                             (in feet unless --units-meters specified)
--vBody=units_per_sec        Specify velocity along the body Y axis
                             (in feet unless --units-meters specified)
--wBody=units_per_sec        Specify velocity along the body Z axis
                             (in feet unless --units-meters specified)
--vc=knots                   Specify initial airspeed
--mach=num                   Specify initial mach number
--glideslope=degrees         Specify flight path angle (can be positive)
--roc=fpm                    Specify initial climb rate (can be negative)

Rendering Options

--bpp=depth                  Specify the bits per pixel
--fog-disable                Disable fog/haze
--fog-fastest                Enable fastest fog/haze
--fog-nicest                 Enable nicest fog/haze
--disable-horizon-effect     Disable celestial body growth illusion near the
                             horizon
--enable-horizon-effect      Enable celestial body growth illusion near the
                             horizon
--disable-enhanced-lighting  Disable enhanced runway lighting
--enable-enhanced-lighting   Enable enhanced runway lighting
--season=winter              Enable snow covered scenery
--disable-distance-attenuation
                             Disable runway light distance attenuation
--enable-distance-attenuation
                             Enable runway light distance attenuation
--disable-specular-highlight
                             Disable specular reflections on textured
                             objects
--enable-specular-highlight  Enable specular reflections on textured objects
--enable-clouds              Enable 2D (flat) cloud layers
--disable-clouds             Disable 2D (flat) cloud layers
--enable-clouds3d            Enable 3D (volumetric) cloud layers
--disable-clouds3d           Disable 3D (volumetric) cloud layers
--fov=degrees                Specify field of view angle
--disable-fullscreen         Disable fullscreen mode
--enable-fullscreen          Enable fullscreen mode
--shading-flat               Enable flat shading
--shading-smooth             Enable smooth shading
--disable-wireframe          Disable wireframe drawing mode
--enable-wireframe           Enable wireframe drawing mode
--geometry=WxH               Specify window geometry/resolution (640x480, etc)
--view-offset=value          Specify the default forward view direction as
                             an offset from straight ahead. Allowable values
                             are LEFT, RIGHT, CENTER, or a specific number
                             in degrees
--visibility=meters          Specify initial visibility
--visibility-miles=miles     Specify initial visibility in miles
--texture-filtering=number   Specify anisotropic filtering of terrain textures. Valid values is 1, 2, 4, 8, 16. Default is 1.

Hud Options

--disable-hud                Disable Heads Up Display (HUD)
--enable-hud                 Enable Heads Up Display (HUD)
--disable-anti-alias-hud     Disable anti-aliased HUD
--enable-anti-alias-hud      Enable anti-aliased HUD
--disable-hud-3d             Disable 3D HUD
--enable-hud-3d              Enable 3D HUD
--hud-tris                   Hud displays number of triangles rendered
--hud-culled                 Hud displays percentage of triangles culled

Time Options

--timeofday={dawn,noon,dusk,midnight}
                             Specify a time of day
--time-offset=[+-]hh:mm:ss   Add this time offset
--time-match-real            Synchronize time with current time at chosen airport
--time-match-local           Synchronize time with system time of computer
--start-date-sys=yyyy:mm:dd:hh:mm:ss
                             Specify a starting date/time with respect to
                             system time
--start-date-gmt=yyyy:mm:dd:hh:mm:ss
                             Specify a starting date/time with respect to
                             Greenwich Mean Time
--start-date-lat=yyyy:mm:dd:hh:mm:ss
                             Specify a starting date/time with respect to
                             Local Aircraft Time

Network Options

--httpd=port                 Enable http server on the specified port
--telnet=port                Enable telnet server on the specified port
--jpg-httpd=port             Enable screen shot http server on the specified
                               port

MultiPlayer Options

--callsign                   assign a unique name to a player
--multiplay={in|out},hz,address,port
                             Specify multipilot communication settings
                             multiple instances can be used

Route/Way Point Options

--wp=ID[@alt]                Specify a waypoint for the GC autopilot;
                             multiple instances can be used
--flight-plan=file           Read all waypoints from a file

IO Options

--generic=params             Open connection using a predefined
                             communication interface and a preselected
                             communication protocol
--garmin=params              Open connection using the Garmin GPS protocol
--joyclient=params           Open connection to an Agwagon joystick
--jsclient=params            Open connection to a remote joystick
--native-ctrls=params        Open connection using the FG Native Controls
                             protocol
--native-fdm=params          Open connection using the FG Native FDM
                             protocol
--native=params              Open connection using the FG Native protocol
--nmea=params                Open connection using the NMEA protocol
--opengc=params              Open connection using the OpenGC protocol
--props=params               Open connection using the interactive property
                             manager (LEGACY/DEAD DO NOT USE same as --telnet)
--pve=params                 Open connection using the PVE protocol
--ray=params                 Open connection using the Ray Woodworth motion
                             chair protocol
--rul=params                 Open connection using the RUL protocol
--atc610x                    Enable atc610x interface

Under Windows, you must use a special escape sequence if you need to specify a COM port higher than 9.

Example: --generic=\\.\COM10,out,1,/tmp/data.xml,myproto

This is per the Microsoft KB article here: http://msdn.microsoft.com/en-us/library/aa363858%28v=vs.85%29.aspx

Avionics Options

--com1=frequency             Set the COM1 radio frequency.
--com2=frequency             Set the COM2 radio frequency.
--nav1=[radial:]frequency    Set the NAV1 radio frequency, optionally
                             preceded by a radial.
--nav2=[radial:]frequency    Set the NAV2 radio frequency, optionally
                             preceded by a radial.
--adf=[rotation:]frequency   Set the ADF radio frequency, optionally
                             preceded by a card rotation.
--dme={nav1|nav2|frequency}  Slave the ADF to one of the NAV radios, or set
                             its internal frequency.

Environment Options

--disable-real-weather-fetch Disable METAR based real weather fetching
--enable-real-weather-fetch  Enable METAR based real weather fetching (this
                             requires an open internet connection)
--disable-horizon-effect     Disable celestial body growth illusion near the
                             horizon
--enable-horizon-effect      Enable celestial body growth illusion near the
                             horizon
--enable-clouds              Enable 2D (flat) cloud layers
--disable-clouds             Disable 2D (flat) cloud layers
--enable-clouds3d            Enable 3D (volumetric) cloud layers
--disable-clouds3d           Disable 3D (volumetric) cloud layers
--visibility=meters          Specify initial visibility
--visibility-miles=miles     Specify initial visibility in miles
--wind=DIR@SPEED             Specify wind coming from DIR (degrees) at SPEED
                             (knots)
--turbulence=0.0 to 1.0      Specify turbulence from 0.0 (calm) to 1.0
                             (severe)
--ceiling=FT_ASL[:THICKNESS_FT]
                             Create an overcast ceiling, optionally with a
                             specific thickness (defaults to 2000 ft).
--random-wind
--metar="metar string"       Starts with a certain METAR string. Only works if live weather is disabled.

Situation Options

--failure={pitot|static|system|vacuum}
                             Fail the pitot, static, vacuum, or electrical
                             system (repeat the option for multiple system
                             failures).

Debugging Options

--log-level={bulk|debug|info|warn|alert}
                             Set the logging level for this session.
                             0=verbose, 5=alerts only
                             See also Commonly used debugging tools#fgfs.log
--pid=/pathto/some/file.pid  Write current PID into file.
--trace-read=property        Trace the reads for a property;
                             multiple instances can be used
--trace-write=property       Trace the writes for a property;
                             multiple instances can be used

Related content

Wiki articles

Source files