X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=dss.suite;h=03e147414d475cc10f1176f434acd98d1dea3e57;hp=95dd30ff9dc7ea5963957aad8e809a57d0277c52;hb=56f81b0dfa62bb5bf2c338733d9370a8b11bfc39;hpb=50e03ce10c3bab1c43e1e68dca3b0471d63807d9 diff --git a/dss.suite b/dss.suite index 95dd30f..03e1474 100644 --- a/dss.suite +++ b/dss.suite @@ -1,3 +1,5 @@ +# SPDX-License-Identifier: GPL-2.0 + [suite dss] caption = Subcommands @@ -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 @@ -475,6 +489,27 @@ 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]