Clarify documentation of --run.

[dss.git] / dss.ggo

diff --git a/dss.ggo b/dss.ggo
index d843906bf718906944fa46bd5e22687f9e14149a..4ff2a6c93acf79fc25fcc4df9e73e050ad72ec39 100644 (file)
--- a/dss.ggo
+++ b/dss.ggo
@@ -133,7 +133,9 @@ groupoption "run" R
 group="command"
 details="
        This is the main mode of operation. Snapshots will be created
-       as needed and pruned automatically.
+       in an endless loop as needed and pruned automatically. The loop
+       only terminates on fatal errors or if a terminating signal was
+       received. See also the --exit-hook option.
 "
 
 ###############################
@@ -214,13 +216,14 @@ details="
        unit intervals.
 
        dss removes any snapshots older than n times u and tries to
-       keep 2^(k-1) snapshots in interval k, where the interval number
-       k counts from zero, zero being the most recent unit interval.
+       keep 2^(n - k - 1) snapshots in interval k, where the interval
+       number k counts from zero, zero being the most recent unit
+       interval.
 
        In other words, the oldest snapshot will at most be u * n days
        (= 20 days if default values are used) old.  Moreover, there
        are at most 2^n - 1 snapshots in total (i. e. 31 by default).
-       Observe that you have to create at least 2 ^ (n - 1) snapshots
+       Observe that you have to create at least 2^(n - 1) snapshots
        each interval for this to work out because that is the number
        of snapshots in interval zero.
 "
@@ -322,3 +325,17 @@ details="
 
        A value of zero (the default) deactivates this check.
 "
+
+option "keep-redundant" k
+#~~~~~~~~~~~~~~~~~~~~~~~~
+"Prune by disk space only"
+flag off
+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
+       becomes low. Use this flag if the file system containing the
+       destination directory is used for snapshots only.
+"