|author||Qu Wenruo <firstname.lastname@example.org>||2014-04-02 16:29:22 +0800|
|committer||David Sterba <email@example.com>||2014-04-22 14:15:21 +0200|
btrfs-progs: Convert man page for btrfs-receive.
Convert man page for btrfs-receive. Signed-off-by: Qu Wenruo <firstname.lastname@example.org> Signed-off-by: David Sterba <email@example.com>
Diffstat (limited to 'Documentation')
2 files changed, 59 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 081ec42b..2af4d40c 100644
@@ -25,7 +25,7 @@ MAN8_TXT += btrfs-check.txt
MAN8_TXT += btrfs-rescue.txt
MAN8_TXT += btrfs-inspect-internal.txt
MAN8_TXT += btrfs-send.txt
-#MAN8_TXT += btrfs-receive.txt
+MAN8_TXT += btrfs-receive.txt
#MAN8_TXT += btrfs-quota.txt
#MAN8_TXT += btrfs-replace.txt
#MAN8_TXT += btrfs-dedup.txt
diff --git a/Documentation/btrfs-receive.txt b/Documentation/btrfs-receive.txt
new file mode 100644
@@ -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
+'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
+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.
+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 http://btrfs.wiki.kernel.org for