update documentation for .5

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

4 files changed, 42 insertions, 14 deletions

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. 
 -->