OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixup documentation for AutoBackupModule.

bulletsim
Kim King 2011-05-15 03:35:45 -04:00 committed by Justin Clark-Casey (justincc)
parent e3b8d42bbc
commit 901448a8eb
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
OpenSim/Region/OptionalModules/World/AutoBackup/AutoBackupModule.cs
View File

@ -58,12 +58,9 @@ namespace OpenSim.Region.OptionalModules.World.AutoBackup
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Config Settings Documentation. /// Config Settings Documentation.
/// At the TOP LEVEL, e.g. in OpenSim.ini, we have the following options: /// Each configuration setting can be specified in two places: OpenSim.ini or Regions.ini.
/// EACH REGION, in OpenSim.ini, can have the following settings under the [AutoBackupModule] section. /// If specified in Regions.ini, the settings should be within the region's section name.
/// IMPORTANT: You may optionally specify the key name as follows for a per-region key: [Region Name].[Key Name] /// If specified in OpenSim.ini, the settings should be within the [AutoBackupModule] section.
/// Example: My region is named Foo.
/// 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.
/// Instead of specifying them on a per-region basis, you can also omit the region name to specify the default setting for all regions.
/// Region-specific settings take precedence. /// Region-specific settings take precedence.
/// ///
/// AutoBackupModuleEnabled: True/False. Default: False. If True, use the auto backup module. This setting does not support per-region basis. /// 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
/// AutoBackup: True/False. Default: False. If True, activate auto backup functionality. /// AutoBackup: True/False. Default: False. If True, activate auto backup functionality.
/// This is the only required option for enabling auto-backup; the other options have sane defaults. /// This is the only required option for enabling auto-backup; the other options have sane defaults.
/// If False for a particular region, the auto-backup module becomes a no-op for the region, and all other AutoBackup* settings are ignored. /// If False for a particular region, the auto-backup module becomes a no-op for the region, and all other AutoBackup* settings are ignored.
/// If False globally (the default), only regions that specifically override this with "FooRegion.AutoBackup = true" will get AutoBackup functionality. /// If False globally (the default), only regions that specifically override it in Regions.ini will get AutoBackup functionality.
/// AutoBackupInterval: Double, non-negative value. Default: 720 (12 hours). /// AutoBackupInterval: Double, non-negative value. Default: 720 (12 hours).
/// The number of minutes between each backup attempt. /// The number of minutes between each backup attempt.
/// If a negative or zero value is given, it is equivalent to setting AutoBackup = False. /// If a negative or zero value is given, it is equivalent to setting AutoBackup = False.