X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=INSTALL;h=09d8505b3a46d5381a8626fd462ee7a6fd149af5;hp=58a03fbae85a5e73962d53b2fa3364c6e9c47bf8;hb=HEAD;hpb=6e42820324ffb57f3d1fc1e58e1ec5bbdf97c820

diff --git a/INSTALL b/INSTALL
index 58a03fb..09d8505 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,56 +1,94 @@
+dss is known to compile on Linux, FreeBSD and NetBSD. However, it is
+run-tested only on Linux.
+
+Note that [lopsub](http://people.tuebingen.mpg.de/maan/lopsub)
+is required to compile dss.
+
 Type
 
-	make
+		make
+
+in the dss source directory to build the dss executable and the man
+page. If lopsub is installed in a non-standard path, you may need to
+run `make` as follows:
+
+		make CPPFLAGS=-I$HOME/lopsub/include LDFLAGS=-L$HOME/lopsub/lib
+
+Then type
+
+		sudo make install
+
+to install in /usr/local, or
 
-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.
+		make install PREFIX=/somewhere/else
 
-dss is known to compile on Linux, MacOS, Solaris, FreeBSD and
-NetBSD. However, it is run-tested on Linux only.
+to install in /somewhere/else.
 
-Also make sure that rsync, http://rsync.samba.org/, is installed on
+Also make sure that [rsync](https://rsync.samba.org/) 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
 
-	/foo/bar
+		/foo/bar
 
 in the directory
 
-	/baz/qux.
+		/baz/qux.
 
 Create the config file
 
-	~/.dssrc
+		~/.dssrc
 
 that contains the values for the source and the destination directories
 as follows:
 
-	echo 'source-dir "/foo/bar"' > ~/.dssrc
-	echo 'dest-dir "/baz/qux"' >> ~/.dssrc
+		echo 'source-dir "/foo/bar"' > ~/.dssrc
+		echo 'dest-dir "/baz/qux"' >> ~/.dssrc
 
 Then execute the commands
 
-	mkdir /baz/qux
-	./dss --run
+		mkdir /baz/qux
+		dss run
 
 In order to print the list of all snapshots created so far, use
 
-	./dss --list
+		dss ls
+
+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 snapshots
+		num-intervals "6"
+
+The /etc/dss.exclude file could look like this (see rsync(1) for
+more examples)
+
+
+		 - /proc
+		 - /**/tmp/
 
-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 whenever on certain events,
-for example whenever a snapshot was created successfully.  Try
+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
+		dss -h
 
 for an overview of all supported command line options or
 
-	./dss --detailed-help
+		dss --detailed-help
 
 for the full help text.