]> git.proxmox.com Git - mirror_zfs.git/commitdiff
man: zfs-send.8, zfs-receive.8: import examples from zfs.8
authorнаб <nabijaczleweli@nabijaczleweli.xyz>
Wed, 16 Mar 2022 17:31:42 +0000 (18:31 +0100)
committerBrian Behlendorf <behlendorf1@llnl.gov>
Mon, 28 Mar 2022 17:13:14 +0000 (10:13 -0700)
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes #13228

man/man8/zfs-receive.8
man/man8/zfs-send.8
man/man8/zfs.8

index fc1e943bd61b335b5aeb5f2f6593cd985827ab1c..8d99c7ee58dccbd5ff65efb0be7420c76778576b 100644 (file)
@@ -29,7 +29,7 @@
 .\" Copyright 2018 Nexenta Systems, Inc.
 .\" Copyright 2019 Joyent, Inc.
 .\"
-.Dd February 16, 2020
+.Dd March 16, 2022
 .Dt ZFS-RECEIVE 8
 .Os
 .
@@ -395,6 +395,48 @@ Abort an interrupted
 deleting its saved partially received state.
 .El
 .
+.Sh EXAMPLES
+.\" These are, respectively, examples 12, 13 from zfs.8
+.\" Make sure to update them bidirectionally
+.Ss Example 1 : No Remotely Replicating ZFS Data
+The following commands send a full stream and then an incremental stream to a
+remote machine, restoring them into
+.Em poolB/received/fs@a
+and
+.Em poolB/received/fs@b ,
+respectively.
+.Em poolB
+must contain the file system
+.Em poolB/received ,
+and must not initially contain
+.Em poolB/received/fs .
+.Bd -literal -compact -offset Ds
+.No # Nm zfs Cm send Ar pool/fs@a |
+.No "   " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs Ns @ Ns Ar a
+.No # Nm zfs Cm send Fl i Ar a pool/fs@b |
+.No "   " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs
+.Ed
+.
+.Ss Example 2 : No Using the Nm zfs Cm receive Fl d No Option
+The following command sends a full stream of
+.Ar poolA/fsA/fsB@snap
+to a remote machine, receiving it into
+.Ar poolB/received/fsA/fsB@snap .
+The
+.Ar fsA/fsB@snap
+portion of the received snapshot's name is determined from the name of the sent
+snapshot.
+.Ar poolB
+must contain the file system
+.Ar poolB/received .
+If
+.Ar poolB/received/fsA
+does not exist, it is created as an empty file system.
+.Bd -literal -compact -offset Ds
+.No # Nm zfs Cm send Ar poolA/fsA/fsB@snap |
+.No "   " Nm ssh Ar host Nm zfs Cm receive Fl d Ar poolB/received
+.Ed
+.
 .Sh SEE ALSO
 .Xr zfs-send 8 ,
 .Xr zstream 8
index 397db5063cda88f0187e5682a94255881de03c3b..67e94ca85bc70eabeb2dfc12d55bfcc1665f7bab 100644 (file)
@@ -29,7 +29,7 @@
 .\" Copyright 2018 Nexenta Systems, Inc.
 .\" Copyright 2019 Joyent, Inc.
 .\"
-.Dd April 15, 2021
+.Dd March 16, 2022
 .Dt ZFS-SEND 8
 .Os
 .
@@ -667,6 +667,48 @@ ones on the source, and are ready to be used, while the parent snapshot on the
 target contains none of the username and password data present on the source,
 because it was removed by the redacted send operation.
 .
+.Sh EXAMPLES
+.\" These are, respectively, examples 12, 13 from zfs.8
+.\" Make sure to update them bidirectionally
+.Ss Example 1 : No Remotely Replicating ZFS Data
+The following commands send a full stream and then an incremental stream to a
+remote machine, restoring them into
+.Em poolB/received/fs@a
+and
+.Em poolB/received/fs@b ,
+respectively.
+.Em poolB
+must contain the file system
+.Em poolB/received ,
+and must not initially contain
+.Em poolB/received/fs .
+.Bd -literal -compact -offset Ds
+.No # Nm zfs Cm send Ar pool/fs@a |
+.No "   " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs Ns @ Ns Ar a
+.No # Nm zfs Cm send Fl i Ar a pool/fs@b |
+.No "   " Nm ssh Ar host Nm zfs Cm receive Ar poolB/received/fs
+.Ed
+.
+.Ss Example 2 : No Using the Nm zfs Cm receive Fl d No Option
+The following command sends a full stream of
+.Ar poolA/fsA/fsB@snap
+to a remote machine, receiving it into
+.Ar poolB/received/fsA/fsB@snap .
+The
+.Ar fsA/fsB@snap
+portion of the received snapshot's name is determined from the name of the sent
+snapshot.
+.Ar poolB
+must contain the file system
+.Ar poolB/received .
+If
+.Ar poolB/received/fsA
+does not exist, it is created as an empty file system.
+.Bd -literal -compact -offset Ds
+.No # Nm zfs Cm send Ar poolA/fsA/fsB@snap |
+.No "   " Nm ssh Ar host Nm zfs Cm receive Fl d Ar poolB/received
+.Ed
+.
 .Sh SEE ALSO
 .Xr zfs-bookmark 8 ,
 .Xr zfs-receive 8 ,
index 635f21f59ad911cd93acdb3980b5b19dbbc6da0c..ae31d39481e64673f49fc230d86cdc6585160505 100644 (file)
@@ -299,11 +299,13 @@ if an error occurs, and
 if invalid command line options were specified.
 .
 .Sh EXAMPLES
-.\" Examples 17, 18, 19, 20, 21 are shared with zfs-allow.8.
 .\" Examples 1, 4, 6, 14, 16 are shared with zfs-set.8.
+.\" Examples 12, 13 are shared with zfs-send.8.
+.\" Examples 12, 13 are also shared with zfs-receive.8.
+.\" Examples 17, 18, 19, 20, 21 are shared with zfs-allow.8.
 .\" Examples 22 are shared with zfs-diff.8.
 .\" Examples 23 are shared with zfs-bookmark.8.
-.\" Make sure to update them bidirectionally
+.\" Make sure to update them omnidirectionally
 .Ss Example 1 : No Creating a ZFS File System Hierarchy
 The following commands create a file system named
 .Ar pool/home