Command line options: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
Line 20: Line 20:
The way to use with [[FlightGear Qt launcher]]: go to the "Settings" tab and in the "Additional Settings" section enter the following options, each on a new line. The options entered there take precedence over those defined by Qt Launcher. To see the entire list of command line options used by Qt Launcher, use the keyboard shortcut {{Key press|Ctrl|L}} or select "View command-line" from the Launcher menu.
The way to use with [[FlightGear Qt launcher]]: go to the "Settings" tab and in the "Additional Settings" section enter the following options, each on a new line. The options entered there take precedence over those defined by Qt Launcher. To see the entire list of command line options used by Qt Launcher, use the keyboard shortcut {{Key press|Ctrl|L}} or select "View command-line" from the Launcher menu.


==== General Options ====
= General Options =


--help, -h                   Show the most relevant command line options.
<code>--help</code>, <code>-h</code>
--verbose, -v                Show all command line options when combined with --help or -h.
::Show the most relevant command line options.
--version                    Display the current FlightGear version.
--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).
--addon=path                Specify a path to addon;
                              multiple instances can be used.
--download-dir=path          Store aircraft and scenery downloaded via the simulator in path.
                              The TerraSync directory may be specifically set
                              with the --terrasync-dir option.
--data=path                  Specify an additional base data directory
                                (FGData), before the $FG_ROOT directory.
--disable-terrasync          Disable automatic scenery downloads/updates
--enable-terrasync          Enable automatic scenery downloads/updates
--terrasync-dir=path        Specify the [[TerraSync]] scenery path;
                              Defaults to [[$FG_HOME]]/TerraSync.
--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).
--browser-app=path          Specify path to your web browser.
--prop:[type:]name=value    Set property <name> to <value>. <type> can be
                              one of string, double, float, long, int, or
                              bool.
--config=path                Load additional properties from path.
--no-default-config          Do not load any default configuration files
                              (like .fgfsrc) unless explicitly specified
                              with --config.
--units-feet                Use feet for distances.
--units-meters              Use meters for distances.
--allow-nasal-read=path      Allow Nasal scripts to read files from directories
                              listed as path (separate multiple paths with a
                              semicolon (Windows) or a colon (UNIX)). By default,
                              for security reasons, Nasal scripts can only read
                              data from certain directories, such as $FG_ROOT,
                              $FG_HOME, etc.
--read-only                  Make $FG_HOME read-only.
--ignore-autosave            Ignore the autosave file, i.e. the settings saved
                              in this file will not be loaded during startup,
                              nor will the settings be saved to this file when
                              closing the simulator.
--disable-save-on-exit      Don't save preferences upon program exit.
--enable-save-on-exit        Allow saving preferences at program exit.
--restore-defaults          Reset all user settings to their defaults
                                (rendering options etc.)
--disable-gui                Enable headless mode.
--jsbsim-output-directive-file=file
                              Log JSBSim properties. An output directives file
                              contains an <output> element, within which should
                              be specified the parameters or parameter groups
                              that should be logged. See [[JSBSim Logging]].


==== Features ====
<code>--verbose</code>, <code>-v</code>
::Show all command line options when combined with <code>--help</code> or <code>-h</code>.


--composite-viewer={1|0}    Enable (1), disable (0) CompositeViewer (extra view windows).
<code>--version</code>
--disable-panel              Disable instrument panel.
::Display the current FlightGear version.
--enable-panel              Enable instrument panel.
--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.
--ai-scenario=scenario      Add and enable a new scenario. Multiple options
                              are allowed. Scenarios are in /[[$FG_ROOT]]/AI/.
