summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDonovan Baarda <abo@minkirri.apana.org.au>2006-02-21 12:21:52 +0000
committerDonovan Baarda <abo@minkirri.apana.org.au>2006-02-21 12:21:52 +0000
commita22b0b9534bc1dc4f3399f9922bf2bbf0b9969f8 (patch)
tree080993e6ed585f0bffaefe08276138e2060d0741
parent3013597cba5b67e281f97b34f21cff15d5999ea9 (diff)
downloadlibrsync-a22b0b9534bc1dc4f3399f9922bf2bbf0b9969f8.tar.gz
Got updated rdiff man page from Debian/Ubuntu including tips about
using '--' to end option parsing before using '-' for stdin/stdout.
-rw-r--r--doc/rdiff.19
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/rdiff.1 b/doc/rdiff.1
index 323be54..529016d 100644
--- a/doc/rdiff.1
+++ b/doc/rdiff.1
@@ -29,10 +29,17 @@ rdiff \- compute and apply signature-based file differences
.PP
\fBrdiff\fP [\fIoptions\fP] \fBpatch\fP \fIbasis-file delta-file new-file\fP
.fi
+.SH USAGE
+You can use \fBrdiff\fP to update files, much like \fBrsync\fP does.
+However, unlike \fBrsync\fP, \fBrdiff\fP puts you in control. There
+are three steps to updating a file: \fBsignature\fP, \fBdelta\fP, and
+\fBpatch\fP.
.SH DESCRIPTION
In every case where a filename must be specified, \- may be used
instead to mean either standard input or standard output as
-appropriate.
+appropriate. Be aware that if you do this, you'll need to terminate your
+\fIoptions\fP with \-\- or \fBrdiff\fP will think you are passing it
+an empty option.
.SH "RETURN VALUE"
0 for successful completion, 1 for environmental problems (file not
found, invalid options, IO error, etc), 2 for a corrupt file and 3 for