Merge branch 'refs/heads/t/signal_handler_improvement'

[dss.git] / dss.ggo

diff --git a/dss.ggo b/dss.ggo
index f2901638b5e362e8c9ad19e14cd20eaa42e1a382..11529956891db25e5110e03009b88ff5ca36c0c6 100644 (file)
--- a/dss.ggo
+++ b/dss.ggo
@@ -1,9 +1,9 @@
-# Copyright (C) 2008-2010 Andre Noll <maan@systemlinux.org>
+# Copyright (C) 2008-2010 Andre Noll <maan@tuebingen.mpg.de>
 #
 # Licensed under the GPL v2. For licencing details see COPYING.
 
 package "dss"
-version "0.1.4"
+version "0.1.5"
 purpose "the dyadic snapshot scheduler
 
 dss creates hardlink-based snapshots of a given directory on a remote
@@ -41,7 +41,7 @@ flag off
 dependon="logfile"
 details="
        Note that dss refuses to start in daemon mode if no logfile
-       was specified. This option is mostly useful in conjuction
+       was specified. This option is mostly useful in conjunction
        with the -R option described below.
 
        Note that it is not possible to change whether dss runs as
@@ -77,9 +77,10 @@ option "logfile" -
 "Logfile for the dss daemon process"
 string typestr="filename"
 optional
-details="
-       This option is mostly useful for the run command if --daemon
-       is also given.
+details = "
+       This option is only honored if both --run and --daemon are
+       given. Otherwise it is silently ignored and log output is
+       written to stderr.
 "
 
 ##################
@@ -144,6 +145,25 @@ details="
        received. See also the --exit-hook option.
 "
 
+groupoption "kill" K
+#~~~~~~~~~~~~~~~~~~~
+"Kill a running dss process"
+group="command"
+details="
+       This sends SIGTERM to the dss process that corresponds to the
+       given config file. If --dry-run is given, the PID of the dss
+       process is written to stdout, but no signal is sent.
+"
+
+groupoption "reload" -
+#~~~~~~~~~~~~~~~~~~~~~
+"force a running dss process to reload its config file"
+group="command"
+details="
+       This differs from --kill only in that SIGHUP rather than SIGTERM
+       is sent to the dss process.
+"
+
 ###############################
 section "Rsync-related options"
 ###############################
@@ -224,6 +244,26 @@ details="
                --rsync-option --exclude --rsync-option /proc
 "
 
+option "max-rsync-errors" -
+"Terminate after this many rsync failures"
+int typestr="count"
+default="10"
+optional
+details="
+       Only relevant when operating in --run mode (see above). If
+       the rsync process exits with a fatal error, dss restarts
+       the command in the hope that the problem is transient
+       and subsequent rsync runs succeed. After the given number
+       of consecutive rsync error exits, however, dss gives up,
+       executes the exit hook and terminates. Set this to zero if
+       dss should exit immediately on the first rsync error.
+
+       The only non-fatal error is when rsync exits with code 24. This
+       indicates a partial transfer due to vanished source files
+       and happens frequently when snapshotting a directory which
+       is concurrently being modified.
+"
+
 ###################
 section "Intervals"
 ###################
@@ -400,7 +440,8 @@ details="
        Note that not every file system supports the concept of inodes.
        Moreover it is not possible to reliably detect whether this is
        the case. Therefore this feature is disabled by default. It's
-       safe to enable it for ext3 file systems on linux though.
+       safe to enable it for ext2/ext3/ext4 file systems on linux
+       though.
 
        A value of zero (the default) deactivates this check.
 "
@@ -418,3 +459,23 @@ details="
        becomes low. Use this flag if the file system containing the
        destination directory is used for snapshots only.
 "
+
+option "min-complete" -
+#~~~~~~~~~~~~~~~~~~~~~~
+"Minimal number of complete snapshots to keep"
+int typestr = "num"
+default = "1"
+optional
+details = "
+       This option is only relevant if snapshots must be deleted
+       because disk space gets low.
+
+       dss refuses to remove old snapshots if there are fewer complete
+       snapshots left than the given number. The default value of one
+       guarantees that at least one complete snapshot is available
+       at all times.
+
+       If only <num> complete snapshot are left, and there is not
+       enough disk space available for another snapshot, the program
+       terminates with a \"No space left on device\" error.
+"