Jump to content

List of command-line options: Difference between revisions

From fCraft Wiki
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
In addition to many settings stored in config.xml, fCraft has several special options that can only be set via command-line switches:
In addition to many settings stored in config.xml, fCraft has several special options that can only be set via command-line switches. Both ServerGUI and ServerCLI support these flags, unless otherwise noted:


{|class="wikitable"
{|class="wikitable"
| align="right" | <code>--path=<path></code>
| align="right" style="min-width:130px" | <code>--path=<path></code>
| Working path (directory) that fCraft should use. If the given path is relative, it's computed against the location of fCraft.dll. If no path is given, location of fCraft.dll is used.
| Working path (directory) that fCraft should use. If the given path is relative, it's computed against the location of fCraft.dll. If no path is given, location of fCraft.dll is used.
|-
|-
Line 13: Line 13:
| align="right" | <code>--config=<path></code>
| align="right" | <code>--config=<path></code>
| Path (file) of the configuration file, including the file name (typically "config.xml"). If the given path is relative, it's computed against the working path.
| Path (file) of the configuration file, including the file name (typically "config.xml"). If the given path is relative, it's computed against the working path.
|-
| align="right" | <code>--exitoncrash</code>
| If this flag is present, fCraft front-ends will exit at once in the event of an unrecoverable crash, instead of showing a message and prompting for user input. This is preferable when fCraft is managed automatically rather than manually.
|-
|-
| align="right" | <code>--norestart</code>
| align="right" | <code>--norestart</code>
| If this flag is present, fCraft will shutdown whenever it would normally restart (e.g. automatic updates or /restart command). This may be useful if you are using an auto-restart script or a process monitor. Even though the server will not restart, it still exits with a restart [[List_of_exit_codes|exit-code]].
| If this flag is present, fCraft will shutdown whenever it would normally restart (e.g. automatic updates or /restart command). This may be useful if you are using an auto-restart script or a process monitor. Even though the server will not restart, it still exits with a restart [[List_of_exit_codes|exit-code]].
|-
|-
| align="right" | <code>--exitoncrash</code>
| align="right" | <code>--noupdater</code>
| If this flag is present, fCraft front-ends will exit at once in the event of an unrecoverable crash, instead of showing a message and prompting for user input. This is preferable when fCraft is managed automatically rather than manually.
| If this flag is present, fCraft will not launch the downloaded UpdateInstaller.exe when restarting for update/shutdown. It will handle all other aspects of the update process, including exiting with the correct [[List_of_exit_codes|exit-code]], but not launch the updater.
|-
|-
| align="right" | <code>--nolog</code>
| align="right" | <code>--nolog</code>
Line 24: Line 27:
|-
|-
| align="right" | <code>--noconsolecolor</code>
| align="right" | <code>--noconsolecolor</code>
| If this flag is present, ServerCLI will not use any color codes in its console output.
| If this flag is present, ServerCLI will not use any color codes in its console output. Has no effect on ServerGUI.
|-
|-
|}
|}
[[Category:Config]]
[[Category:Config]]
{{LastUpdated|1900}}

Latest revision as of 02:20, 11 December 2012

In addition to many settings stored in config.xml, fCraft has several special options that can only be set via command-line switches. Both ServerGUI and ServerCLI support these flags, unless otherwise noted:

--path=<path> Working path (directory) that fCraft should use. If the given path is relative, it's computed against the location of fCraft.dll. If no path is given, location of fCraft.dll is used.
--logpath=<path> Path (directory) where the log files should be placed. If the given path is relative, it's computed against the working path.
--mappath=<path> Path (directory) where the map files should be loaded from/saved to. This setting overrides MapPath key in config.xml. If the given path is relative, it's computed against the working path.
--config=<path> Path (file) of the configuration file, including the file name (typically "config.xml"). If the given path is relative, it's computed against the working path.
--exitoncrash If this flag is present, fCraft front-ends will exit at once in the event of an unrecoverable crash, instead of showing a message and prompting for user input. This is preferable when fCraft is managed automatically rather than manually.
--norestart If this flag is present, fCraft will shutdown whenever it would normally restart (e.g. automatic updates or /restart command). This may be useful if you are using an auto-restart script or a process monitor. Even though the server will not restart, it still exits with a restart exit-code.
--noupdater If this flag is present, fCraft will not launch the downloaded UpdateInstaller.exe when restarting for update/shutdown. It will handle all other aspects of the update process, including exiting with the correct exit-code, but not launch the updater.
--nolog If this flag is present, all logging is disabled.
--noconsolecolor If this flag is present, ServerCLI will not use any color codes in its console output. Has no effect on ServerGUI.