INSTALL

   1 Type
   2
   3         make
   4
   5 in the dss source directory to build the dss executable and copy it to
   6 some directory that is included in your PATH, e.g. to $HOME/bin or to
   7 /usr/local/bin.
   8
   9 Note that you'll likely need a recent version of
  10 ftp://ftp.gnu.org/pub/gnu/gengetopt/ (gnu gengetopt) to compile dss.
  11
  12 Optionally, type
  13
  14          make man
  15
  16 to create the man page of dss. This invokes help2man so make sure
  17 that help2man is installed on your system. Note that the man page is
  18 just the nroff variant of the output of "dss --detailed-help".
  19
  20 dss is known to compile on Linux, MacOS, Solaris, FreeBSD and
  21 NetBSD. However, it is run-tested only on Linux.
  22
  23 Also make sure that http://rsync.samba.org/ (rsync) is installed on
  24 your system. Version 2.6.1 or newer is required.
  25
  26 Example:
  27 --------
  28
  29 Suppose you'd like to create snapshots of the existing directory
  30
  31         /foo/bar
  32
  33 in the directory
  34
  35         /baz/qux.
  36
  37 Create the config file
  38
  39         ~/.dssrc
  40
  41 that contains the values for the source and the destination directories
  42 as follows:
  43
  44         echo 'source-dir "/foo/bar"' > ~/.dssrc
  45         echo 'dest-dir "/baz/qux"' >> ~/.dssrc
  46
  47 Then execute the commands
  48
  49         mkdir /baz/qux
  50         dss --run
  51
  52 In order to print the list of all snapshots created so far, use
  53
  54         dss --list
  55
  56 Yes, it's really that easy. Of course, dss supports many more
  57 features and config options such as taking snapshots from remote
  58 hosts and several hooks that are executed on certain events, for
  59 example whenever a snapshot was created successfully.  Try
  60
  61         dss -h
  62
  63 for an overview of all supported command line options or
  64
  65         dss --detailed-help
  66
  67 for the full help text.