From a9b7487fcb657bf50d69a522fb9dfb37d547f347 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Thu, 30 Jun 2011 22:36:22 +0100
Subject: improve and tidy up some config file comments

---
 bin/OpenSim.ini.example | 11 +++++------
 bin/OpenSimDefaults.ini | 23 +++++++++++++++--------
 2 files changed, 20 insertions(+), 14 deletions(-)

(limited to 'bin')

diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index df4e60b..a4f243d 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -78,20 +78,19 @@
     ; DrawPrimOnMapTile = true
 
     ;# {NonPhysicalPrimMax} {} {Maximum size of nonphysical prims?} {} 256
-    ;; Maximum size for non-physical prims
+    ;; Maximum size for non-physical prims.  Affects resizing of existing prims.  This can be overriden in the region config file (as NonphysicalPrimMax!).
     ; NonPhysicalPrimMax = 256
 
     ;# {PhysicalPrimMax} {} {Maximum size of physical prims?} {} 10
-    ;; Maximum size where a prim can be physical
+    ;; Maximum size where a prim can be physical.  Affects resizing of existing prims.  This can be overriden in the region config file.
     ; PhysicalPrimMax = 10
 
-    ;; Prevent the creation, import and rez of prims that exceed the
-    ;; maximum size.
+    ;; If a viewer attempts to rez a prim larger than the non-physical or physical prim max, clamp the dimensions to the appropriate maximum
+    ;; This can be overriden in the region config file.
     ; ClampPrimSize = false
 
     ;# {AllowScriptCrossing} {} {Allow scripts to cross into this region} {true false} false
-    ;; Allow scripts to cross region boundaries. These are recompiled on the
-    ;; new region.
+    ;; Allow scripts to keep running when they cross region boundaries, rather than being restarted.  Script code is recompiled on the destination region and the state reloaded.
     ; AllowScriptCrossing = false
 
     ;# {TrustBinaries} {AllowScriptCrossing:true} {Accept compiled binary script code? (DANGEROUS!)} {true false} false
diff --git a/bin/OpenSimDefaults.ini b/bin/OpenSimDefaults.ini
index 57db852..400d3df 100644
--- a/bin/OpenSimDefaults.ini
+++ b/bin/OpenSimDefaults.ini
@@ -14,10 +14,13 @@
     ; Place to create a PID file
     ; PIDFile = "/tmp/my.pid"
 
+    ; Console commands run at startup
     startup_console_commands_file = "startup_commands.txt"
+
+    ; Console commands run on shutdown
     shutdown_console_commands_file = "shutdown_commands.txt"
 
-    ; To run a script every few minutes, set the script filename here
+    ; Console commands run every 20 minutes
     ; timer_Script = "filename"
 
     ; ##
@@ -70,12 +73,17 @@
     ; Use terrain texture for maptiles if true, use shaded green if false
     TextureOnMapTile = false
 
-    ; Maximum total size, and maximum size where a prim can be physical
+    ; Maximum size of non physical prims.  Affects resizing of existing prims.  This can be overriden in the region config file (as NonphysicalPrimMax!).
     NonPhysicalPrimMax = 256
-    PhysicalPrimMax = 10 ; (I think this was moved to the Regions.ini!)
+
+    ; Maximum size of physical prims.  Affects resizing of existing prims.  This can be overriden in the region config file.
+    PhysicalPrimMax = 10
+
+    ; If a viewer attempts to rez a prim larger than the non-physical or physical prim max, clamp the dimensions to the appropriate maximum
+    ; This can be overriden in the region config file.
     ClampPrimSize = false
 
-    ; Allow scripts to cross region boundaries.  These are recompiled on the new region.
+    ; Allow scripts to keep running when they cross region boundaries, rather than being restarted.  Script code is recompiled on the destination region and the state reloaded.
     AllowScriptCrossing = false
 
     ; Allow compiled script binary code to cross region boundaries.
@@ -94,7 +102,7 @@
     ; neighbors on each side for a total of 49 regions in view. Warning, unless
     ; all the regions have the same drawdistance, you will end up with strange
     ; effects because the agents that get closed may be inconsistent.
-    ; DefaultDrawDistance = 255.0
+    DefaultDrawDistance = 255.0
 
     ; If you have only one region in an instance, or to avoid the many bugs
     ; that you can trigger in modules by restarting a region, set this to
@@ -102,7 +110,7 @@
     ; This is meant to be used on systems where some external system like
     ; Monit will restart any instance that exits, thereby making the shutdown
     ; into a restart.
-    ;InworldRestartShutsDown = false
+    InworldRestartShutsDown = false
 
     ; ##
     ; ## PRIM STORAGE
@@ -227,7 +235,6 @@
 
     ; If enabled, enableFlySlow will change the primary fly state to
     ; FLYSLOW, and the "always run" state will be the regular fly.
-
     enableflyslow = false
 
     ; PreJump is an additional animation state, but it probably
@@ -236,7 +243,6 @@
 
     ; This is commented so it will come on automatically once it's
     ; supported.
-
     ; enableprejump = true
 
     ; Simulator Stats URI
@@ -265,6 +271,7 @@
     DelayBeforeAppearanceSave = 5
     DelayBeforeAppearanceSend = 2
 
+
 [SMTP]
     enabled=false
 
-- 
cgit v1.1