From 1a7a47c8e86da3fa91bf314b9a22c24a419697c0 Mon Sep 17 00:00:00 2001 From: Qu Wenruo Date: Wed, 2 Apr 2014 16:29:22 +0800 Subject: btrfs-progs: Convert man page for btrfs-receive. Convert man page for btrfs-receive. Signed-off-by: Qu Wenruo Signed-off-by: David Sterba --- Documentation/Makefile | 2 +- Documentation/btrfs-receive.txt | 58 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 Documentation/btrfs-receive.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 081ec42b..2af4d40c 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -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 index 00000000..a67bc664 --- /dev/null +++ b/Documentation/btrfs-receive.txt @@ -0,0 +1,58 @@ +btrfs-receive(8) +================ + +NAME +---- +btrfs-receive - receive subvolumes from stdin/file. + +SYNOPSIS +-------- +'btrfs receive' [-ve] [-f ] + +DESCRIPTION +----------- +Receives one or more subvolumes that were previously +sent with 'btrfs send'. The received subvolumes are stored +into . + +'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. + +`Options` + +-v:: +Enable verbose debug output. Each occurrence of this option increases the +verbose level more. +-f :: +By default, btrfs receive uses stdin to receive the subvolumes. +Use this option to specify a file to use instead. +-e:: +Terminate after receiving an in the data stream. +Without this option, the receiver terminates only if an error is recognized +or on EOF. + +EXIT STATUS +----------- +'btrfs receive' returns a zero exist status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +development, +and not suitable for any uses other than benchmarking and review. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`btrfs-send`(8) -- cgit v1.2.3