Update 'zfs send' documentation

The -D and -p options were missing from the manpage.  This commit
adds documentation for these features.

Closes #311

diff --git a/cmd/zfs/zfs_main.c b/cmd/zfs/zfs_main.c
index 0953336abec7271f4ddcfb83ec1a821963fb1a40..b6dc6d49d3b7c47a0fa76f700dae812071e196b8 100644 (file)
--- a/cmd/zfs/zfs_main.c
+++ b/cmd/zfs/zfs_main.c
@@ -238,7 +238,7 @@ get_usage(zfs_help_t idx)
        case HELP_ROLLBACK:
                return (gettext("\trollback [-rRf] <snapshot>\n"));
        case HELP_SEND:
-               return (gettext("\tsend [-RDp] [-[iI] snapshot] <snapshot>\n"));
+               return (gettext("\tsend [-vRDp] [-[iI] snapshot] <snapshot>\n"));
        case HELP_SET:
                return (gettext("\tset <property=value> "
                    "<filesystem|volume|snapshot> ...\n"));

diff --git a/man/man8/zfs.8 b/man/man8/zfs.8
index 1f2db5a6a1ce462dd5ab021381f48c97853660c7..3da2e44a7af927f6ebad0655acbb10c52ae58530 100644 (file)
--- a/man/man8/zfs.8
+++ b/man/man8/zfs.8
@@ -143,7 +143,7 @@ zfs \- configures ZFS file systems
 
 .LP
 .nf
-\fBzfs\fR \fBsend\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
+\fBzfs\fR \fBsend\fR [\fB-vRDp\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR
 .fi
 
 .LP
@@ -2096,7 +2096,7 @@ Unshare the specified filesystem. The command can also be given a path to a \fBZ
 .ne 2
 .mk
 .na
-\fB\fBzfs send\fR [\fB-vR\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
+\fB\fBzfs send\fR [\fB-vRDp\fR] [\fB-\fR[\fBiI\fR] \fIsnapshot\fR] \fIsnapshot\fR\fR
 .ad
 .sp .6
 .RS 4n
@@ -2125,6 +2125,17 @@ If the destination is a clone, the source may be the origin snapshot, which must
 Generate a stream package that sends all intermediary snapshots from the first snapshot to the second snapshot. For example, \fB-I @a fs@d\fR is similar to \fB-i @a fs@b; -i @b fs@c; -i @c fs@d\fR. The incremental source snapshot may be specified as with the \fB-i\fR option.
 .RE
 
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-v\fR\fR
+.ad
+.sp .6
+.RS 4n
+Print verbose information about the stream package generated.
+.RE
+
 .sp
 .ne 2
 .mk
@@ -2142,11 +2153,24 @@ If the \fB-i\fR or \fB-I\fR flags are used in conjunction with the \fB-R\fR flag
 .ne 2
 .mk
 .na
-\fB\fB-v\fR\fR
+\fB\fB-D\fR\fR
 .ad
 .sp .6
 .RS 4n
-Print verbose information about the stream package generated.
+This option will cause dedup processing to be performed on the data being written to a send stream.  Dedup processing is optional because it isn't always appropriate (some kinds of data have very little duplication) and it has significant costs:  the checksumming required to detect duplicate blocks is CPU-intensive and the data that must be maintained while the stream is being processed can occupy a very large amount of memory.
+.sp
+Duplicate blocks are detected by calculating a cryptographically strong checksum on each data block.  Blocks that have the same checksum are presumed to be identical.  The checksum type used at this time is SHA256.  However, the stream format contains a field which identifies the checksum type, permitting other checksums to be used in the future.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fB-p\fR\fR
+.ad
+.sp .6
+.RS 4n
+Include properties in the send stream without the -R option.
 .RE
 
 The format of the stream is committed. You will be able to receive your streams on future versions of \fBZFS\fR.