Skip to content

Commit

Permalink
Update raw send documentation
Browse files Browse the repository at this point in the history
This patch simply clarifies some of the limitations related to
raw sends in the man page. No functional changes.

Fixes: openzfs#8503

Signed-off-by: Tom Caputi <[email protected]>
  • Loading branch information
Tom Caputi committed Mar 28, 2019
1 parent c048dda commit 1e3668d
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions man/man8/zfs.8
Original file line number Diff line number Diff line change
Expand Up @@ -3500,7 +3500,10 @@ set when the stream is received.
If the
.Fl F
flag is specified when this stream is received, snapshots and file systems that
do not exist on the sending side are destroyed.
do not exist on the sending side are destroyed. If this flag is used to send
encrypted datasets, this flag requires that
.Fl w
is also used.
.It Fl e, -embed
Generate a more compact stream by using
.Sy WRITE_EMBEDDED
Expand Down Expand Up @@ -3573,7 +3576,7 @@ system for incrementals.
Generate a stream package that includes any snapshot holds (created with the
.Sy zfs hold
command), and indicating to
.Sy zfs receive
.Sy zfs receive
that the holds be applied to the dataset on the receiving system.
.It Fl i Ar snapshot
Generate an incremental stream from the first
Expand Down Expand Up @@ -3843,7 +3846,13 @@ recompressed by the receive process. Unencrypted streams can be received as
encrypted datasets, either through inheritance or by specifying encryption
parameters with the
.Fl o
options.
options. Note that the
.Sy keylocation
property cannot be overridden to
.Sy prompt
during a receive. This is because the receive process itself is already using
stdin for the send stream. Instead, the property can be overridden after the
receive completes.
.Pp
The added security provided by raw sends adds some restrictions to the send
and receive process. ZFS will not allow a mix of raw receives and non-raw
Expand Down Expand Up @@ -3930,7 +3939,7 @@ snapshot as described in the paragraph above.
Discard all but the last element of the sent snapshot's file system name, using
that element to determine the name of the target file system for the new
snapshot as described in the paragraph above.
.It Fl h
.It Fl h
Skip the receive of holds. There is no effect if holds are not sent.
.It Fl n
Do not actually receive the stream.
Expand Down

0 comments on commit 1e3668d

Please sign in to comment.