Fix bad grammar "allows <infinitive>".

[dss.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index a99abead6bc3ef9a5bdbafb64c82c42b21a6d1e0..09d8505b3a46d5381a8626fd462ee7a6fd149af5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,26 +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
 
 Type
 

-       make
+               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 you'll likely need a recent version of
-ftp://ftp.gnu.org/pub/gnu/gengetopt/ (gnu gengetopt) to compile dss.
+               make CPPFLAGS=-I$HOME/lopsub/include LDFLAGS=-L$HOME/lopsub/lib

 
 

-Optionally, type
+Then type

 
 

-        make man
+               sudo make install

 
 

-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".
+to install in /usr/local, or

 
 

-dss is known to compile on Linux, MacOS, Solaris, FreeBSD and
-NetBSD. However, it is run-tested only on Linux.
+               make install PREFIX=/somewhere/else

 
 

-Also make sure that http://rsync.samba.org/ (rsync) is installed on
+to install in /somewhere/else.
+
+Also make sure that [rsync](https://rsync.samba.org/) is installed on

 your system. Version 2.6.1 or newer is required.
 
 Examples:
 your system. Version 2.6.1 or newer is required.
 
 Examples:


@@ -28,30 +32,30 @@ Examples:
 
 Suppose you'd like to create snapshots of the existing directory
 
 
 Suppose you'd like to create snapshots of the existing directory
 

-       /foo/bar
+               /foo/bar

 
 in the directory
 
 
 in the directory
 

-       /baz/qux.
+               /baz/qux.

 
 Create the config file
 
 
 Create the config file
 

-       ~/.dssrc
+               ~/.dssrc

 
 that contains the values for the source and the destination directories
 as follows:
 
 
 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
 
 
 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
 
 
 In order to print the list of all snapshots created so far, use
 

-       dss --ls
+               dss ls

 
 Yes, it's really that easy.
 
 
 Yes, it's really that easy.
 


@@ -60,31 +64,31 @@ 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.
 
 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 snaphots
-       num-intervals "6"
+               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)
 
 
 The /etc/dss.exclude file could look like this (see rsync(1) for
 more examples)
 

- 
-        - /proc
-        - /**/tmp/
+
+                - /proc
+                - /**/tmp/

 
 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
 
 
 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
 
 
 for an overview of all supported command line options or
 

-       dss --detailed-help
+               dss --detailed-help

 
 for the full help text.
 
 for the full help text.