1 files changed, 44 insertions, 0 deletions

diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index 05bc433..9c15284 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -2,6 +2,50 @@
 ; by changing the same setting in OpenSim.ini (once OpenSim.ini.example has been copied to OpenSim.ini).
 
 
+;; This is the main configuration file for OpenSimulator.
+;; If it's named OpenSim.ini then it will be loaded by OpenSimulator.
+;; If it's named OpenSim.ini.example then you will need to copy it to 
+;; OpenSim.ini first (if that file does not already exist)
+;;
+;; If you are copying, then once you have copied OpenSim.ini.example to 
+;; OpenSim.ini you will need to pick an architecture in the [Architecture] 
+;; section at the end of this file.
+;;
+;; The settings in this file are in the form "<key> = <value>".  For example, 
+;; save_crashes = false in the [Startup] section below.
+;;
+;; All settings are initially commented out and the default value used, as 
+;; found in OpenSimDefaults.ini.  To change a setting, first uncomment it by 
+;; deleting the initial semicolon (;) and then change the value.  This will
+;; override the value in OpenSimDefaults.ini
+;; 
+;; If you want to find out what configuration OpenSimulator has finished with
+;; once all the configuration files are loaded then type "config show" on the
+;; region console command line.
+;;
+;; 
+;; NOTES FOR DEVELOPERS REGARDING THE FORMAT OF THIS FILE
+;;
+;; All leading white space is ignored, but preserved.
+;;
+;; Double semicolons denote a text comment
+;;
+;; ;# denotes a configuration directive description
+;;    formatted as:
+;;    {option} {depends on} {question to ask} {choices} default value
+;;    Any text comments following the declaration, up to the next blank line.
+;;    will be copied to the generated file (NOTE: generation is not yet
+;;    implemented)
+;;
+;;    A * in the choices list will allow an empty entry.
+;;    An empty question will set the default if the dependencies are
+;;    satisfied.
+;;
+;; ;  denotes a commented out option.
+;;    Any options added to OpenSim.ini.example should be initially commented 
+;;    out.
+
+
 [Includes]
     ; Define your server specific constants in this file.
     Include-Common = ../../config/config.ini