X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=dss.ggo;h=8f1ec5cf8d3ce50194a81f569b8195eb6562a618;hp=9c687f42d575606cdb852bf7b829e4def7d64edf;hb=c279f1a5bd474f002f8486aafbfd0b7f0d4e15c3;hpb=0ca40f54698dc00d81e40f784e27628f8fe802c0 diff --git a/dss.ggo b/dss.ggo index 9c687f4..8f1ec5c 100644 --- a/dss.ggo +++ b/dss.ggo @@ -1,9 +1,9 @@ -# Copyright (C) 2008 Andre Noll +# Copyright (C) 2008-2009 Andre Noll # # Licensed under the GPL v2. For licencing details see COPYING. package "dss" -version "0.1.2" +version "0.1.3" 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. " ################## @@ -110,11 +111,17 @@ groupoption "prune" P "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 @@ -188,6 +195,21 @@ details=" 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" @@ -247,6 +269,7 @@ option "pre-create-hook" r #~~~~~~~~~~~~~~~~~~~~~~~~~~ "Executed before snapshot creation" string typestr="command" +default = "/bin/true" optional details=" Execute this command before trying to create a new snapshot. @@ -265,6 +288,7 @@ option "post-create-hook" o #~~~~~~~~~~~~~~~~~~~~~~~~~~ "Executed after snapshot creation" string typestr="command" +default = "/bin/true" optional details=" Execute this after a snapshot has successfully been @@ -281,11 +305,14 @@ option "pre-remove-hook" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "Executed before snapshot removal" string typestr="command" +default = "/bin/true" optional details=" - Execute this command before removing a snapshot. If this - command returns with a non-zero exit status, no snapshot is - being removed and the operation is retried later. + Execute this command before removing a snapshot. The full + path to the snapshot about to be deleted is passed to the + command as the first argument. If the command returns with + a non-zero exit status, no snapshot is being removed and the + operation is retried later. For example, one might want to execute a script that checks whether the snapshot to be deleted is currently used by @@ -300,18 +327,20 @@ option "post-remove-hook" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "Executed after snapshot removal" string typestr="command" +default = "/bin/true" optional details=" - Execute this after a snapshot has successfully been - removed. The full path of the removed snapshot is - passed to the hook as the first argument. The exit code of - this hook is ignored. + Execute this after a snapshot has successfully been removed. As + for the pre-remove hook, the full path of the removed snapshot + is passed to the hook as the first argument. The exit code + of this hook is ignored. " option "exit-hook" e #~~~~~~~~~~~~~~~~~~~ "Executed if run command exits" string typestr="command" +default = "/bin/true" optional details=" This hook is only used if the --run command was given which