path: root/Documentation/btrfs-receive.txt
diff options
authorQu Wenruo <>2014-04-02 16:29:22 +0800
committerDavid Sterba <>2014-04-22 14:15:21 +0200
commit1a7a47c8e86da3fa91bf314b9a22c24a419697c0 (patch)
tree64d6d1be0306e70d6592a49e9d4d8b9c70bc7db6 /Documentation/btrfs-receive.txt
parent1873426ece07b0b05155a47e70c47f99a2ad81ab (diff)
btrfs-progs: Convert man page for btrfs-receive.
Convert man page for btrfs-receive. Signed-off-by: Qu Wenruo <> Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation/btrfs-receive.txt')
1 files changed, 58 insertions, 0 deletions
diff --git a/Documentation/btrfs-receive.txt b/Documentation/btrfs-receive.txt
new file mode 100644
index 00000000..a67bc664
--- /dev/null
+++ b/Documentation/btrfs-receive.txt
@@ -0,0 +1,58 @@
+btrfs-receive - receive subvolumes from stdin/file.
+'btrfs receive' [-ve] [-f <infile>] <mount>
+Receives one or more subvolumes that were previously
+sent with 'btrfs send'. The received subvolumes are stored
+into <mount>.
+'btrfs receive' will fail with the following case:
+1. a receiving subvolume already exists.
+2. a previously received subvolume was changed after it was received.
+3. default subvolume is changed or you don't mount btrfs filesystem with
+fs tree.
+After receiving a subvolume, it is immediately set to read only.
+Enable verbose debug output. Each occurrence of this option increases the
+verbose level more.
+-f <infile>::
+By default, btrfs receive uses stdin to receive the subvolumes.
+Use this option to specify a file to use instead.
+Terminate after receiving an <end cmd> in the data stream.
+Without this option, the receiver terminates only if an error is recognized
+or on EOF.
+'btrfs receive' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki for
+further details.