1 dss is known to compile on Linux, FreeBSD and NetBSD. However, it is
2 run-tested only on Linux.
4 Note that [lopsub](http://people.tuebingen.mpg.de/maan/lopsub)
5 is required to compile dss.
11 in the dss source directory to build the dss executable and copy it
12 to some directory that is included in your PATH, e.g. to `$HOME/bin`
13 or to `/usr/local/bin`.
15 Also make sure that [rsync](http://rsync.samba.org/) is installed on
16 your system. Version 2.6.1 or newer is required.
21 Suppose you'd like to create snapshots of the existing directory
29 Create the config file
33 that contains the values for the source and the destination directories
36 echo 'source-dir "/foo/bar"' > ~/.dssrc
37 echo 'dest-dir "/baz/qux"' >> ~/.dssrc
39 Then execute the commands
44 In order to print the list of all snapshots created so far, use
48 Yes, it's really that easy.
50 The second example involves a slightly more sophisticated config file.
51 It instructs dss to exclude everything which matches at least one
52 pattern of the given exclude file, prevents rsync from crossing file
53 system boundaries and increases the number of snapshots.
57 # exclude files matching patterns in /etc/dss.exclude
58 rsync-option "--exclude-from=/etc/dss.exclude"
59 # don't cross filesystem boundaries
60 rsync-option "--one-file-system"
61 # maintain 2^6 - 1 = 63 snaphots
64 The /etc/dss.exclude file could look like this (see rsync(1) for
71 Note that dss supports many more features and config options such
72 as taking snapshots from remote hosts and several hooks that are
73 executed on certain events, for example whenever a snapshot was
74 created successfully. Try
78 for an overview of all supported command line options or
82 for the full help text.