| .\" |
| .\" CDDL HEADER START |
| .\" |
| .\" The contents of this file are subject to the terms of the |
| .\" Common Development and Distribution License (the "License"). |
| .\" You may not use this file except in compliance with the License. |
| .\" |
| .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
| .\" or http://www.opensolaris.org/os/licensing. |
| .\" See the License for the specific language governing permissions |
| .\" and limitations under the License. |
| .\" |
| .\" When distributing Covered Code, include this CDDL HEADER in each |
| .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
| .\" If applicable, add the following below this CDDL HEADER, with the |
| .\" fields enclosed by brackets "[]" replaced with your own identifying |
| .\" information: Portions Copyright [yyyy] [name of copyright owner] |
| .\" |
| .\" CDDL HEADER END |
| .\" |
| .\" Copyright (c) 2020 by Delphix. All rights reserved. |
| .\" |
| .Dd May 8, 2021 |
| .Dt ZSTREAM 8 |
| .Os |
| . |
| .Sh NAME |
| .Nm zstream |
| .Nd manipulate ZFS send streams |
| .Sh SYNOPSIS |
| .Nm |
| .Cm dump |
| .Op Fl Cvd |
| .Op Ar file |
| .Nm |
| .Cm redup |
| .Op Fl v |
| .Ar file |
| .Nm |
| .Cm token |
| .Ar resume_token |
| . |
| .Sh DESCRIPTION |
| The |
| .Sy zstream |
| utility manipulates ZFS send streams output by the |
| .Sy zfs send |
| command. |
| .Bl -tag -width "" |
| .It Xo |
| .Nm |
| .Cm dump |
| .Op Fl Cvd |
| .Op Ar file |
| .Xc |
| Print information about the specified send stream, including headers and |
| record counts. |
| The send stream may either be in the specified |
| .Ar file , |
| or provided on standard input. |
| .Bl -tag -width "-D" |
| .It Fl C |
| Suppress the validation of checksums. |
| .It Fl v |
| Verbose. |
| Print metadata for each record. |
| .It Fl d |
| Dump data contained in each record. |
| Implies verbose. |
| .El |
| .Pp |
| The |
| .Nm zstreamdump |
| alias is provided for compatibility and is equivalent to running |
| .Nm |
| .Cm dump . |
| .It Xo |
| .Nm |
| .Cm token |
| .Ar resume_token |
| .Xc |
| Dumps zfs resume token information |
| .It Xo |
| .Nm |
| .Cm redup |
| .Op Fl v |
| .Ar file |
| .Xc |
| Deduplicated send streams can be generated by using the |
| .Nm zfs Cm send Fl D |
| command. |
| The ability to send deduplicated send streams is deprecated. |
| In the future, the ability to receive a deduplicated send stream with |
| .Nm zfs Cm receive |
| will be removed. |
| However, deduplicated send streams can still be received by utilizing |
| .Nm zstream Cm redup . |
| .Pp |
| The |
| .Nm zstream Cm redup |
| command is provided a |
| .Ar file |
| containing a deduplicated send stream, and outputs an equivalent |
| non-deduplicated send stream on standard output. |
| Therefore, a deduplicated send stream can be received by running: |
| .Dl # Nm zstream Cm redup Pa DEDUP_STREAM_FILE | Nm zfs Cm receive No … |
| .Bl -tag -width "-D" |
| .It Fl v |
| Verbose. |
| Print summary of converted records. |
| .El |
| .El |
| . |
| .Sh SEE ALSO |
| .Xr zfs 8 , |
| .Xr zfs-receive 8 , |
| .Xr zfs-send 8 |