--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-vr                Disable the Virtual Reality.
--enable-vr                  Enable the Virtual Reality.
--restart-launcher          Open Launcher automatically when exiting the FlightGear.
--load-tape={name|url}      Load recording of earlier flightgear session.
                              For <name>, if <name> ends with .fgdata it is
                              treated as the local path of the recording
                              file; otherwise we form the local path by
                              prepending <name> with the tape directory and
                              appending ".fgtape". For <url> (starting with
                              http:// or https://) we download the remote
                              recording (which must be a Continuous
                              recording) in the background to a url-dependent
                              filename while replaying it; if the
                              url-dependent filename already exists it is
                              assumed to be a truncated download and we only
                              download any remaining data.
--load-tape-create-video    Encode video while replaying tape specified by --load-tape.
--load-tape-fixed-dt=value  Set fixed-dt mode while replaying tape specified by --load-tape.


==== Aircraft ====
<code>--fg-root=path</code>
::Specify the root data path.


--aircraft=name
<code>--fg-scenery=path[:path...]</code>
--vehicle=name              Select an aircraft profile as defined by a top
::Specify the base scenery path. Defaults to [[$FG_ROOT]]/Scenery.
                              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.
--min-status={alpha|beta|early-production|production}
                              Allows you to define a minimum status level
                              (=development status) for all listed aircraft.
--enable-auto-coordination  Enable auto coordination - rudder and
                              ailerons will be controlled together.
--disable-auto-coordination  Disable auto coordination (default).
--livery=name                Select aircraft livery
--state=value                Specify the initial state of the aircraft
                              to the given value.


==== Flight Model ====
<code>--fg-aircraft=path</code>
::Specify additional aircraft directory path(s) (alternatively, you can use <code>--aircraft-dir</code> to target a specific aircraft in a given directory).


--fdm=name                  Select the core flight dynamics model
<code>--addon=path</code>
                              Can be one of ada, acms, aisim, balloon, jsb,
::Specify a path to addon. Multiple instances can be used.
                              larcsim, magic, network, pipe, ufo, yasim,
                              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 ====
<code>--download-dir=path</code>
::Store aircraft and scenery downloaded via the simulator in path. The TerraSync directory may be specifically set with the <code>--terrasync-dir</code> option.


--airport=ID                Specify airport (e.g. KOAK).
<code>--data=path</code>
--runway=rwy_no              Specify starting runway (must also specify an
::Specify an additional base data directory (FGData), before the [[$FG_ROOT]] directory.
                              airport).
--parking-id=NAME
--parkpos=NAME              Specify a gate at the airport (e.g. 747d11).
--carrier={name|ID}          Specify starting position on an AI carrier.
--carrier-position={abeam|FLOLS|name}
                              Specify a starting position relative to the
                                carrier where you can use the predefined abeam
                                (start on downwind abeam) or FLOLS (start on
                                final approach) values, or specify the name of
                                the carrier's parking position. Must also
                                specify a carrier.
--vor=ID                    Specify starting position relative to a VOR.
--vor-frequency=frequency    Specify the frequency of the VOR. Use with
                              --vor=ID.
--ndb=ID                    Specify starting position relative to an NDB.
--ndb-frequency=frequency    Specify the frequency of the NDB. Use with
                              --ndb=ID.
--fix=ID                    Specify starting position relative to a fix.
--offset-distance=nm        Specify distance to reference point (nautical
                              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).
--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 of rate (can be negative).
--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).
--vNorth=units_per_sec      Specify velocity along a South-North axis
                              (in feet unless --units-meters specified).
--vEast=units_per_sec        Specify velocity along a West-East axis
                              (in feet unless --units-meters specified).
--vDown=units_per_sec        Specify velocity along a vertical axis
                              (in feet unless --units-meters specified).


==== Audio Options ====
<code>--disable-terrasync</code>
--show-sound-devices        Show a list of available audio device.
::Disable automatic scenery downloads/updates.
--sound-device              Explicitly specify the audio device to use.
--disable-sound              Disable sound effects.
--enable-sound              Enable sound effects.


==== Rendering Options ====
<code>--enable-terrasync</code>
--prop:/sim/rendering/multi-sample-buffers=true
::Enable automatic scenery downloads/updates.
                              Enable multi sample buffer (anti-aliasing).
--prop:/sim/rendering/multi-samples=4
                              Specify number of multi samples (anti-aliasing).
                              Valid values is 2x, 4x, 8x, 16x.
--aspect-ratio-multiplier=factor
                              Specify a multiplier for the aspect ratio.
--bpp=depth                  Specify the bits per pixel.
--compositor=path            Specify the path to XML file for multi-pass rendering.
                              The path is relative to $FG_ROOT
                              (defaults to Compositor/default.xml).
--enable-horizon-effect      Enable celestial body growth illusion near the
                              horizon.
--disable-horizon-effect    Disable celestial body growth illusion near the
                              horizon.
--enable-enhanced-lighting  Enable enhanced runway lighting.
--disable-enhanced-lighting  Disable enhanced runway lighting.
--enable-distance-attenuation
                              Enable runway light distance attenuation.
--disable-distance-attenuation
                              Disable runway light distance attenuation
--enable-specular-highlight  Enable specular reflections on textured objects.
--disable-specular-highlight
                              Disable 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.
--enable-texture-cache      Enable texture cache (DDS).
--disable-texture-cache      Disable texture cache (DDS).
--texture-cache-dir=path    Set the DDS texture cache directory to be different
                              than the default location.
--enable-fullscreen          Enable fullscreen mode.
--disable-fullscreen        Disable fullscreen mode.
--enable-random-objects      Include random scenery objects
                              (buildings, etc.)
--disable-random-objects    Exclude random scenery objects
                              (buildings, etc.)
--enable-wireframe          Enable wireframe drawing mode.
--disable-wireframe          Disable wireframe drawing mode.
--fog-disable                Disable fog/haze.
--fog-fastest                Enable fastest fog/haze.
--fog-nicest                Enable nicest fog/haze.
--fov=degrees                Specify field of view angle.
--geometry=WxH              Specify window geometry/resolution (640x480, etc).
--graphics-preset={minimal-quality|low-quality|medium-quality|high-quality|ultra-quality}
                              Specify a graphic preset.
--materials-file=file        Specify the materials file used to render the
                                scenery (default: Materials/regions/materials.xml).
--max-fps=Hz                Maximum frame rate in Hz.
--shading-flat              Enable flat shading.
--shading-smooth            Enable smooth shading.
--texture-filtering=number  Specify anisotropic filtering of terrain textures.
                              Valid values is 1, 2, 4, 8, 16. Default is 1.
--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.
--terrain-engine={tilecache|pagedLOD}
                              Specify the terrain engine you want to use: tilecache
                              or pagedLOD.
