Command line options: Difference between revisions

Jump to navigation Jump to search
no edit summary
(→‎General Options: clarify AI models/traffic related options)
No edit summary
Line 1: Line 1:
'''Command line options''' are a common way to tell applications what to do/how to act on startup. With [[FlightGear]] they are used for many things, from simple ones like selecting an aircraft up to complex stuff like network traffic and weather parameters.
'''Command line options''' are a common way to tell applications what to do/how to act on startup. With [[FlightGear]] they are used for many things, from simple ones like selecting an aircraft up to complex stuff like network traffic and weather parameters.


The easiest way to handle those options for FlightGear (''fgfs'') is using a tool with a graphical user interface like ''[[fgrun]]'' on Windows and GNU/Linux or the Mac OS X GUI-Launcher ("fgfs --launcher"). This way one don't have to bother 'bout them at all.<br />
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.
 
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]].


A good place to store the personal options is a file called [[fgfsrc]]. This file is read by ''fgfs'' on each startup.
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 <code>fgfs --help --verbose</code>. If this command fails, you may add the option <code>--fg-root=[path]</code> 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 <code>fgfs --help --verbose</code>. So if you have serious issues with an option, the source code is, as always, also the best source for info. In the file ''src/Main/options.cxx'' all the options are listed with their hard coded ''default'' setting and type.


The following lists show the options for ''fgfs'' including a short description and sorted by categories. Please have in mind that keeping those lists up to date on the wiki is not an easy task. Also there are different versions of FlightGear out there which don't share exactly the same options. Therefore you better also check your versions ones with <code>fgfs --help --verbose</code>. If this command fails, you may add the option <code>--fg-root=[path]</code> as well, see below.<br />
It is sad but true, not even this command is, 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 <code>fgfs --help --verbose</code>. So if you have serious issues with an option, the source code is, as always, also the best source for info. In the file ''src/Main/options.cxx'' all the options are listed with their hard coded ''default'' setting and type.<br />
The file [[$FG_ROOT]]/options.xml is used to generate the output for <code>fgfs --help [--verbose]</code>. That's the reason why <code>--fg-root=[path]</code> has to be added to this, if it is not set as environmental variable or as option in fgfsrc.
The file [[$FG_ROOT]]/options.xml is used to generate the output for <code>fgfs --help [--verbose]</code>. That's the reason why <code>--fg-root=[path]</code> has to be added to this, if it is not set as environmental variable or as option in fgfsrc.


Line 15: Line 18:
==== General Options ====
==== General Options ====


  --help, -h                  Show the most relevant command line options
--help, -h                  Show the most relevant command line options
  --verbose, -v                Show all command line options when combined
--verbose, -v                Show all command line options when combined with --help or -h
                                with --help or -h
--fg-root=path              Specify the root data path
  --fg-root=path              Specify the root data path
--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
(--language=code              Select the language for this session
                                 *Not* supported in 1.9.1 and Git atm!)
                                 *Not* supported in 1.9.1 and Git atm!)
  --launcher                  Enable Qt launcher  
--launcher                  Enable Qt launcher  
  --disable-fullscreen        Disable full-screen game mode
--disable-fullscreen        Disable full-screen game mode
  --enable-fullscreen          Enable 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
  --disable-mouse-pointer      Disable extra mouse pointer
--disable-mouse-pointer      Disable extra mouse pointer
  --enable-mouse-pointer      Enable extra mouse pointer
--enable-mouse-pointer      Enable extra mouse pointer
                                 (i.e. for full screen Voodoo based cards)
                                 (i.e. for full screen Voodoo based cards)
  --disable-random-objects    Exclude random scenery objects
--disable-random-objects    Exclude random scenery objects
                                 (buildings, etc.)
                                 (buildings, etc.)
  --enable-random-objects      Include random scenery objects
--enable-random-objects      Include random scenery objects
                                 (buildings, etc.)
                                 (buildings, etc.)
  --disable-ai-models          Disable the AI subsystem.
--disable-ai-models          Disable the AI subsystem.
                                 (This also disables showing the models of other
                                 (This also disables showing the models of other
                                 multiplayer aircraft)
                                 multiplayer aircraft)
Line 312: Line 314:
   --trace-write=property      Trace the writes for a property;
   --trace-write=property      Trace the writes for a property;
                                 multiple instances can be used
                                 multiple instances can be used
[[FlightGear 1.0 aircraft names for command line]] can be useful depending on what version and aircraft are installed.


== Related content ==
== Related content ==

Navigation menu