|author||David Sterba <email@example.com>||2016-11-21 18:19:57 +0100|
|committer||David Sterba <firstname.lastname@example.org>||2016-12-14 15:06:34 +0100|
btrfs-progs: docs: update receive help and manual page
Reword several option descriptions, add missing short option -E, formatting adjustments. Visual bug fix: the first line is printed in short help, the second line is long description, thus alternative calling syntax must be printed on one line. Signed-off-by: David Sterba <email@example.com>
Diffstat (limited to 'Documentation')
1 files changed, 21 insertions, 22 deletions
diff --git a/Documentation/btrfs-receive.asciidoc b/Documentation/btrfs-receive.asciidoc
index f12e9490..a6838e5e 100644
@@ -17,31 +17,29 @@ DESCRIPTION
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.
+previously generated by *btrfs send*. The received subvolumes are stored to
+'path', unless '--dump' option is given.
-If '--dump' option is given, *btrfs receive* will only do the validation of
-the stream, and print the stream metadata.
+If '--dump' option is specified, *btrfs receive* will only do the validation of
+the stream, and print the stream metadata, one operation per line.
*btrfs receive* will fail int the following cases:
1. receiving subvolume already exists
-2. previously received subvolume was changed after it was received
+2. previously received subvolume has been changed after it was received
-3. default subvolume has changed or you didn't mount BTRFS filesystem at the toplevel subvolume
+3. default subvolume has changed or you didn't mount the filesystem at the toplevel subvolume
A subvolume is made read-only after the receiving process finishes succesfully.
-enable verbose debug output, print each operation (each occurrence of this
-option increases the verbosity level)
+increase verbosity about performed actions, print details about each operation
-by default, btrfs receive uses standard input to receive the stream,
-use this option to read from a file instead
+read the stream from <FILE> instead of stdin,
confine the process to 'path' using `chroot`(1)
@@ -49,25 +47,26 @@ confine the process to 'path' using `chroot`(1)
terminate after receiving an 'end cmd' marker in the stream.
-Without this option, the receiver terminates only if an error is encountered
-or at end of file
+Without this option the receiver side terminates only in case
+of an error on end of file.
-terminate as soon as N errors happened while processing commands from the send
-stream, default value is 1, 0 means no limit
+terminate as soon as NERR errors occur while stream processing commands from
+Default value is 1. A value of 0 means no limit.
the root mount point of the destination filesystem
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.
+If '/proc' is not accessible, eg. in a chroot environment, use this option to
+tell us where this filesystem is mounted.
-print the stream metadata
+dump the stream metadata, one line per operation
-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.
+Does not require the 'path' parameter. The filesystem chanded.