--lod-levels=levels
                              Specify the detail levels, where levels are a space-separated
                              numeric list of levels. The default is "1 3 5 7 9".
                              Use with --terrain-engine=pagedLOD.
--lod-res=resolution        Specify the resolution of the terrain grid. Defaults is 1.
                              Use with --terrain-engine=pagedLOD.
--lod-texturing={bluemarble|raster|debug}
                              Specify the method of texturing the terrain.
                              The default is bluemarble.
                              Use with --terrain-engine=pagedLOD.
--lod-range-mult=multiplier
                              Specify the range multiplier (point from low to fine detail).
                              Defaults is 2.
                              Use with --terrain-engine=pagedLOD.


==== Hud Options ====
<code>--terrasync-dir=path</code>
::Specify the [[TerraSync]] scenery path. Defaults to [[$FG_HOME]]/TerraSync.


--disable-hud                Disable Heads Up Display (HUD)
<code>--language=code</code>
--enable-hud                Enable Heads Up Display (HUD)
::Select the language for this session.
--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 ====
<code>--launcher</code>
::Enable Qt launcher.


--timeofday={real|dawn|morning|noon|afternoon|dusk|evening|midnight}
<code>--disable-splash-screen</code>
                              Specify a time of day.
::Disable splash screen.
--time-offset=[+-]hh:mm:ss  Add this time offset to --time-match-real.
--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 ====
<code>--enable-splash-screen</code>
::Enable splash screen.


--httpd=port                Enable http server on the specified port.
<code>--enable-mouse-pointer</code><br/>
--telnet=port                Enable telnet server on the specified port.
<code>--disable-mouse-pointer</code>
--jpg-httpd=port            Enable screen shot http server on the specified
::Enable/disable extra mouse pointer (i.e. for full screen Voodoo based cards).
                              port (replaced by --httpd).
--allow-nasal-from-sockets  Remove security flag, which means that network
                              connections will be allowed full access to the
                              simulator including running arbitrary scripts.
                              Ensure you have adequate security (such as a
                              firewall which blocks external connections).
--disable-sentry            Disable crash and error reports from being sent
                              to the development team for analysis.
--enable-sentry              Enable crash and error reports to be sent to
                              the development team for analysis.


==== MultiPlayer Options ====
<code>--browser-app=path</code>
::Specify path to your web browser.


--callsign=name              Assign a unique name to a player.
<code>--prop:[type:]name=value</code>
--multiplay={in|out},hz,address,port
::Set property name to value. Type can be one of string, double, float, long, int, or bool.
                              Specify multipilot communication settings;
                              multiple instances can be used.
--enable-fgcom              Enable FGCom built-in.
--disable-fgcom              Disable FGCom built-in.
--disable-hold-short        Disable the move to hold short position for multiplayer.


==== Route/Way Point Options ====
<code>--config=path</code>
::Load additional properties from path.


--wp=ID[@alt]                Specify a waypoint for the GC autopilot;
<code>--no-default-config</code>
                              multiple instances can be used.
::Do not load any default configuration files (like .fgfsrc) unless explicitly specified with <code>--config</code>.
--flight-plan=file          Read all waypoints from a file.


==== IO Options ====
<code>--units-feet</code>
::Use feet for distances.


--generic=params             Open connection using a predefined
<code>--units-meters</code>
                              communication interface and a preselected
::Use meters for distances.
                              communication protocol
 
--atlas=params               Open connection using the Atlas protocol
<code>--allow-nasal-read=path</code>
--atcsim=params             Open connection using the ATC sim protocol
::Allow Nasal scripts to read files from directories listed as path (separate multiple paths with a semicolon (Windows) or a colon (UNIX)). By default, for security reasons, Nasal scripts can only read data from certain directories, such as [[$FG_ROOT]], [[$FG_HOME]], etc.
                                (atc610x)
 
--AV400=params               Emit the Garmin AV400 protocol required to
<code>--read-only</code>
                                drive a Garmin 196/296 series GPS
::Make [[$FG_HOME]] read-only.
--AV400Sim=params           Emit the set of AV400 strings required to drive
 
                                a Garmin 400-series GPS from FlightGear
<code>--ignore-autosave</code>
--AV400WSimA=params
::Ignore the autosave file, i.e. the settings saved in this file will not be loaded during startup, nor will the settings be saved to this file when closing the simulator.
--AV400WSimB=params         The Garmin WAAS GPS uses 2 serial channels to communicate with the
 
                                simulator. These 2 channels are represented by the FGAV400WSimA and
<code>--enable-save-on-exit</code><br/>
                                the FGAV400WSimB classes. The "A" channel is similar to the previous
<code>--disable-save-on-exit</code>
                                AVSim400 protocol. The "B" channel is considered the "GPS" channel and
::Allow/Disallow save preferences upon program exit.
                                uses a different protocol than the "A" channel. The GPS unit expects
 
                                input on the "B" channel at two different frequencies (1hz and 5hz,
<code>--restore-defaults</code>
                                normally). The "B" channel also expects responses to certain output
::Reset all user settings to their defaults (rendering options etc.)
                                messages.
 
--flarm=params               Open connection using the FLARM protocol, which
<code>--disable-gui</code>
                                includes NMEA/GPS and traffic reporting
