Fix typo in documentation of --logfile.

[dss.git] / dss.ggo

diff --git a/dss.ggo b/dss.ggo
index b5eeec91ac89e32ed3ee3550fc50bad74737b345..db119015e9a64c49f0be1edcc4cc88d4ff5c3816 100644 (file)
--- a/dss.ggo
+++ b/dss.ggo
@@ -1,9 +1,9 @@
-# Copyright (C) 2008-2009 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"
 #
 # Licensed under the GPL v2. For licencing details see COPYING.
 
 package "dss"

-version "0.1.2"
+version "0.1.5"

 purpose "the dyadic snapshot scheduler
 
 dss creates hardlink-based snapshots of a given directory on a remote
 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
 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
        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
 "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.

 "
 
 ##################
 "
 
 ##################


@@ -110,11 +111,17 @@ groupoption "prune" P
 "Remove redundant and outdated snapshots"
 group="command"
 details="
 "Remove redundant and outdated snapshots"
 group="command"
 details="

-       A snapshot is considered outdated if it belongs to an interval
-       greater than the maximum number of intervals. It is said to be
-       redundant if it belongs to an interval that already contains
-       more than the desired number of snapshots. This command gets
-       rid of such snapshots.
+       A snapshot is considered outdated if its interval number
+       is greater or equal than the specified number of unit
+       intervals. See the \"Intervals\" section below for the precise
+       definition of these terms.
+
+       A snapshot is said to be redundant if it belongs to an
+       interval that already contains more than the desired number
+       of snapshots.
+
+       The prune command gets rid of both outdated and redundant
+       snapshots.

 "
 
 groupoption "ls" L
 "
 
 groupoption "ls" L


@@ -138,6 +145,25 @@ details="
        received. See also the --exit-hook option.
 "
 
        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"
 ###############################
 ###############################
 section "Rsync-related options"
 ###############################


@@ -188,6 +214,21 @@ details="
        dss.
 "
 
        dss.
 "
 

+option "no-resume" -
+#~~~~~~~~~~~~~~~~~~~
+"Do not try to resume from previous runs"
+flag off
+details = "
+       Starting from version 0.1.4, dss tries to resume from a
+       previously cancelled dss instance by default. It does so by
+       looking at the status of the most recently created snapshot. If
+       this snapshot status is incomplete, its directory is reused
+       as the destination directory for a subsequent rsync run.
+
+       The --no-resume option deactivates this feature so that a new
+       directory is always used as the rsync destination directory.
+"
+

 option "rsync-option" O
 #~~~~~~~~~~~~~~~~~~~~~~
 "Further rsync options"
 option "rsync-option" O
 #~~~~~~~~~~~~~~~~~~~~~~
 "Further rsync options"


@@ -247,6 +288,7 @@ option "pre-create-hook" r
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed before snapshot creation"
 string typestr="command"
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed before snapshot creation"
 string typestr="command"

+default = "true"

 optional
 details="
        Execute this command before trying to create a new snapshot.
 optional
 details="
        Execute this command before trying to create a new snapshot.


@@ -265,6 +307,7 @@ option "post-create-hook" o
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed after snapshot creation"
 string typestr="command"
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed after snapshot creation"
 string typestr="command"

+default = "true"

 optional
 details="
        Execute this after a snapshot has successfully been
 optional
 details="
        Execute this after a snapshot has successfully been


@@ -281,6 +324,7 @@ option "pre-remove-hook" -
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed before snapshot removal"
 string typestr="command"
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed before snapshot removal"
 string typestr="command"

+default = "true"

 optional
 details="
        Execute this command before removing a snapshot. The full
 optional
 details="
        Execute this command before removing a snapshot. The full


@@ -302,6 +346,7 @@ option "post-remove-hook" -
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed after snapshot removal"
 string typestr="command"
 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 "Executed after snapshot removal"
 string typestr="command"

+default = "true"

 optional
 details="
        Execute this after a snapshot has successfully been removed. As
 optional
 details="
        Execute this after a snapshot has successfully been removed. As


@@ -314,6 +359,7 @@ option "exit-hook" e
 #~~~~~~~~~~~~~~~~~~~
 "Executed if run command exits"
 string typestr="command"
 #~~~~~~~~~~~~~~~~~~~
 "Executed if run command exits"
 string typestr="command"

+default = "true"

 optional
 details="
        This hook is only used if the --run command was given which
 optional
 details="
        This hook is only used if the --run command was given which


@@ -374,7 +420,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
        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.
 "
 
        A value of zero (the default) deactivates this check.
 "


@@ -392,3 +439,23 @@ details="
        becomes low. Use this flag if the file system containing the
        destination directory is used for snapshots only.
 "
        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.
+"