Add the --kill subcommand.

[dss.git] / dss.ggo

diff --git a/dss.ggo b/dss.ggo
index 2bd899fb5dc9083b12a168c95dc5af73335ccfb4..c594f6e62ef81eacf8c576ede3dc908a9bfe9f58 100644 (file)
--- a/dss.ggo
+++ b/dss.ggo
@@ -3,7 +3,7 @@
 # Licensed under the GPL v2. For licencing details see COPYING.
 
 package "dss"
-version "0.1.3"
+version "0.1.4"
 purpose "the dyadic snapshot scheduler
 
 dss creates hardlink-based snapshots of a given directory on a remote
@@ -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,16 @@ 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.
+"
+
 ###############################
 section "Rsync-related options"
 ###############################
@@ -268,7 +279,7 @@ option "pre-create-hook" r
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed before snapshot creation"
 string typestr="command"
-default = "/bin/true"
+default = "true"
 optional
 details="
        Execute this command before trying to create a new snapshot.
@@ -287,7 +298,7 @@ option "post-create-hook" o
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed after snapshot creation"
 string typestr="command"
-default = "/bin/true"
+default = "true"
 optional
 details="
        Execute this after a snapshot has successfully been
@@ -304,7 +315,7 @@ option "pre-remove-hook" -
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed before snapshot removal"
 string typestr="command"
-default = "/bin/true"
+default = "true"
 optional
 details="
        Execute this command before removing a snapshot. The full
@@ -326,7 +337,7 @@ option "post-remove-hook" -
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed after snapshot removal"
 string typestr="command"
-default = "/bin/true"
+default = "true"
 optional
 details="
        Execute this after a snapshot has successfully been removed. As
@@ -339,7 +350,7 @@ option "exit-hook" e
 #~~~~~~~~~~~~~~~~~~~
 "Executed if run command exits"
 string typestr="command"
-default = "/bin/true"
+default = "true"
 optional
 details="
        This hook is only used if the --run command was given which
@@ -400,7 +411,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.
 "