::Enable headless mode.
                                messages
 
--garmin=params             Open connection using the Garmin GPS protocol
<code>--jsbsim-output-directive-file=file</code>
--igc=params                 Open connection using the International Gliding  
::Log JSBSim properties. An output directives file contains an <code><output></code> element, within which should be specified the parameters or parameter groups that should be logged. See [[JSBSim Logging]].
                                Commission (IGC) protocol
 
--joyclient=params           Open connection to an Agwagon joystick
= Features =
--jsclient=params           Open connection to a remote joystick
 
--native=params             Open connection using the FG Native protocol
<code>--composite-viewer={1|0}</code>
--native-ctrls=params       Open connection using the FG Native Controls
::Enable (1), disable (0) CompositeViewer (extra view windows).
                              protocol
 
--native-fdm=params         Open connection using the FG Native FDM
<code>--enable-panel</code><br/>
                              protocol
<code>--disable-panel</code>
--nmea=params               Open connection using the NMEA protocol
::Enable/disable 2D instrument panel.
--opengc=params             Open connection using the OpenGC protocol
 
--props=params               Open connection using the interactive property
<code>--enable-freeze</code><br/>
                              manager (LEGACY/DEAD DO NOT USE same as --telnet)
<code>--disable-freeze</code>
--pve=params                 Open connection using the PVE protocol
::Start in a pause state or unpause.
--ray=params                 Open connection using the Ray Woodworth motion
 
                              chair protocol
<code>--enable-fuel-freeze</code><br/>
--rul=params                 Open connection using the RUL protocol
<code>--disable-fuel-freeze</code>
::Fuel tank quantity forced to remain constant or fuel is consumed normally.
 
<code>--enable-clock-freeze</code><br/>
<code>--disable-clock-freeze</code>
::do not advance clock or clock advances normally.
 
<code>--ai-scenario=scenario</code>
::Add and enable a new scenario. Multiple options are allowed. Scenarios are in [[$FG_ROOT]]/AI/.
 
<code>--enable-ai-models</code><br/>
<code>--disable-ai-models</code>
::Enable/disable the AI subsystem. When disabled this also disables showing the models of other multiplayer aircraft.
 
<code>--enable-ai-traffic</code><br/>
<code>--disable-ai-traffic</code>
::Enable/disable the autogenerated traffic subsystem.
 
<code>--enable-vr</code><br/>
<code>--disable-vr</code>
::Enable/disable the Virtual Reality.
 
<code>--restart-launcher</code>
::Open Launcher automatically when exiting the FlightGear.
 
