Clarify usage of --rsync-option.

[dss.git] / dss.ggo

diff --git a/dss.ggo b/dss.ggo
index 4ff2a6c93acf79fc25fcc4df9e73e050ad72ec39..099df4cd163765da66e2ba7eb1dca26789af1ed4 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.0.5"
+version "0.1.2"
 purpose "the dyadic snapshot scheduler
 
 dss creates hardlink-based snapshots of a given directory on a remote
@@ -195,8 +195,12 @@ string typestr="option"
 optional
 multiple
 details="
-       These option may be given multiple times. The arguments passed
-       to that option are passed verbatim to the rsync command.
+       This option may be given multiple times. The given argument is
+       passed verbatim to the rsync command. Note that in order to use
+       rsync options that require an argument, you have to specify the
+       option and its argument as separate --rsync-options, like this:
+
+               --rsync-option --exclude --rsync-option /proc
 "
 
 ###################
@@ -273,6 +277,22 @@ details="
        store them in a database for further analysis.
 "
 
+option "exit-hook" e
+#~~~~~~~~~~~~~~~~~~~
+"Executed if run command exits"
+string typestr="command"
+optional
+details="
+       This hook is only used if the --run command was given which
+       instructs dss to run in an endless loop. The exit-hook gets
+       executed whenever this endless loop terminates. The reason
+       for terminating the loop is passed as the first argument.
+
+       One possible application for this hook is to send email to the
+       system administrator to let her know that no more snapshots
+       are going to be created.
+"
+
 ###############################
 section "Disk space monitoring"
 ###############################
@@ -334,8 +354,8 @@ details="
        If this flag is not given dss removes redundant and outdated
        snapshots automatically.
 
-       Otherwise, this feature is deactivated so that snapshots
-       are only being removed in case disk space or inode ratio
+       Otherwise, this feature is deactivated so that snapshots are
+       only being removed in case disk space or number of free inodes
        becomes low. Use this flag if the file system containing the
        destination directory is used for snapshots only.
 "