X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=dss.suite;h=16c7e58542eff8750c8437dcea137f347a435950;hb=0f8170444cf9e2bcc42b64bdcae3a38b7ac55e66;hp=95dd30ff9dc7ea5963957aad8e809a57d0277c52;hpb=f83691dcd50a73c42a39911c06f19c7f2862fa06;p=dss.git diff --git a/dss.suite b/dss.suite index 95dd30f..16c7e58 100644 --- a/dss.suite +++ b/dss.suite @@ -1,3 +1,5 @@ +# SPDX-License-Identifier: GPL-2.0 + [suite dss] caption = Subcommands @@ -60,13 +62,15 @@ caption = Subcommands typestr = dirname arg_info = required_arg arg_type = string + flag multiple [help] The directory on the remote host from which snapshots are taken. Of course, the user specified as --remote-user must have read access to this directory. - This option is mandatory for the create and run subcommands: It must - be given at the command line or in the config file. + This option is mandatory for the create and run subcommands: It may + be given multiple times to specify more than one source directory. + However, all source directories must reside on the same server. [/help] [option dest-dir] summary = where snapshots are stored @@ -78,6 +82,19 @@ caption = Subcommands written. This must be writable by the user who runs dss. This option is mandatory for all subcommands except kill. + Unlike --source-dir, this option may only be given once. + [/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 @@ -475,6 +492,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]