+++ /dev/null
-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 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
-
- make install PREFIX=/somewhere/else
-
-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:
----------
-
-Suppose you'd like to create snapshots of the existing directory
-
- /foo/bar
-
-in the directory
-
- /baz/qux.
-
-Create the config file
-
- ~/.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
-
-Then execute the commands
-
- mkdir /baz/qux
- dss run
-
-In order to print the list of all snapshots created so far, use
-
- 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/
-
-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
-
-for an overview of all supported command line options or
-
- dss --detailed-help
-
-for the full help text.
index.html.in: index.html.m4
$(call SAY, M4 $<)
$(M4) $< > $@
-index.html: index.html.in INSTALL NEWS
+index.html: index.html.in NEWS
$(call SAY, MD $@)
sed -e '/@README@/,$$d' index.html.in > $@
printf '<p> %s </p>\n' "$(DESCRIPTION1)" >> $@
printf '<p> %s </p>\n' "$(DESCRIPTION3)" >> $@
sed -e '1,/@README@/d' -e '/@NEWS@/,$$d' index.html.in >> $@
markdown NEWS >> $@
- sed -e '1,/@NEWS@/d' -e '/@INSTALL@/,$$d' index.html.in >> $@
- markdown INSTALL >> $@
- sed -e '1,/@INSTALL@/d' -e '/@MAN_PAGE@/,$$d' index.html.in >> $@
-include Makefile.local
detected and terminates with exit code 1.
[/description]
+[section examples]
+
+ Suppose you'd like to create snapshots of the existing directory
+ .I /foo/bar
+ in the directory
+ .IR /baz/qux .
+ Create the config file
+ .I ~/.dssrc
+ containing
+ the values for the source and the destination directories
+ as follows:
+
+ .RS 6
+ .EX
+ echo 'source-dir "/foo/bar"' > ~/.dssrc
+ echo 'dest-dir "/baz/qux"' >> ~/.dssrc
+ .EE
+ .RE
+
+ Then execute the commands
+
+ .RS 6
+ .EX
+ mkdir /baz/qux
+ dss run
+ .EE
+ .RE
+
+ To print the list of all snapshots created so far, run
+ .IR dss\~ls .
+
+ 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.
+
+ .RS 6
+ .EX
+ 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"
+ .EE
+ .RE
+
+ The
+ .I /etc/dss.exclude
+ file could look like this (see rsync(1) for more examples)
+
+ .RS 6
+ .EX
+ - /proc
+ - /**/tmp/
+ .EE
+ .RE
+[/section]
+
[section copyright]
Written by AUTHOR()
.br
</td>
</tr>
</table>
-
<hr>
-
- [<a href="#news">NEWS</a>]
- [<a href="#install">INSTALL</a>]
- [<a href="#resources">Resources</a>]
-
+ [<a href="`#'installation">Installation</a>]
+ [<a href="`#'resources">Resources</a>]
+ [<a href="`#'news">News</a>]
<hr>
- <center>
- <h2>
- <a name="readme">README</a>
- </h2>
- </center>
-
@README@
- <hr>
+ <h2> <a name="installation">Installation</a> </h2>
- <center>
- <h2>
- <a name="news">NEWS</a>
- </h2>
- </center>
+ <p> To install the dependencies, run <code>apt-get install gcc rsync
+ liblopsub-dev m4</code>. </p>
- @NEWS@
+ <p> To download the source code, run <code>git clone
+ CLONE_URL()</code>, or grab a current tarball from the <a
+ href="GITWEB_URL()">gitweb page</a> and unpack it. </p>
- <hr>
+ <p> To build the PACKAGE() executable and the man page, enter the
+ PACKAGE() source directory and type <code>make</code>. To install
+ both files run <code>sudo make install</code>. </p>
- <center>
- <h2>
- <a name="install">INSTALL</a>
- </h2>
- </center>
+ <p> Try <code>dss -h</code> for an overview of all supported command
+ line options, <code>dss --detailed-help</code> for the long help text,
+ or <code>man dss</code> to see the man page which contains example
+ configurations. </p>
- <p> To download the source code, run <tt> git clone CLONE_URL() </tt>,
- or grab a current tarball from the <a href="GITWEB_URL()">gitweb
- page</a> and unpack it. </p>
-
- @INSTALL@
-
- <hr>
-
- <center> <h2> <a name="resources">Resources</a> </h2> </center>
+ <h2> <a name="resources">Resources</a> </h2>
<ul>
<li> <a href="PACKAGE_HOMEPAGE()">PACKAGE() home page</a> </li>
<li> <code>git clone CLONE_URL()</code> </li>
<li> Contact: <a href="mailto:EMAIL()">AUTHOR() <EMAIL()></a> </li>
<li> License: <a href="LICENSE_URL()">LICENSE()</a> </li>
</ul>
+ <h2> <a name="news">News</a> </h2>
+ @NEWS@
</body> </html>
-
projects / dss.git / commitdiff