<code>--load-tape={name|url}</code>
::Load recording of earlier flightgear session. For <name>, if <name> ends with .fgdata it is treated as the local path of the recording file; otherwise we form the local path by prepending <name> with the tape directory and appending ".fgtape". For <url> (starting with http:// or https://) we download the remote recording (which must be a Continuous recording) in the background to a url-dependent filename while replaying it; if the url-dependent filename already exists it is assumed to be a truncated download and we only download any remaining data.
 
<code>--load-tape-create-video</code>
::Encode video while replaying tape specified by <code>--load-tape</code>.
 
<code>--load-tape-fixed-dt=value</code>
::Set fixed-dt mode while replaying tape specified by <code>--load-tape</code>.
 
= Aircraft =
 
<code>--aircraft=name</code>, <code>--vehicle=name</code>
::Select an aircraft profile as defined by a top level -set.xml.
 
<code>--aircraft-dir=path</code>
::Specify the exact directory to use for the aircraft (normally not required, but may be useful). Interpreted relatively to the current directory. Causes the <code><path-cache></code> from autosave_X_Y.xml, as well as <code>--fg-aircraft</code> options and the FG_AIRCRAFT environment variable to be bypassed.
 
<code>--show-aircraft</code>
::Print a list of the currently available aircraft types.
 
<code>--min-status={alpha|beta|early-production|production}</code>
::Allows you to define a minimum status level (=development status) for all listed aircraft.
 
<code>--enable-auto-coordination</code><br/>
<code>--disable-auto-coordination</code>
::Enable/disable auto coordination. Disabled as default. If enabled, the rudder will respond according to the movement of the ailerons.
 
<code>--livery=name</code>
::Select aircraft livery.
 
<code>--state=value</code>
::Specify the initial state of the aircraft to the given value.
 
= Flight Model =
 
<code>--fdm={ada | acms | aisim | balloon | jsb | larcsim | magic | network | pipe | ufo | yasim | external | null}</code>
::Select the core flight dynamics model.
 
<code>--aero=name</code>
::Select aircraft aerodynamics model to load.
 
<code>--model-hz=n</code>
::Run the FDM this rate (iterations per second).
 
<code>--speed=n</code>
::Run the FDM 'n' times faster than real time.
 
<code>--trim</code><br/>
<code>--notrim</code>
::Trim or do not attempt to trim the model (only with <code>--fdm=jsbsim</code>).
 
<code>--on-ground</code><br/>
<code>--in-air</code>
::Start at ground level (default) or in air (implied when using <code>--altitude</code>).
 
= Initial Position and Orientation =
 
<code>--airport=ID</code>
::Specify airport (e.g. KOAK).
 
<code>--runway=rwy_no</code>
::Specify starting runway (must also specify an airport).
 
<code>--parking-id=name</code>, <code>--parkpos=name</code>
::Specify a gate at the airport (e.g. 747d11).
 
<code>--carrier={name|ID}</code>
::Specify starting position on an AI carrier.
 
<code>--carrier-position={abeam|FLOLS|name}</code>
::Specify a starting position relative to the carrier where you can use the predefined <tt>abeam</tt> (start on downwind abeam) or <tt>FLOLS</tt> (start on final approach) values, or specify the name of the carrier's parking position. Must also specify a carrier by <code>--carrier</code>.
 
<code>--vor=ID</code>
::Specify starting position relative to a VOR.
 
<code>--vor-frequency=frequency</code>
::Specify the frequency of the VOR. Use with <code>--vor=ID</code>.
 
<code>--ndb=ID</code>
::Specify starting position relative to an NDB.
 
<code>--ndb-frequency=frequency</code>
::Specify the frequency of the NDB. Use with <code>--ndb=ID</code>.
 
<code>--fix=ID</code>
::Specify starting position relative to a fix.
 
<code>--offset-distance=nm</code>
::Specify distance to reference point (nautical miles).
 
<code>--offset-azimuth=degrees</code>
::Specify heading to reference point.
 
<code>--lon=degrees</code>
::Starting longitude (west = -).
 
<code>--lat=degrees</code>
::Starting latitude (south = -).
 
<code>--altitude=value</code>
::Starting altitude (in feet unless <code>--units-meters</code> specified).
 
<code>--heading=degrees</code>
::Specify heading (yaw) angle (Psi).
 
<code>--roll=degrees</code>
::Specify roll angle (Phi).
 
<code>--pitch=degrees</code>
::Specify pitch angle (Theta).
 
<code>--vc=knots</code><br/>
<code>--mach=num</code>
::Specify initial airspeed in knots or mach number.
 
<code>--glideslope=degrees</code>
::Specify flight path angle (can be positive).
 
<code>--roc=fpm</code>
::Specify initial climb of rate (can be negative).
 
<code>--uBody=units_per_sec</code>
::Specify velocity along the body X axis (in feet unless <code>--units-meters</code> specified).
 
<code>--vBody=units_per_sec</code>
::Specify velocity along the body Y axis (in feet unless <code>--units-meters</code> specified).
 
<code>--wBody=units_per_sec</code>
::Specify velocity along the body Z axis (in feet unless <code>--units-meters</code> specified).
 
<code>--vNorth=units_per_sec</code>
::Specify velocity along a South-North axis (in feet unless <code>--units-meters</code> specified).
 
<code>--vEast=units_per_sec</code>
::Specify velocity along a West-East axis (in feet unless <code>--units-meters</code> specified).
 
<code>--vDown=units_per_sec</code>
::Specify velocity along a vertical axis (in feet unless <code>--units-meters</code> specified).
 
= Audio Options =
 
<code>--show-sound-devices</code>
::Show a list of available audio device.
 
<code>--sound-device=name</code>
::Explicitly specify the audio device to use. To get available names use <code>--show-sound-devices</code>.
 
<code>--enable-sound</code><br/>
<code>--disable-sound</code>
::Enable/disable sound.
 
= Rendering Options =
 
<code>--prop:/sim/rendering/multi-sample-buffers={true|false}</code>
::Enable/disable multi sample buffer (anti-aliasing).
 
<code>--prop:/sim/rendering/multi-samples=value</code>
::Specify number of multi samples (anti-aliasing). Valid values is 2, 4, 8, 16.
 
<code>--aspect-ratio-multiplier=factor</code>
::Specify a multiplier for the aspect ratio.
 
<code>--bpp=depth</code>
::Specify the bits per pixel.
 
<code>--compositor=path</code>
::Specify the path to XML file for multi-pass rendering. The path is relative to [[$FG_ROOT]] (defaults to <tt>Compositor/default.xml</tt>).
 
<code>--enable-horizon-effect</code><br/>
<code>--disable-horizon-effect</code>
::Enable/disable celestial body growth illusion near the horizon.
 
<code>--enable-enhanced-lighting</code><br/>
<code>--disable-enhanced-lighting</code>
::Enable/disable enhanced runway lighting.
 
<code>--enable-distance-attenuation</code><br/>
<code>--disable-distance-attenuation</code>
::Enable/disable runway light distance attenuation.
 
<code>--enable-specular-highlight</code><br/>
<code>--disable-specular-highlight</code>
::Enable/disable specular reflections on textured objects.
 
<code>--enable-clouds</code><br/>
<code>--disable-clouds</code>
::Enable/disable 2D (flat) cloud layers.
 
<code>--enable-clouds3d</code><br/>
<code>--disable-clouds3d</code>
::Enable/disable 3D (volumetric) cloud layers.
 
<code>--enable-texture-cache</code><br/>
<code>--disable-texture-cache</code>
::Enable/disable texture cache (DDS).
 
<code>--texture-cache-dir=path</code>
::Set the DDS texture cache directory to be different than the default location.
 
<code>--enable-fullscreen</code><br/>
<code>--disable-fullscreen</code>
::Enable/disable fullscreen mode.
 
<code>--enable-random-objects</code><br/>
<code>--disable-random-objects</code>
::Include/exclude random scenery objects (buildings, etc.)
 
<code>--enable-wireframe</code><br/>
<code>--disable-wireframe</code>
::Enable/disable wireframe drawing mode.
 
<code>--fog-disable</code>
::Disable fog/haze.
 
<code>--fog-fastest</code>
::Enable fastest fog/haze.
 
<code>--fog-nicest</code>
::Enable nicest fog/haze.
 
<code>--fov=degrees</code>
::Specify field of view angle.
 
<code>--geometry=WidthxHeight</code>
::Specify window geometry/resolution (640x480, etc).
 
<code>--graphics-preset={minimal-quality|low-quality|medium-quality|high-quality|ultra-quality}</code>
::Specify a graphic preset.
 
<code>--materials-file=file</code>
::Specify the materials file used to render the scenery (default: Materials/regions/materials.xml).
 
<code>--max-fps=Hz</code>
::Maximum frame rate in Hz.
 
<code>--shading-flat</code>
::Enable flat shading.
 
<code>--shading-smooth</code>
::Enable smooth shading.
 
<code>--texture-filtering=value</code>
::Specify anisotropic filtering of terrain textures. Valid values is 1, 2, 4, 8, 16. Default is 1.
 
<code>--view-offset=value</code>
::Specify the default forward view direction as an offset from straight ahead. Allowable values are <tt>LEFT</tt>, <tt>RIGHT</tt>, <tt>CENTER</tt>, or a specific number in degrees.
 
<code>--terrain-engine={tilecache|pagedLOD}</code>
::Specify the terrain engine you want to use: <tt>tilecache</tt> or <tt>pagedLOD</tt>.
 
<code>--lod-levels=levels</code>
::Specify the detail levels, where levels are a space-separated numeric list of levels. The default is "1 3 5 7 9". Use with <code>--terrain-engine=pagedLOD</code>.
 
<code>--lod-res=resolution</code>
::Specify the resolution of the terrain grid. Defaults is 1. Use with <code>--terrain-engine=pagedLOD</code>.
 
<code>--lod-texturing={bluemarble|raster|debug}</code>
::Specify the method of texturing the terrain. The default is bluemarble. Use with <code>--terrain-engine=pagedLOD</code>.
 
<code>--lod-range-mult=multiplier</code>
::Specify the range multiplier (point from low to fine detail). Defaults is 2. Use with <code>--terrain-engine=pagedLOD</code>.
 
= Hud Options =
 
<code>--enable-hud</code><br/>
<code>--disable-hud</code>
::Enable/disable Heads Up Display (HUD).
 
<code>--enable-anti-alias-hud</code><br/>
<code>--disable-anti-alias-hud</code>
::Enable/disable anti-aliased HUD.
 
<code>--enable-hud-3d</code><br/>
<code>--disable-hud-3d</code>
::Enable/disable 3D HUD.
 
<code>--hud-tris</code>
::Hud displays number of triangles rendered.
 
<code>--hud-culled</code>
::Hud displays percentage of triangles culled.
 
= Time Options =
 
<code>--timeofday={real|dawn|morning|noon|afternoon|dusk|evening|midnight}</code>
::Specify a time of day.
 
<code>--time-offset=[+-]hh:mm:ss</code>
::Add this time offset to <code>--time-match-real</code>.
 
<code>--time-match-real</code>
::Synchronize time with current time at chosen airport.
 
<code>--time-match-local</code>
::Synchronize time with system time of computer.
 
<code>--start-date-sys=yyyy:mm:dd:hh:mm:ss</code>
::Specify a starting date/time with respect to system time.
 
<code>--start-date-gmt=yyyy:mm:dd:hh:mm:ss</code>
::Specify a starting date/time with respect to Greenwich Mean Time.
 
<code>--start-date-lat=yyyy:mm:dd:hh:mm:ss</code>
::Specify a starting date/time with respect to Local Aircraft Time.
 
= Network Options =
 
<code>--httpd=port</code>
::Enable http server on the specified port.
 
<code>--telnet={port|socket,bi,hz,localhost,port,tcp}</code>, <code>--props={port|socket,bi,hz,localhost,port,tcp}</code>
::Enable telnet server on the specified port. Optionally, you can change the hz (number of packets per second).
 
<code>--jpg-httpd=port</code>
::Enable screen shot http server on the specified port. This option has been withdrawn, instead use <code>--httpd</code> and /screenshots URL.
 
<code>--allow-nasal-from-sockets</code>
::Remove security flag, which means that network connections will be allowed full access to the simulator including running arbitrary scripts. Ensure you have adequate security (such as a firewall which blocks external connections).
 
<code>--enable-sentry</code><br/>
<code>--disable-sentry</code>
::Enable/disable crash and error reports from being sent to the development team for analysis.
 
= MultiPlayer Options =
 
<code>--callsign=name</code>
::Assign a unique name to a player. A call sign must be at most 10 characters long and can only contain numbers, letters of the English alphabet, hyphens (-) and underscores (_). Longer call signs are truncated, and characters that do not match those listed above are replaced with hyphens.
 
<code>--multiplay={in|out},hz,address,port</code>
::Specify multipilot communication settings. Multiple instances can be used.
 
<code>--enable-fgcom</code><br/>
<code>--disable-fgcom</code>
::Enable/disable built-in FGCom.
 
<code>--disable-hold-short</code>
::Disable the move to hold short position for multiplayer.
 
= Route/Way Point Options =
 
<code>--wp=ID[@alt]</code>
::Specify a waypoint for the GC autopilot. Multiple instances can be used.
 
<code>--flight-plan=file</code>
::Read all waypoints from a file.
 
= IO Options =
 
<code>--generic=params</code>
::Open connection using a predefined communication interface and a preselected communication protocol.
 
<code>--atlas=params</code>
::Open connection using the Atlas protocol.
 
<code>--atcsim=params</code>
::Open connection using the ATC sim protocol (atc610x).
 
<code>--AV400=params</code>
::Emit the Garmin AV400 protocol required to drive a Garmin 196/296 series GPS.
 
<code>--AV400Sim=params</code>
::Emit the set of AV400 strings required to drive a Garmin 400-series GPS from FlightGear.
 
<code>--AV400WSimA=params</code><br/>
<code>--AV400WSimB=params</code>
::The Garmin WAAS GPS uses 2 serial channels to communicate with the simulator. These 2 channels are represented by the FGAV400WSimA and the FGAV400WSimB classes. The "A" channel is similar to the previous AVSim400 protocol. The "B" channel is considered the "GPS" channel and uses a different protocol than the "A" channel. The GPS unit expects input on the "B" channel at two different frequencies (1hz and 5hz, normally). The "B" channel also expects responses to certain output messages.
 
<code>--flarm=params</code>
::Open connection using the FLARM protocol, which includes NMEA/GPS and traffic reporting messages,
 
<code>--garmin=params</code>
::Open connection using the Garmin GPS protocol,
 
<code>--igc=params</code>
::Open connection using the International Gliding Commission (IGC) protocol.
 
<code>--joyclient=params</code>
::Open connection to an Agwagon joystick.
 
<code>--jsclient=params</code>
::Open connection to a remote joystick.
 
<code>--native=params</code>
::Open connection using the FG Native protocol.
 
<code>--native-ctrls=params</code>
::Open connection using the FG Native Controls protocol.
 
<code>--native-fdm=params</code>
::Open connection using the FG Native FDM protocol.
 
<code>--nmea=params</code>
::Open connection using the NMEA protocol.
 
<code>--opengc=params</code>
::Open connection using the OpenGC protocol.
 
<code>--props=params</code>
::Open connection using the interactive property manager (LEGACY/DEAD DO NOT USE same as <code>--telnet</code>).
 
<code>--pve=params</code>
::Open connection using the PVE protocol.
 
<code>--ray=params</code>
::Open connection using the Ray Woodworth motion chair protocol.
 
<code>--rul=params</code>
::Open connection using the RUL protocol.


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.


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


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


==== Avionics Options ====
= Avionics Options =
 
<code>--com1=frequency</code><br/>
<code>--com2=frequency</code>
::Set the COM1/COM2 radio frequency.
 
<code>--nav1=[radial:]frequency</code><br/>
<code>--nav2=[radial:]frequency</code>
::Set the NAV1/NAV2 radio frequency, optionally preceded by a radial.
 
<code>--adf1=[rotation:]frequency</code><br/>
<code>--adf2=[rotation:]frequency</code>
::Set the ADF1/ADF2 frequency to frequency kHz. You can optionally specify the rotation angle of its compass card by prefixing the frequency with the angle and a colon. The <code>--adf</code> option is deprecated.
 
<code>--dme={nav1|nav2|frequency}</code>
::Slave the ADF to one of the NAV radios, or set its internal frequency.
 
= Environment Options =
 
<code>--enable-real-weather-fetch</code><br/>
<code>--disable-real-weather-fetch</code>
::Enable/disable METAR based real weather fetching. Enable requires an open internet connection.
 
<code>--enable-horizon-effect</code><br/>
<code>--disable-horizon-effect</code>
::Enable/disable celestial body growth illusion near the horizon.
 
<code>--enable-clouds</code><br/>
<code>--disable-clouds</code>
::Enable/disable 2D (flat) cloud layers.
 
<code>--enable-clouds3d</code><br/>
<code>--disable-clouds3d</code>
::Enable/disable 3D (volumetric) cloud layers.
 
<code>--visibility=meters</code><br/>
<code>--visibility-miles=miles</code>
::Specify initial visibility in meters or in statute miles.
 
<code>--wind=DIR[:MAXDIR]@SPEED[:GUST]</code>
::Specify the direction from which the wind is blowing (DIR in degrees) and its SPEED (in knots). If the wind direction is variable, specify the range as DIR:MAXDIR, as a minimum and maximum angle in degrees. If you want the simulator to also model wind gusts, set the maximum :GUST rate in knots.
 
<code>--turbulence=value</code>
::Specify turbulence where value must to be from 0.0 (calm) to 1.0 (severe).
 
<code>--ceiling=FT_ASL[:THICKNESS_FT]</code>
::Create an overcast ceiling, optionally with a specific thickness (defaults to 2000 ft).
 
<code>--random-wind</code>
::Set up random wind direction and speed.
 
<code>--metar="metar string"</code>
::Starts with a certain METAR string. Only works if live weather is disabled.
 
= Situation Options =
 
<code>--failure={pitot|static|vacuum|electrical}</code>
::Fail the pitot, static, vacuum, or electrical system (repeat the option for multiple system failures).
 
= Debugging Options =
 
<code>--console</code>
::Display console (Windows specific).
 
<code>--developer</code>
::Enable developer mode.
 
<code>--enable-fpe</code>
::Abort on encountering a floating point exception.
 
<code>--fgviewer</code>
::Use a model viewer rather than load the entire simulator.
 
<code>--json-report</code>
::Print a report in JSON format on the standard output. The report will give useful information for debugging purposes, such as the FlightGear version, the scenery/aircraft paths in use, the TerraSync and the data download directories and the paths to navigation data files.


--com1=frequency            Set the COM1 radio frequency.
<code>--log-level={bulk|debug|info|warn|alert}</code>
--com2=frequency            Set the COM2 radio frequency.
::Set the logging level for this session. 0 = verbose, 5 = alerts only. See also [[Commonly used debugging tools#fgfs.log]].
--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.
--adf1=[rotation:]frequency
                              Set the ADF1 frequency to frequency kHz.
                              You can optionally specify the rotation angle
                              of its compass card by prefixing the frequency
                              with the angle and a colon. The --adf option is deprecated.
--adf2=[rotation:]frequency  Set the ADF2 frequency to frequency kHz. You can optionally
                              specify the rotation angle of its compass card by prefixing
                              the frequency with the angle and a colon.
--dme={nav1|nav2|frequency}  Slave the ADF to one of the NAV radios, or set
                              its internal frequency.


==== Environment Options ====
<code>--log-class={none|ai|aircraft|astro|atc|autopilot|clipper|cockpit| environment|event|flight|general|gl|gui|headless|input|instrumentation| io|math|nasal|navaid|network|osg|particles|sound|systems|terrain| terrasync|undefined|view|all}</code>
::Specify which logging class(es) to use.


--disable-real-weather-fetch Disable METAR based real weather fetching.
<code>--log-dir=dir</code>
--enable-real-weather-fetch  Enable METAR based real weather fetching (this
::Save the logs in the directory dir. If dir is desktop, the logs are saved on the Desktop. This option may be given several times, using a different directory each time. Inside the specified directory, the log file will be named FlightGear_YYYY-MM-DD_num.log, where YYYY-MM-DD is the current date and num is a progressive number starting at 0.
                              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 in meters.
--visibility-miles=miles    Specify initial visibility in statute miles.
--wind=DIR[:MAXDIR]@SPEED[:GUST]
                              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                Set up random wind direction and speed.
--metar="metar string"      Starts with a certain METAR string.
                              Only works if live weather is disabled.


==== Situation Options ====
<code>--trace-read=property</code>
::Trace the reads for a property; multiple instances can be used.


--failure={pitot|static|vacuum|electrical}
<code>--trace-write=property</code>
                              Fail the pitot, static, vacuum, or electrical
::Trace the writes for a property; multiple instances can be used.
                              system (repeat the option for multiple system
                              failures).


==== Debugging Options ====
<code>--uninstall</code>
--console                    Display console (Windows specific)
::Remove [[$FG_HOME]] directory. For Windows, it additionally removes TerraSync, Aircraft and TextureCache directories from download directory.
--developer                  Enable developer mode.
--enable-fpe                Abort on encountering a floating point
                              exception;
--fgviewer                  Use a model viewer rather than load the entire
                              simulator.
--json-report                Print a report in JSON format on the standard output.
                              The report will give useful information for debugging
                              purposes, such as the FlightGear version,
                              the scenery/aircraft paths in use, the TerraSync and
                              the data download directories and the paths to
                              navigation data files.
--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]]
--log-class={none|ai|aircraft|astro|atc|autopilot|clipper|cockpit|
    environment|event|flight|general|gl|gui|headless|input|instrumentation|
    io|math|nasal|navaid|network|osg|particles|sound|systems|terrain|
    terrasync|undefined|view|all}
                              Specify which logging class(es) to use.
--log-dir=dir                Save the logs in the directory dir. If dir is desktop,
                              the logs are saved on the Desktop. This option may be
                              given several times, using a different directory each time.
                              Inside the specified directory, the log file will be named
                              FlightGear_YYYY-MM-DD_num.log, where YYYY-MM-DD is the
                              current date and num is a progressive number starting at 0.
--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
--uninstall                  Remove $FG_HOME directory. For Windows, it additionally  
                              removes TerraSync, Aircraft and TextureCache  
                              directories from download directory.


== Related content ==
= Related content =
=== Wiki articles ===
== Wiki articles ==
* [[Command line]]
* [[Command line]]


=== Source files ===
== Source files ==
* {{fgdata file|options.xml}}
* {{fgdata file|options.xml}}
* {{flightgear file|src/Main/options.hxx}}
* {{flightgear file|src/Main/options.hxx}}
1,089

edits

Navigation menu