diff options
| -rw-r--r-- | OpenSim/Region/OptionalModules/World/AutoBackup/AutoBackupModule.cs | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/OpenSim/Region/OptionalModules/World/AutoBackup/AutoBackupModule.cs b/OpenSim/Region/OptionalModules/World/AutoBackup/AutoBackupModule.cs index ce9a448..d40caeb 100644 --- a/OpenSim/Region/OptionalModules/World/AutoBackup/AutoBackupModule.cs +++ b/OpenSim/Region/OptionalModules/World/AutoBackup/AutoBackupModule.cs | |||
| @@ -58,12 +58,9 @@ namespace OpenSim.Region.OptionalModules.World.AutoBackup | |||
| 58 | /// </summary> | 58 | /// </summary> |
| 59 | /// <remarks> | 59 | /// <remarks> |
| 60 | /// Config Settings Documentation. | 60 | /// Config Settings Documentation. |
| 61 | /// At the TOP LEVEL, e.g. in OpenSim.ini, we have the following options: | 61 | /// Each configuration setting can be specified in two places: OpenSim.ini or Regions.ini. |
| 62 | /// EACH REGION, in OpenSim.ini, can have the following settings under the [AutoBackupModule] section. | 62 | /// If specified in Regions.ini, the settings should be within the region's section name. |
| 63 | /// IMPORTANT: You may optionally specify the key name as follows for a per-region key: [Region Name].[Key Name] | 63 | /// If specified in OpenSim.ini, the settings should be within the [AutoBackupModule] section. |
| 64 | /// Example: My region is named Foo. | ||
| 65 | /// If I wanted to specify the "AutoBackupInterval" key just for this region, I would name my key "Foo.AutoBackupInterval", under the [AutoBackupModule] section of OpenSim.ini. | ||
| 66 | /// Instead of specifying them on a per-region basis, you can also omit the region name to specify the default setting for all regions. | ||
| 67 | /// Region-specific settings take precedence. | 64 | /// Region-specific settings take precedence. |
| 68 | /// | 65 | /// |
| 69 | /// AutoBackupModuleEnabled: True/False. Default: False. If True, use the auto backup module. This setting does not support per-region basis. | 66 | /// AutoBackupModuleEnabled: True/False. Default: False. If True, use the auto backup module. This setting does not support per-region basis. |
| @@ -71,7 +68,7 @@ namespace OpenSim.Region.OptionalModules.World.AutoBackup | |||
| 71 | /// AutoBackup: True/False. Default: False. If True, activate auto backup functionality. | 68 | /// AutoBackup: True/False. Default: False. If True, activate auto backup functionality. |
| 72 | /// This is the only required option for enabling auto-backup; the other options have sane defaults. | 69 | /// This is the only required option for enabling auto-backup; the other options have sane defaults. |
| 73 | /// If False for a particular region, the auto-backup module becomes a no-op for the region, and all other AutoBackup* settings are ignored. | 70 | /// If False for a particular region, the auto-backup module becomes a no-op for the region, and all other AutoBackup* settings are ignored. |
| 74 | /// If False globally (the default), only regions that specifically override this with "FooRegion.AutoBackup = true" will get AutoBackup functionality. | 71 | /// If False globally (the default), only regions that specifically override it in Regions.ini will get AutoBackup functionality. |
| 75 | /// AutoBackupInterval: Double, non-negative value. Default: 720 (12 hours). | 72 | /// AutoBackupInterval: Double, non-negative value. Default: 720 (12 hours). |
| 76 | /// The number of minutes between each backup attempt. | 73 | /// The number of minutes between each backup attempt. |
| 77 | /// If a negative or zero value is given, it is equivalent to setting AutoBackup = False. | 74 | /// If a negative or zero value is given, it is equivalent to setting AutoBackup = False. |