X-Git-Url: http://git.tuebingen.mpg.de/?p=dss.git;a=blobdiff_plain;f=INSTALL;h=09d8505b3a46d5381a8626fd462ee7a6fd149af5;hp=db3d1c56386bb4c117c333adbe84c4694664c9e9;hb=45ae697d187c12a7ed40ae71b6a8adeda4b32b6c;hpb=41c5e79dcdd912777b7e235b6e9d238a066a21d0 diff --git a/INSTALL b/INSTALL index db3d1c5..09d8505 100644 --- a/INSTALL +++ b/INSTALL @@ -1,27 +1,30 @@ +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 -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`. +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: -Note that [gnu -gengetopt](https://www.gnu.org/software/gengetopt/gengetopt.html) -is required to compile dss. + make CPPFLAGS=-I$HOME/lopsub/include LDFLAGS=-L$HOME/lopsub/lib + +Then type -Optionally, type + sudo make install - make man +to install in /usr/local, or -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`. + make install PREFIX=/somewhere/else -dss is known to compile on Linux, MacOS, Solaris, FreeBSD and -NetBSD. However, it is run-tested only on Linux. +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. Examples: @@ -48,11 +51,11 @@ as follows: Then execute the commands mkdir /baz/qux - dss --run + dss run In order to print the list of all snapshots created so far, use - dss --ls + dss ls Yes, it's really that easy. @@ -67,7 +70,7 @@ system boundaries and increases the number of snapshots. rsync-option "--exclude-from=/etc/dss.exclude" # don't cross filesystem boundaries rsync-option "--one-file-system" - # maintain 2^6 - 1 = 63 snaphots + # maintain 2^6 - 1 = 63 snapshots num-intervals "6" The /etc/dss.exclude file could look like this (see rsync(1) for