update documentation for .5

git-svn-id: file:///home/lennart/svn/public/syrep/trunk@60 07ea20a6-d2c5-0310-9e02-9ef735347d72

6 files changed, 58 insertions, 19 deletions

diff --git a/configure.ac b/configure.ac
index cb69d1a..40b3a6e 100644
--- a/configure.ac
+++ b/configure.ac
@@ -20,7 +20,7 @@
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 
 AC_PREREQ(2.59)
-AC_INIT([syrep],[0.4],[mzflerc (at) 0pointer (dot) de])
+AC_INIT([syrep],[0.5],[mzflerc (at) 0pointer (dot) de])
 AC_CONFIG_SRCDIR([src/syrep.c])
 AC_CONFIG_HEADERS([config.h])
 AM_INIT_AUTOMAKE([foreign -Wall])
@@ -33,7 +33,7 @@ AC_SUBST(PACKAGE_URL, [http://0pointer.de/lennart/projects/syrep/])
 
 # If using GCC specifiy some additional parameters
 if test "x$GCC" = "xyes" ; then
-   CFLAGS="$CFLAGS -pipe -Wall"
+   CFLAGS="$CFLAGS -pipe -Wall -W"
 fi
 
 if type -p stow > /dev/null && test -d /usr/local/stow ; then
diff --git a/doc/README.html.in b/doc/README.html.in
index 4fb8eaa..e37dd97 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -42,6 +42,13 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
 
 <h2><a name="news">News</a></h2>
 
+<div class="news-date">Mon Jul 19 2004: </div> <p class="news-text"><a
+href="@PACKAGE_URL@syrep-0.5.tar.gz">Version 0.5</a> released; Changes
+include: optionally show sizes of file on <tt>--diff</tt>, implement
+new command <tt>--forget</tt>, check for extended attribute
+<tt>user.syrep</tt> on <tt>--update</tt> on file systems that support
+it.</p>
+
 <div class="news-date">Mon Mar 22 2004: </div> <p class="news-text"><a
 href="@PACKAGE_URL@syrep-0.4.tar.gz">Version 0.4</a> released; Changes
 include: fix annonoying SIGBUS failure when working on files &gt;= 100 MB, update to Berkeley DB 4.2, use <tt>madvise()</tt> to improve file copying throughput on newer kernels, minor other fixes </p>
@@ -194,7 +201,11 @@ a "symmetric" way as described above.</p>
 
 <h2><a name="requirements">Requirements</a></h2>
 
-<p><tt>syrep</tt> requires installed development versions of <tt><a href="http://www.gzip.org/zlib/">zlib</a></tt> and <tt><a href="http://www.sleepycat.com/">Berkeley DB</a></tt> 4.2.</p>
+<p><tt>syrep</tt> requires installed development versions of <tt><a
+href="http://www.gzip.org/zlib/">zlib</a></tt> and <tt><a
+href="http://www.sleepycat.com/">Berkeley DB</a></tt> 4.2. If you want
+build <tt>syrep</tT> with support for extended attributes (currently
+supported on Linux only) you have to install <tt>libattr</tt> and a kernel that supports it.</p>
 
 <p><tt>syrep</tt> was developed and tested on Debian GNU/Linux
 "testing" from September 2003, it should work on most other Linux
@@ -227,11 +238,11 @@ L. Peter Deutsch. Thanks to him for this.</p>
 
 <p>The current release is <a href="@PACKAGE_URL@syrep-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
 
-<p>Get <tt>syrep</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/syrep/">repository</a>.</p>
+<p>Get <tt>syrep</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/syrep/">repository</a>. (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=syrep">viewcvs</a>)</p>
 
 <hr/>
 
-<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, March 2004</address>
+<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, July 2004</address>
 
 <div class="grey"><i>$Id$</i></div>
 
diff --git a/man/syrep.1.xml.in b/man/syrep.1.xml.in
index ce946b7..76d2d2d 100644
--- a/man/syrep.1.xml.in
+++ b/man/syrep.1.xml.in
@@ -1,4 +1,4 @@
-<?xml version="1.0"?> <!-- -*-xae-*- -->
+<?xml version="1.0"?> <!-- -*-nxml-*- -->
 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> 
 
@@ -37,6 +37,7 @@
     <cmd>syrep [<opt>options...</opt>] <opt>--makepatch</opt> <arg>DIRECTORY</arg> <arg>SNAPSHOT</arg></cmd>
     <cmd>syrep [<opt>options...</opt>] <opt>--extract</opt> <arg>SNAPSHOT</arg> ...</cmd>
     <cmd>syrep [<opt>options...</opt>] <opt>--cleanup</opt> <arg>DIRECTORY</arg> ...</cmd>
+    <cmd>syrep [<opt>options...</opt>] <opt>--forget</opt> <arg>SNAPSHOT</arg> ...</cmd>
   </synopsis>
   
   <description> 
@@ -70,6 +71,13 @@
     <opt>--diff</opt>) or creating patches between them (command
     <opt>--make-patch</opt>).</p>
 
