X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=INSTALL;h=8dd3846bb3cd8aa5c4264b84c2ef6756fed2f991;hp=bebfe05f5e50cad84c138a38a26ba85697a2c126;hb=df465017098a79eaa7b1c1c2f958f262b4dc521e;hpb=40aebcfaecb7ad2414794d4a3f41e0603c08a6e1 diff --git a/INSTALL b/INSTALL index bebfe05..8dd3846 100644 --- a/INSTALL +++ b/INSTALL @@ -2,60 +2,58 @@ Type make -in the dss source directory to build the dss executable. You -likely need a recent version of gnu gengetopt, -ftp://ftp.gnu.org/pub/gnu/gengetopt/, to compile dss. +in the dss source directory to build the dss executable and copy it to +some directory that is included in your PATH, e.g. to $HOME/bin or to +/usr/local/bin. + +Note that you'll likely need a recent version of +ftp://ftp.gnu.org/pub/gnu/gengetopt/ (gnu gengetopt) to compile dss. dss is known to compile on Linux, MacOS, Solaris, FreeBSD and -NetBSD. However, it is run-tested on Linux only. +NetBSD. However, it is run-tested only on Linux. -Also make sure that rsync, http://rsync.samba.org/, is installed on +Also make sure that http://rsync.samba.org/ (rsync) is installed on your system. Version 2.6.1 or newer is required. -In order to create snapshots of the existing directory - - /tmp/foo - -in the directory +Example: +-------- - /tmp/bar, +Suppose you'd like to create snapshots of the existing directory -execute the commands + /foo/bar - mkdir /tmp/bar - ./dss --run --source-dir /tmp/foo --dest-dir /tmp/bar - -To print a list of all snapshots created so far, use +in the directory - ./dss --list --source-dir /tmp/foo --dest-dir /tmp/bar + /baz/qux. -You might want to create the config file +Create the config file ~/.dssrc -that contains the values for the source and the destination -directories. In the above example, this file would contain the -following lines: - - source-dir "/tmp/foo" - dest-dir "/tmp/bar" +that contains the values for the source and the destination directories +as follows: -Using a configuration file allows you to simply type + echo 'source-dir "/foo/bar"' > ~/.dssrc + echo 'dest-dir "/baz/qux"' >> ~/.dssrc - ./dss --run +Then execute the commands -to start snapshot creation and + mkdir /baz/qux + dss --run - ./dss --list +In order to print the list of all snapshots created so far, use -to list all avalable snapshots. + dss --list -Try +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 - ./dss -h + dss -h for an overview of all supported command line options or - ./dss --detailed-help + dss --detailed-help for the full help text.