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.
-dss is known to compile on Linux, MacOS, Solaris, FreeBSD and
-NetBSD. However, it is run-tested on Linux only.
+Note that you'll likely need a recent version of
+ftp://ftp.gnu.org/pub/gnu/gengetopt/ (gnu gengetopt) to compile dss.
-Also make sure that rsync, http://rsync.samba.org/, is installed on
-your system. Version 2.6.1 or newer is required.
+Optionally, type
-In order to create snapshots of the existing directory
+ make man
- /tmp/foo
+to create the man page of dss. This invokes help2man so make sure
+that help2man is installed on your system. Note that the man page is
+just the nroff variant of the output of "dss --detailed-help".
-in the directory
+dss is known to compile on Linux, MacOS, Solaris, FreeBSD and
+NetBSD. However, it is run-tested only on Linux.
- /tmp/bar,
+Also make sure that http://rsync.samba.org/ (rsync) is installed on
+your system. Version 2.6.1 or newer is required.
+
+Example:
+--------
-execute the commands
+Suppose you'd like to create snapshots of the existing directory
- mkdir /tmp/bar
- ./dss --run --source-dir /tmp/foo --dest-dir /tmp/bar
+ /foo/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.