X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=dss.suite;h=95dd30ff9dc7ea5963957aad8e809a57d0277c52;hp=e7473cb6d2f4ab619c753262664ff5c377ed21c6;hb=f83691dcd50a73c42a39911c06f19c7f2862fa06;hpb=3025388040c1521121255e5ae7ceabdcb1b1e421

diff --git a/dss.suite b/dss.suite
index e7473cb..95dd30f 100644
--- a/dss.suite
+++ b/dss.suite
@@ -34,7 +34,7 @@ caption = Subcommands
 			However, there is one exception to this rule: The run subcommand
 			re-reads the configuration file when it receives the HUP signal. In
 			this case the options in the config file override any options that
-			were previously given at the command line. This allows to change the
+			were previously given at the command line. This allows changing the
 			configuration of a running dss process by sending SIGHUP.
 		[/help]
 	[option loglevel]
@@ -109,6 +109,29 @@ caption = Subcommands
 			Set this if the user that runs dss is different from the user on the
 			remote host.
 		[/help]
+	[option checksum]
+		summary = run rsync with --checksum occasionally
+		typestr = permille
+		arg_info = required_arg
+		arg_type = uint32
+		default_val = 0
+		[help]
+			If a file on the backup becomes corrupt in a way that file size
+			and modification time still match the original file, rsync will not
+			consider the file for transfer ("quick check"). Hence the corruption
+			stays on the backup until the file is modified on the source.
+			The --checksum option of rsync disables the quick check and compares
+			the contents of each file, fixing such corruptions. Since computing
+			the checksums adds a significant slowdown due to a lot of disk I/O,
+			the option is not enabled by default.
+
+			The argument to the --checksum option of dss is a number between 0
+			and 1000, inclusively, which determines the probability of adding
+			--checksum to the rsync options each time a snapshot is created. The
+			default value zero means to never add the option. The value 100 will
+			create every tenth snapshot (on average) using checksums, and the
+			value 1000 will always pass --checksum to rsync.
+		[/help]
 	[option rsync-option]
 		short_opt = O
 		summary = further rsync options
@@ -289,8 +312,8 @@ caption = Subcommands
 		typestr = percent
 		default_val = 2
 		[help]
-			This is like --min-free-mb but allows to specify the amount of
-			free disk space as a percentage. It is not recommended to set both
+			This is like --min-free-mb but the amount of free disk space
+			is specified as a percentage. It is not recommended to set both
 			--min-free-mb and --min-free-percent to zero as this will cause your
 			file system to fill up quickly.
 		[/help]
@@ -452,6 +475,14 @@ caption = Subcommands
 
 			Sending SIGHUP causes the running dss process to reload its config file.
 		[/help]
+[subcommand configtest]
+	purpose = run a configuration file syntax test
+	[description]
+		This command checks the command line options and the configuration
+		file for syntactic correctness. It either reports "Syntax Ok" and
+		exits successfully or prints information about the first syntax error
+		detected and terminates with exit code 1.
+	[/description]
 
 [section copyright]
 	Written by Andre Noll