1,089
edits
Command line options: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
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. | ||
Usage in terminal: <code>fgfs [OPTION [OPTION ...]]</code> | Usage in terminal: <code>fgfs [OPTION [OPTION ...]]</code> | ||
| Line 27: | Line 24: | ||
# <code>--option1</code><br/><code>--option2</code> - two different options, mutually exclusive. They cannot be used simultaneously, but are connected due to a common description. | # <code>--option1</code><br/><code>--option2</code> - two different options, mutually exclusive. They cannot be used simultaneously, but are connected due to a common description. | ||
# <code>--option1</code>, <code>--option2</code> - two different options that can be used simultaneously and are connected due to a common description. | # <code>--option1</code>, <code>--option2</code> - two different options that can be used simultaneously and are connected due to a common description. | ||
= Values for options = | |||
Some options do not require a value, such as <code>--help</code>, but there are options for which we must specify a value, such as <code>--fg-root</code>, as well as there are options for which we can optionally specify a value, such as for <code>--launcher</code>. We can separate the value from the option with either the <code>=</code> sign or a space, such as: | |||
--fg-root=/path/to/fgdata | |||
--fg-root /path/to/fgdata | |||
Options that act like an enable/disable switch take optional values as <code>true</code>, <code>1</code>, <code>yes</code> (enable) or <code>false</code>, <code>0</code>, <code>no</code> (disable). If we don't specify any value next to such an option, it will work by default as if we passed <code>true</code>, <code>1</code> or <code>yes</code>, i.e. enabled it, e.g: | |||
--lanucher | |||
will enable Launcher, which is equivalent to: | |||
--lanucher=yes | |||
On the other hand, we can also pass a value that disables the option, e.g.: | |||
--lanucher=no | |||
which will cause Launcher not to be launched. In addition, most of such options have two additional versions without a value, but preceded by the prefix <code>enable-</code> and <code>disable-</code>, e.g.: | |||
--enable-lanucher | |||
will also enable Launcher. | |||
= General Options = | = General Options = | ||