xref: /freebsd/sys/contrib/openzfs/man/man8/zstreamdump.8 (revision 77013d11e6483b970af25e13c9b892075742f7e5)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or http://www.opensolaris.org/os/licensing.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
21.\" Copyright (c) 2020 by Delphix. All rights reserved.
22.\"
23.Dd May 8, 2021
24.Dt ZSTREAM 8
25.Os
26.
27.Sh NAME
28.Nm zstream
29.Nd manipulate ZFS send streams
30.Sh SYNOPSIS
31.Nm
32.Cm dump
33.Op Fl Cvd
34.Op Ar file
35.Nm
36.Cm redup
37.Op Fl v
38.Ar file
39.Nm
40.Cm token
41.Ar resume_token
42.
43.Sh DESCRIPTION
44The
45.Sy zstream
46utility manipulates ZFS send streams output by the
47.Sy zfs send
48command.
49.Bl -tag -width ""
50.It Xo
51.Nm
52.Cm dump
53.Op Fl Cvd
54.Op Ar file
55.Xc
56Print information about the specified send stream, including headers and
57record counts.
58The send stream may either be in the specified
59.Ar file ,
60or provided on standard input.
61.Bl -tag -width "-D"
62.It Fl C
63Suppress the validation of checksums.
64.It Fl v
65Verbose.
66Print metadata for each record.
67.It Fl d
68Dump data contained in each record.
69Implies verbose.
70.El
71.Pp
72The
73.Nm zstreamdump
74alias is provided for compatibility and is equivalent to running
75.Nm
76.Cm dump .
77.It Xo
78.Nm
79.Cm token
80.Ar resume_token
81.Xc
82Dumps zfs resume token information
83.It Xo
84.Nm
85.Cm redup
86.Op Fl v
87.Ar file
88.Xc
89Deduplicated send streams can be generated by using the
90.Nm zfs Cm send Fl D
91command.
92The ability to send deduplicated send streams is deprecated.
93In the future, the ability to receive a deduplicated send stream with
94.Nm zfs Cm receive
95will be removed.
96However, deduplicated send streams can still be received by utilizing
97.Nm zstream Cm redup .
98.Pp
99The
100.Nm zstream Cm redup
101command is provided a
102.Ar file
103containing a deduplicated send stream, and outputs an equivalent
104non-deduplicated send stream on standard output.
105Therefore, a deduplicated send stream can be received by running:
106.Dl # Nm zstream Cm redup Pa DEDUP_STREAM_FILE | Nm zfs Cm receive No …
107.Bl -tag -width "-D"
108.It Fl v
109Verbose.
110Print summary of converted records.
111.El
112.El
113.
114.Sh SEE ALSO
115.Xr zfs 8 ,
116.Xr zfs-receive 8 ,
117.Xr zfs-send 8
118