+    <p>Syrep will ignore all files and directories that have the
+    extended attribute <opt>user.syrep</opt> set to
+    <opt>omit</opt>. Currently, this works on Linux only. Keep in
+    mind, that only newer kernel versions and some file system support
+    extended attributes. See <manref name="attr" section="5"/> for
+    more information.</p>
+
   </description>
   
   <section name="General options">
@@ -200,6 +208,14 @@
      <p><opt>--diff</opt> (command)</p>
      <optdesc>Show difference between two repositories or snapshots</optdesc>
     </option>
+    <option>
+     <p><opt>-s</opt> | <opt>--sizes</opt> (option)</p>
+     <optdesc>Show the sizes of the files to copy. This works only when acting on a local repository and for the local files.</optdesc>
+    </option>
+    <option>
+     <p><opt>-H</opt> | <opt>--human-readable</opt> (option)</p>
+     <optdesc>Only useful when using with <opt>-s</opt>. When enabled shows file sizes in human readable form, i.e. "3.5 MB" instead of "3670016".</optdesc>
+    </option>
    </section>
 
    <section name="Merging a snapshot, a patch or a repository into a repository">
@@ -272,6 +288,18 @@
     </option>
   </section>
 
+  <section name="Forgetting outdated snapshot information">
+    <option>
+    <p><opt>--forget</opt> (command)</p>
+    <optdesc>Repackage the snapshot file dropping outdated information. Use this if your snapshot files get too large.</optdesc>
+    </option>
+    <option>
+      <p><opt>-R</opt> <arg>DAYS</arg> | <opt>--remember=</opt><arg>DAYS</arg> (option)</p>
+      <optdesc>Information about how many days in the past should be kept? This defaults to 180 (half a year).</optdesc>
+    </option>
+  </section>
+
+
   <section name="Repositories, Snapshots and Patches">
 
     <p>A syrep file repository is a POSIX file hierarchy with some
@@ -343,7 +371,7 @@
   </section>
   
   <section name="See also">
-    <p><manref name="rsync" section="1"/>, <manref name="cron" section="8"/></p>
+    <p><manref name="rsync" section="1"/>, <manref name="cron" section="8"/>, <manref name="attr" section="5"/></p>
   </section>
 
   <section name="Comments">
diff --git a/man/xmltoman.css b/man/xmltoman.css
index 0892e4f..37dd55f 100644
--- a/man/xmltoman.css
+++ b/man/xmltoman.css
@@ -1,20 +1,20 @@
 /* $Id$ */
 
 /***
-  This file is part of ifplugd.
+  This file is part of syrep.
 
-  ifplugd is free software; you can redistribute it and/or modify it under
+  syrep is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2 of the License, or (at your
   option) any later version.
 
-  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  syrep is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
   for more details.
 
   You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
+  along with syrep; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 ***/
 
diff --git a/man/xmltoman.dtd b/man/xmltoman.dtd
index 39cfa28..1abe626 100644
--- a/man/xmltoman.dtd
+++ b/man/xmltoman.dtd
@@ -1,20 +1,20 @@
 <!-- $Id$ -->
 
 <!-- 
-  This file is part of ifplugd.
+  This file is part of syrep.
 
-  ifplugd is free software; you can redistribute it and/or modify it under
+  syrep is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2 of the License, or (at your
   option) any later version.
 
-  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  syrep is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
   for more details.
 
   You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
+  along with syrep; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 -->
 
diff --git a/man/xmltoman.xsl b/man/xmltoman.xsl
index 2048708..df872a2 100644
--- a/man/xmltoman.xsl
+++ b/man/xmltoman.xsl
@@ -2,20 +2,20 @@
 <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml">
 
 <!-- 
-  This file is part of ifplugd.
+  This file is part of syrep.
 
-  ifplugd is free software; you can redistribute it and/or modify it under
+  syrep is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2 of the License, or (at your
   option) any later version.
 
-  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  syrep is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
   for more details.
 
   You should have received a copy of the GNU General Public License
-  along with ifplugd; if not, write to the Free Software Foundation,
+  along with syrep; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
 -->