summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2003-11-30 14:27:42 +0000
committerLennart Poettering <lennart@poettering.net>2003-11-30 14:27:42 +0000
commitb6abf79d60722dbee89e6270435d0b11c0dffa91 (patch)
treed40783bd9c86b989e9f2ddb4a0dc63f9592d74f0 /man
parentc0d1779760fd10d14344fa1ed70b91bdf50272c1 (diff)
relase 0.3
--copy-always --sort bi-directory merges --check-md git-svn-id: file:///home/lennart/svn/public/syrep/trunk@43 07ea20a6-d2c5-0310-9e02-9ef735347d72
Diffstat (limited to 'man')
-rw-r--r--man/syrep.1.xml.in47
-rw-r--r--man/xmltoman.css (renamed from man/man.css)8
-rw-r--r--man/xmltoman.dtd39
-rw-r--r--man/xmltoman.xsl (renamed from man/man.xsl)10
4 files changed, 87 insertions, 17 deletions
diff --git a/man/syrep.1.xml.in b/man/syrep.1.xml.in
index 2b6e502..ce946b7 100644
--- a/man/syrep.1.xml.in
+++ b/man/syrep.1.xml.in
@@ -1,6 +1,6 @@
<?xml version="1.0"?> <!-- -*-xae-*- -->
-<!DOCTYPE manpage SYSTEM "man.dtd">
-<?xml-stylesheet type="text/xsl" href="man.xsl" ?>
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
<!-- $Id$ -->
@@ -32,9 +32,11 @@
<cmd>syrep [<opt>options...</opt>] <opt>--update</opt> <arg>DIRECTORY</arg> ...</cmd>
<cmd>syrep [<opt>options...</opt>] <opt>--diff</opt> <arg>SNAPSHOT</arg> <arg>SNAPSHOT</arg></cmd>
<cmd>syrep [<opt>options...</opt>] <opt>--merge</opt> <arg>SNAPSHOT</arg> <arg>DIRECTORY</arg></cmd>
+ <cmd>syrep [<opt>options...</opt>] <opt>--merge</opt> <arg>PATCH</arg> <arg>DIRECTORY</arg></cmd>
+ <cmd>syrep [<opt>options...</opt>] <opt>--merge</opt> <arg>DIRECTORY</arg> <arg>DIRECTORY</arg></cmd>
<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>SNAPSHOT</arg> ...</cmd>
+ <cmd>syrep [<opt>options...</opt>] <opt>--cleanup</opt> <arg>DIRECTORY</arg> ...</cmd>
</synopsis>
<description>
@@ -55,7 +57,18 @@
<p>Syrep is able to cope with 64 bit file sizes. (LFS)</p>
- <p>Syrep is optimized for speed. It may make use of a message digest cache to accelerate the calculation of digests of a whole directory hierarchy.</p>
+ <p>Syrep is optimized for speed. It may make use of a message
+ digest cache to accelerate the calculation of digests of a whole
+ directory hierarchy.</p>
+
+ <p>A syrep repository is a normal UNIX directory tree containing a
+ special directory <file>.syrep</file> with a file
+ <file>current.syrep</file> (called snapshot) which holds file
+ system history data. A directory is turned into a syrep repository
+ by running <opt>--update</opt> on it. Snapshots are used to
+ perform basic tasks like comparing repositories (command
+ <opt>--diff</opt>) or creating patches between them (command
+ <opt>--make-patch</opt>).</p>
</description>
@@ -121,7 +134,7 @@
<option>
<p><opt>--show-by-md</opt> (option)</p>
- <optdesc>Show files by message digests</optdesc>
+ <optdesc>Show files by message digests. This option collides with <opt>--sort</opt>.</optdesc>
</option>
<option>
@@ -129,6 +142,11 @@
<optdesc>Show first and last seen times</optdesc>
</option>
+ <option>
+ <p><opt>--sort</opt> (option)</p>
+ <optdesc>Sort file listing chronologically. This option collides with <opt>--show-by-md</opt>.</optdesc>
+ </option>
+
</section>
<section name="Showing snapshot information">
@@ -184,23 +202,36 @@
</option>
</section>
- <section name="Merging a snapshot into a directory">
+ <section name="Merging a snapshot, a patch or a repository into a repository">
<option>
<p><opt>--merge</opt> (command)</p>
- <optdesc>Merge a snapshot or a patch into a repository. Afterwards, you should run <opt>--update</opt> on the repository to update the snapshot.</optdesc>
+ <optdesc>Merge a snapshot, a patch or a repository into a repository. Afterwards, you should run <opt>--update</opt> on the repository to update the snapshot.</optdesc>
</option>
<option>
<p><opt>-q</opt> | <opt>--question</opt> (option)</p>
<optdesc>Ask a question before each action</optdesc>
</option>
<option>
- <p><opt>--prune-empty</opt> (option)</p>
+ <p><opt>-P</opt> | <opt>--prune-empty</opt> (option)</p>
<optdesc>Prune empty directories</optdesc>
</option>
<option>
<p><opt>--keep-trash</opt> (option)</p>
<optdesc>Don't empty trash. Deleted files are copied into a trash folder inside the repository directory. If this option is specified this trash is not emptied when the operation is completed.</optdesc>
</option>
+ <option>
+ <p><opt>--check-md</opt> (option)</p>
+ <optdesc>Check message digests of files before deleting or replacing them. NB: This worsens syrep's performance and is thus not enabled by default.</optdesc>
+ </option>
+ <option>
+ <p><opt>--always-copy</opt> (option)</p>
+ <optdesc>As default syrep tries to hard link files instead of
+ copying them. With this option syrep will always do a copy,
+ regardless if a hard link is possible or not. This is especially
+ useful when doing bi-directory merges. NB: This worsens syrep's performance and is thus not enabled by default.
+ </optdesc>
+ </option>
+
</section>
<section name="Making a patch for a snapshot against a directory">
diff --git a/man/man.css b/man/xmltoman.css
index 37dd55f..0892e4f 100644
--- a/man/man.css
+++ b/man/xmltoman.css
@@ -1,20 +1,20 @@
/* $Id$ */
/***
- This file is part of syrep.
+ This file is part of ifplugd.
- syrep is free software; you can redistribute it and/or modify it under
+ ifplugd 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.
- syrep is distributed in the hope that it will be useful, but WITHOUT
+ ifplugd 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 syrep; if not, write to the Free Software Foundation,
+ along with ifplugd; 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
new file mode 100644
index 0000000..39cfa28
--- /dev/null
+++ b/man/xmltoman.dtd
@@ -0,0 +1,39 @@
+<!-- $Id$ -->
+
+<!--
+ This file is part of ifplugd.
+
+ ifplugd 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
+ 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,
+ Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+-->
+
+<!ELEMENT manpage (synopsis | description | section | options | seealso)*>
+<!ATTLIST manpage name CDATA #REQUIRED section CDATA #REQUIRED desc CDATA #IMPLIED>
+<!ELEMENT arg (#PCDATA)>
+<!ELEMENT p (#PCDATA | arg | url | manref | opt | file )*>
+<!ELEMENT synopsis (cmd | p)+>
+<!ELEMENT description (p)+>
+<!ELEMENT section (p | option)*>
+<!ATTLIST section name CDATA #REQUIRED>
+<!ELEMENT option (#PCDATA | p | optdesc)*>
+<!ELEMENT optdesc (#PCDATA | p )*>
+<!ELEMENT cmd (#PCDATA | arg)*>
+<!ELEMENT options (p | option)*>
+<!ELEMENT seealso (p)*>
+<!ELEMENT opt (#PCDATA)>
+<!ELEMENT file (#PCDATA)>
+<!ELEMENT manref EMPTY>
+<!ATTLIST manref name CDATA #REQUIRED section CDATA #REQUIRED href CDATA #IMPLIED>
+<!ELEMENT url EMPTY>
+<!ATTLIST url href CDATA #REQUIRED>
diff --git a/man/man.xsl b/man/xmltoman.xsl
index 7946a76..2048708 100644
--- a/man/man.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 xmltoman.
+ This file is part of ifplugd.
- xmltoman is free software; you can redistribute it and/or modify it under
+ ifplugd 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.
- xmltoman is distributed in the hope that it will be useful, but WITHOUT
+ ifplugd 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 xmltoman; if not, write to the Free Software Foundation,
+ along with ifplugd; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
-->
@@ -29,7 +29,7 @@
<title>
<xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)
</title>
- <link rel="stylesheet" type="text/css" href="man.css"/>
+ <link rel="stylesheet" type="text/css" href="xmltoman.css"/>
</head>
<body>
<h1>Name</h1>