X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=dss.suite;h=03e147414d475cc10f1176f434acd98d1dea3e57;hp=e69cc28630c8a39359cba3aead33ab3b847011a8;hb=56f81b0dfa62bb5bf2c338733d9370a8b11bfc39;hpb=e64460eb7c840399e46fc54da3b348fee33e550d

diff --git a/dss.suite b/dss.suite
index e69cc28..03e1474 100644
--- a/dss.suite
+++ b/dss.suite
@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-2.0
+
 [suite dss]
 caption = Subcommands
 
@@ -34,7 +36,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]
@@ -79,6 +81,18 @@ caption = Subcommands
 
 			This option is mandatory for all subcommands except kill.
 		[/help]
+	[option mountpoint]
+		summary = abort if destination directory is not a mountpoint
+		[help]
+			This option checks whether a file system is mounted on the directory
+			specified as the argument to --dest-dir. Operation proceeds only
+			if this is the case. Otherwise dss exits unsuccessfully without
+			performing any action. Use this option to prevent snapshot creation
+			if the snapshot file system is not mounted.
+
+			This option is silently ignored for subcommands which do not depend
+			on the destination directory.
+		[/help]
 	[option Rsync-options]
 		summary = Controlling how rsync is run
 		flag ignored
@@ -312,8 +326,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]
@@ -475,6 +489,35 @@ caption = Subcommands
 
 			Sending SIGHUP causes the running dss process to reload its config file.
 		[/help]
+	[option wait]
+		short_opt = w
+		summary = wait until the signalled process has terminated
+		[help]
+			This option is handy for system shutdown scripts which would like
+			to terminate the dss daemon process.
+
+			Without --wait the dss process which executes the kill subcommand
+			exits right after the kill(2) system call returns. At this point the
+			signalled process might still be alive (even if SIGKILL was sent).
+			If --wait is given, the process waits until the signalled process
+			has terminated or the timeout expires.
+
+			If --wait is not given, the kill subcommand exits successfully if
+			and only if the signal was sent (i.e., if there exists another dss
+			process to receive the signal). With --wait it exits successfully
+			if, additionally, the signalled process has terminated before the
+			timeout expires.
+
+			It makes only sense to use the option for signals which terminate dss.
+		[/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