Release 1.1.2.
[rsync-backup] / fshash.1
index 2ceb175..8577d65 100644 (file)
--- a/fshash.1
+++ b/fshash.1
@@ -12,6 +12,8 @@
 .IR cache ]
 .RB [ \-f
 .IR format ]
+.RB [ \-C
+.IR version ]
 .RB [ \-H
 .IR hash ]
 .RI [ file
@@ -95,13 +97,27 @@ format doesn't work well: see
 .B BUGS
 below.)
 .TP
+.B \-C, \-\-compat=\fIversion
+Produce a manifest with the given compatibility
+.IR version .
+Alas,
+.B fshash
+has bugs in the way it produces manifests.  Fixing the bugs makes the
+output better, but now it can't be compared with old manifests which
+were made with the bugs.  By default,
+.B fshash
+produces manifests in the most recent format, but this option will force
+it to be compatible with old versions.  The original version was 1; all
+later versions print a comment reporting the version number at the start
+of the manifest.  The current version is 2.
+.TP
 .B \-H, \-\-hash=\fIhash
 Use the
 .I hash
 function, which can be any hash function supported by Python's
 .BR hashlib .
-If this option may be omitted then the hash is read from the cache file;
-if there is no cache file either, then an error is reported.
+This option may be omitted: if it is, then the hash is read from the
+cache file; if there is no cache file either, then an error is reported.
 .TP
 .B \-u, \-\-udiff
 Rather than produce a manifest, read a unified
@@ -192,7 +208,7 @@ The information field shows
 .BR symbolic-link .
 The name is followed by
 .RB ` \~\->\~ '
-and the link target (or by
+and the link target (or
 .BI <E nn \~ message >
 if there was an error reading the link destination).
 .TP