diff options
| author | David Sterba <dsterba@suse.cz> | 2015-04-14 17:37:23 +0200 |
|---|---|---|
| committer | David Sterba <dsterba@suse.cz> | 2015-04-14 17:41:27 +0200 |
| commit | 7ffccaf0c3b4d4979d7d74bab3d79d9541a6e665 (patch) | |
| tree | 1d64b306503787588d0d79ab467b95f8c6a83c99 /Documentation/btrfs-receive.asciidoc | |
| parent | 32ca2fa502c0a00a7dc40adbdae2e7b7765e6d63 (diff) | |
btrfs-progs: Documentaion: rename to .asciidoc
A few minor benefits:
* editors set highliting according to the extensions
* web access to the git repository (github) renders the .asciidoc
files:
* we can link to them from the wiki
* the files are editable via browser and such editations can be
submitted for merge easily
Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-receive.asciidoc')
| -rw-r--r-- | Documentation/btrfs-receive.asciidoc | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/Documentation/btrfs-receive.asciidoc b/Documentation/btrfs-receive.asciidoc new file mode 100644 index 00000000..ed1e247f --- /dev/null +++ b/Documentation/btrfs-receive.asciidoc @@ -0,0 +1,59 @@ +btrfs-receive(8) +================ + +NAME +---- +btrfs-receive - receive subvolumes from stdin/file. + +SYNOPSIS +-------- +*btrfs receive* [-ve] [-f <infile>] [--max-errors <N>] <mount> + +DESCRIPTION +----------- +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. + +`Options` + +-v:: +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. +-e:: +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. +--max-errors <N>:: +Terminate as soon as N errors happened while processing commands from the send +stream. Default value is 1. A value of 0 means no limit. + +EXIT STATUS +----------- +*btrfs receive* returns a zero exit status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +*btrfs* is part of btrfs-progs. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`btrfs-send`(8) |