OpenSim.exe Command Line Options

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name)
(Rewrote for End Users, Content Builders, Simulator Operators, and Developers - verified for 0.7.6-dev)
Line 2: Line 2:
 
__NOTOC__
 
__NOTOC__
  
−
Command line arguments are usually helpful to modify the behavior of your OpenSimulator for somewhat customized environments or debugging.
+
Command line arguments, also known as switches, helpful to modify the behavior of your OpenSimulator for customized environments or debugging.
  
−
== Using Commandline Arguments ==
+
== For End Users ==
 +
End users of OpenSim will not usually encounter the Simulator command line switches.
  
−
OpenSimulator internally uses [http://nini.sourceforge.net/ Nini] as a command line parser.
+
== For Content Builders ==
 +
Content builders on OpenSim will not usually encounter the Simulator command line switches.
  
−
=== Syntax ===
+
== For Simulator Operators ==
 +
These can be used on the command line to customize the current startup session, or they can be used in startup scripts.
  
−
* ''"/key:value" or "/key value" (Windows Style)''
+
=== Switch Syntax ===
−
* ''"-key=value" or "-key value" (*nix Style)''
+
* Windows: ''"/key:value" or "/key value" ''
 +
* Unix, Linux ''"-key=value" or "-key value" ''
 +
* MacOSX: FIXME
  
−
If you want to use the value contains spaces, put it in double-quotes(").
+
If you want to use a value which contains spaces, contain the entire values and spaces inside of double-quotes(").
  
−
Note that "--" likes "--key=value" doesn't work. It seems a bug in the regular syntax in Nini ArgvParser.
+
Note that "--" switches, like "--key=value" do not work.
  
−
=== Boolean Aliases ===
+
It seems a bug in the regular syntax in the external Nini command line parser used by OpenSimulator.
  
−
* True: "=true", "=on", "=yes(in OpenSimulator 0.7.2-dev)"
+
=== Current Switches ===
−
* False: "=false", "=off", "=no(in OpenSimulator 0.7.2-dev)"
+
−
 
+
−
They are not case-sensitive. You can type "True", "TRUE" or "tRue" for example.
+
−
 
+
−
== Current Arguments ==
+
  
 
The following command line switches are known:
 
The following command line switches are known:
Line 80: Line 80:
 
|crashes
 
|crashes
 
|}
 
|}
−
 
  
 
NOTE:
 
NOTE:
−
* Boolean - See [[#Boolean Aliases]] above.
 
 
* filepath - The path relative to the working directory of the user or application, in the most cases, it will be bin/.
 
* filepath - The path relative to the working directory of the user or application, in the most cases, it will be bin/.
 +
* Boolean - See [[#Boolean Aliases]] below.
 +
 +
=== Boolean Aliases ===
 +
Boolean values support several interchangeable aliases starting with OpenSimulator 0.7.2-dev:
 +
* True is the same as On or Yes
 +
* False is the same as Off or No
 +
 +
They are not case-sensitive.
 +
 +
For example, you can type "True", "TRUE" or "tRue"
 +
 +
=== Related INI File Sections ===
 +
In the OpenSim.ini and OpenSimDefaults.ini:
 +
<source lang="ini">
 +
[StartUp]
 +
    ; Set this to true if you want to log crashes to disk
 +
    ; this can be useful when submitting bug reports.
 +
    ; However, this will only log crashes within OpenSimulator that cause the entire program to exit
 +
    ; It will not log crashes caused by virtual machine failures, which includes mono and ODE failures.
 +
    ; You will need to capture these native stack traces by recording the session log itself.
 +
    save_crashes = false
 +
 +
    ; Directory to save crashes to if above is enabled
 +
    ; (default is /opensimdir/crashes/*.txt or C:\opensim\crashes\*.txt)
 +
    crash_dir = "crashes"
 +
</source>
 +
 +
== For Developers ==
 +
OpenSimulator internally uses [http://nini.sourceforge.net/ Nini] as a command line parser.
 +
 +
Command line arguments are parsed in OpenSim/Region/Application/Application.cs

Revision as of 19:40, 8 February 2013

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français


Command line arguments, also known as switches, helpful to modify the behavior of your OpenSimulator for customized environments or debugging.

For End Users

End users of OpenSim will not usually encounter the Simulator command line switches.

For Content Builders

Content builders on OpenSim will not usually encounter the Simulator command line switches.

For Simulator Operators

These can be used on the command line to customize the current startup session, or they can be used in startup scripts.

Switch Syntax

  • Windows: "/key:value" or "/key value"
  • Unix, Linux "-key=value" or "-key value"
  • MacOSX: FIXME

If you want to use a value which contains spaces, contain the entire values and spaces inside of double-quotes(").

Note that "--" switches, like "--key=value" do not work.

It seems a bug in the regular syntax in the external Nini command line parser used by OpenSimulator.

Current Switches

The following command line switches are known:

Switch Values Description Default
logconfig String(filepath) OpenSimulator will configure log4net using this file as configuration file OpenSim.exe.config
background Boolean If true, OpenSimulator will run in the background false
inifile String(filepath) The path to ini file OpenSim.ini
inimaster String(filepath) The path to master ini file OpenSimDefaults.ini
inidirectory String(filepath) The path to folder for config ini files. OpenSimulator will read all of *.ini files in this directory and override OpenSim.ini settings. config
physics "OpenDynamicsEngine", "basicphysics", "POS", "modified_BulletX" The name of the physics engine. It is the same as physics property in [Startup] section. See OpenSim.ini.example for the detailed information. It will override the settings in OpenSim.ini. OpenDynamicsEngine
gui Boolean "old-style" console (deprecated from Opensim 0.7, use -console=basic instead) false
console "basic","rest" If "basic", OpenSimulator will launch a simple console capable of processing commands. If "rest", a RestConsole. If others including empty, a console that uses cursor control and context help(default). (empty)
save_crashes Boolean If true, OpenSimulator will dump stacktraces into the file in the directory specified with 'crash_dir' when it crashes. Note: As of 0.7.1, it doesn't work. It works in 0.7.2-dev. false
crash_dir String(filepath) The path to the directory where crash logs will be created. When OpenSimulator crashes, it will be automatically created if not exists. Note: As of 0.7.1, it doesn't work. It works in 0.7.2-dev. crashes

NOTE:

  • filepath - The path relative to the working directory of the user or application, in the most cases, it will be bin/.
  • Boolean - See #Boolean Aliases below.

Boolean Aliases

Boolean values support several interchangeable aliases starting with OpenSimulator 0.7.2-dev:

  • True is the same as On or Yes
  • False is the same as Off or No

They are not case-sensitive.

For example, you can type "True", "TRUE" or "tRue"

Related INI File Sections

In the OpenSim.ini and OpenSimDefaults.ini: 

[StartUp]
    ; Set this to true if you want to log crashes to disk
    ; this can be useful when submitting bug reports.
    ; However, this will only log crashes within OpenSimulator that cause the entire program to exit
    ; It will not log crashes caused by virtual machine failures, which includes mono and ODE failures.
    ; You will need to capture these native stack traces by recording the session log itself.
    save_crashes = false
 
    ; Directory to save crashes to if above is enabled
    ; (default is /opensimdir/crashes/*.txt or C:\opensim\crashes\*.txt)
    crash_dir = "crashes"

For Developers

OpenSimulator internally uses Nini as a command line parser.

Command line arguments are parsed in OpenSim/Region/Application/Application.cs

Retrieved from "http://opensimulator.org/index.php?title=OpenSim.exe_Command_Line_Options&oldid=31826"
Personal tools
General
About This Wiki