summaryrefslogtreecommitdiff
path: root/cmds-receive.c
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2016-11-21 18:19:57 +0100
committerDavid Sterba <dsterba@suse.com>2016-12-14 15:06:34 +0100
commit44c22cf8be0aa4111c8126602c64d9634750f10d (patch)
tree0b9de1d69814a1094fc6dd1c4ee732721a0ea4d2 /cmds-receive.c
parent26ad474e16637e34a91aec8cf9df206d51a0865a (diff)
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 <dsterba@suse.com>
Diffstat (limited to 'cmds-receive.c')
-rw-r--r--cmds-receive.c42
1 files changed, 19 insertions, 23 deletions
diff --git a/cmds-receive.c b/cmds-receive.c
index 68950b4f..6f54c2ed 100644
--- a/cmds-receive.c
+++ b/cmds-receive.c
@@ -1330,36 +1330,32 @@ out:
}
const char * const cmd_receive_usage[] = {
- "btrfs receive [options] <mount>",
- "or",
+ "btrfs receive [options] <mount>\n"
"btrfs receive --dump [options]",
- "Receive subvolumes from stdin.",
+ "Receive subvolumes from a stream",
"Receives one or more subvolumes that were previously",
"sent with btrfs send. The received subvolumes are stored",
- "into <mount>.",
- "btrfs receive will fail in case a receiving subvolume",
+ "into MOUNT.",
+ "The receive will fail in case the receiving subvolume",
"already exists. It will also fail in case a previously",
- "received subvolume was changed after it was received.",
+ "received subvolume has been changed after it was received.",
"After receiving a subvolume, it is immediately set to",
- "read only.\n",
- "-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.",
+ "read-only.",
+ "",
+ "-v increase verbosity about performed actions",
+ "-f FILE read the stream from FILE instead of stdin",
+ "-e terminate after receiving an <end cmd> marker in the stream.",
+ " Without this option the receiver side terminates only in case",
+ " of an error on end of file.",
"-C|--chroot confine the process to <mount> using chroot",
- "--max-errors <N> Terminate as soon as N errors happened while",
- " processing commands from the send stream.",
+ "-E|--max-errors NERR",
+ " terminate as soon as NERR errors occur while",
+ " stream processing commands from the stream.",
" Default value is 1. A value of 0 means no limit.",
- "-m <mountpoint> The root mount point of the destination fs.",
- " If you do not have /proc use this to tell us where ",
+ "-m ROOTMOUNT the root mount point of the destination filesystem.",
+ " If /proc is not accessible, use this to tell us where",
" this file system is mounted.",
- "--dump Exam and output metadata info of send stream.",
- " Don't need <mount> parameter.",
+ "--dump dump stream metadata, one line per operation,",
+ " does not require the MOUNT parameter",
NULL
};