# Licensed under the GPL v2. For licencing details see COPYING.
package "dss"
-version "0.0.5"
+version "0.1.0"
purpose "the dyadic snapshot scheduler
dss creates hardlink-based snapshots of a given directory on a remote
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.
"
###############################
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"
###############################
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.
+"