X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=INSTALL;h=a99abead6bc3ef9a5bdbafb64c82c42b21a6d1e0;hp=1043ec514884e406adf75dc91678fc8ef1bed775;hb=bc13db9debf825347d397c292e075cbe3f804ac0;hpb=f3b245ab25dbcf1ba18dc7c99d2e599128a90229 diff --git a/INSTALL b/INSTALL index 1043ec5..a99abea 100644 --- a/INSTALL +++ b/INSTALL @@ -23,8 +23,8 @@ NetBSD. However, it is run-tested only on Linux. Also make sure that http://rsync.samba.org/ (rsync) is installed on your system. Version 2.6.1 or newer is required. -Example: --------- +Examples: +--------- Suppose you'd like to create snapshots of the existing directory @@ -51,12 +51,35 @@ Then execute the commands In order to print the list of all snapshots created so far, use - dss --list + dss --ls -Yes, it's really that easy. Of course, dss supports many more -features and config options such as taking snapshots from remote -hosts and several hooks that are executed on certain events, for -example whenever a snapshot was created successfully. Try +Yes, it's really that easy. + +The second example involves a slightly more sophisticated config file. +It instructs dss to exclude everything which matches at least one +pattern of the given exclude file, prevents rsync from crossing file +system boundaries and increases the number of snapshots. + + source-dir "/foo/bar" + dest-dir "/baz/qux" + # exclude files matching patterns in /etc/dss.exclude + rsync-option "--exclude-from=/etc/dss.exclude" + # don't cross filesystem boundaries + rsync-option "--one-file-system" + # maintain 2^6 - 1 = 63 snaphots + num-intervals "6" + +The /etc/dss.exclude file could look like this (see rsync(1) for +more examples) + + + - /proc + - /**/tmp/ + +Note that dss supports many more features and config options such +as taking snapshots from remote hosts and several hooks that are +executed on certain events, for example whenever a snapshot was +created successfully. Try dss -h