path: root/Documentation
diff options
authorQu Wenruo <>2016-09-07 08:29:34 +0800
committerDavid Sterba <>2016-12-14 15:06:34 +0100
commit798cec84dd1783fcbdfb9c077d8682d8ed8b7b21 (patch)
treea4b98c3218c5c6fc3bfe83616bfd47c61215f37f /Documentation
parent25afadfc720ef5410211c3f4f85c8f4a0858b8d9 (diff)
btrfs-progs: receive: introduce option to dump send stream
Introduce new option, '--dump' for receive subcommand. With this command, user can dump the metadata of a send stream. Which is quite useful for education purpose or bug reporting. Signed-off-by: Qu Wenruo <> Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation')
1 files changed, 14 insertions, 1 deletions
diff --git a/Documentation/btrfs-receive.asciidoc b/Documentation/btrfs-receive.asciidoc
index e246603c..f12e9490 100644
--- a/Documentation/btrfs-receive.asciidoc
+++ b/Documentation/btrfs-receive.asciidoc
@@ -9,12 +9,19 @@ SYNOPSIS
*btrfs receive* [options] <path>
+*btrfs receive* --dump [options]
Receive a stream of changes and replicate one or more subvolumes that were
previously used with *btrfs send* The received subvolumes are stored to
+'path', if '--dump' option is not given.
+If '--dump' option is given, *btrfs receive* will only do the validation of
+the stream, and print the stream metadata.
*btrfs receive* will fail int the following cases:
@@ -56,6 +63,12 @@ By default the mountpoint is searched in '/proc/self/mounts'.
If you do not have '/proc', eg. in a chroot environment, use this option to tell
us where this filesystem is mounted.
+print the stream metadata
+Does not accept the 'path' parameter. So with this option, *btrfs receive* won't
+modify your filesystem, and can be run by non-privileged users.
*btrfs receive* returns a zero exit status if it succeeds. Non zero is