mirror of
https://github.com/kdave/btrfs-progs
synced 2025-01-23 22:12:51 +00:00
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>
This commit is contained in:
parent
26ad474e16
commit
44c22cf8be
@ -17,31 +17,29 @@ DESCRIPTION
|
|||||||
-----------
|
-----------
|
||||||
|
|
||||||
Receive a stream of changes and replicate one or more subvolumes that were
|
Receive a stream of changes and replicate one or more subvolumes that were
|
||||||
previously used with *btrfs send* The received subvolumes are stored to
|
previously generated by *btrfs send*. The received subvolumes are stored to
|
||||||
'path', if '--dump' option is not given.
|
'path', unless '--dump' option is given.
|
||||||
|
|
||||||
If '--dump' option is given, *btrfs receive* will only do the validation of
|
If '--dump' option is specified, *btrfs receive* will only do the validation of
|
||||||
the stream, and print the stream metadata.
|
the stream, and print the stream metadata, one operation per line.
|
||||||
|
|
||||||
*btrfs receive* will fail int the following cases:
|
*btrfs receive* will fail int the following cases:
|
||||||
|
|
||||||
1. receiving subvolume already exists
|
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.
|
A subvolume is made read-only after the receiving process finishes succesfully.
|
||||||
|
|
||||||
`Options`
|
`Options`
|
||||||
|
|
||||||
-v::
|
-v::
|
||||||
enable verbose debug output, print each operation (each occurrence of this
|
increase verbosity about performed actions, print details about each operation
|
||||||
option increases the verbosity level)
|
|
||||||
|
|
||||||
-f <infile>::
|
-f <FILE>::
|
||||||
by default, btrfs receive uses standard input to receive the stream,
|
read the stream from <FILE> instead of stdin,
|
||||||
use this option to read from a file instead
|
|
||||||
|
|
||||||
-C|--chroot::
|
-C|--chroot::
|
||||||
confine the process to 'path' using `chroot`(1)
|
confine the process to 'path' using `chroot`(1)
|
||||||
@ -49,25 +47,26 @@ confine the process to 'path' using `chroot`(1)
|
|||||||
-e::
|
-e::
|
||||||
terminate after receiving an 'end cmd' marker in the stream.
|
terminate after receiving an 'end cmd' marker in the stream.
|
||||||
+
|
+
|
||||||
Without this option, the receiver terminates only if an error is encountered
|
Without this option the receiver side terminates only in case
|
||||||
or at end of file
|
of an error on end of file.
|
||||||
|
|
||||||
--max-errors <N>::
|
-E|--max-errors <NERR>::
|
||||||
terminate as soon as N errors happened while processing commands from the send
|
terminate as soon as NERR errors occur while stream processing commands from
|
||||||
stream, default value is 1, 0 means no limit
|
the stream
|
||||||
|
+
|
||||||
|
Default value is 1. A value of 0 means no limit.
|
||||||
|
|
||||||
-m <mountpoint>::
|
-m <ROOTMOUNT>::
|
||||||
the root mount point of the destination filesystem
|
the root mount point of the destination filesystem
|
||||||
+
|
+
|
||||||
By default the mountpoint is searched in '/proc/self/mounts'.
|
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
|
If '/proc' is not accessible, eg. in a chroot environment, use this option to
|
||||||
us where this filesystem is mounted.
|
tell us where this filesystem is mounted.
|
||||||
|
|
||||||
--dump::
|
--dump::
|
||||||
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
|
Does not require the 'path' parameter. The filesystem chanded.
|
||||||
modify your filesystem, and can be run by non-privileged users.
|
|
||||||
|
|
||||||
EXIT STATUS
|
EXIT STATUS
|
||||||
-----------
|
-----------
|
||||||
|
@ -1330,36 +1330,32 @@ out:
|
|||||||
}
|
}
|
||||||
|
|
||||||
const char * const cmd_receive_usage[] = {
|
const char * const cmd_receive_usage[] = {
|
||||||
"btrfs receive [options] <mount>",
|
"btrfs receive [options] <mount>\n"
|
||||||
"or",
|
|
||||||
"btrfs receive --dump [options]",
|
"btrfs receive --dump [options]",
|
||||||
"Receive subvolumes from stdin.",
|
"Receive subvolumes from a stream",
|
||||||
"Receives one or more subvolumes that were previously",
|
"Receives one or more subvolumes that were previously",
|
||||||
"sent with btrfs send. The received subvolumes are stored",
|
"sent with btrfs send. The received subvolumes are stored",
|
||||||
"into <mount>.",
|
"into MOUNT.",
|
||||||
"btrfs receive will fail in case a receiving subvolume",
|
"The receive will fail in case the receiving subvolume",
|
||||||
"already exists. It will also fail in case a previously",
|
"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",
|
"After receiving a subvolume, it is immediately set to",
|
||||||
"read only.\n",
|
"read-only.",
|
||||||
"-v Enable verbose debug output. Each",
|
"",
|
||||||
" occurrence of this option increases the",
|
"-v increase verbosity about performed actions",
|
||||||
" verbose level more.",
|
"-f FILE read the stream from FILE instead of stdin",
|
||||||
"-f <infile> By default, btrfs receive uses stdin",
|
"-e terminate after receiving an <end cmd> marker in the stream.",
|
||||||
" to receive the subvolumes. Use this",
|
" Without this option the receiver side terminates only in case",
|
||||||
" option to specify a file to use instead.",
|
" of an error on end of file.",
|
||||||
"-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.",
|
|
||||||
"-C|--chroot confine the process to <mount> using chroot",
|
"-C|--chroot confine the process to <mount> using chroot",
|
||||||
"--max-errors <N> Terminate as soon as N errors happened while",
|
"-E|--max-errors NERR",
|
||||||
" processing commands from the send stream.",
|
" 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.",
|
" Default value is 1. A value of 0 means no limit.",
|
||||||
"-m <mountpoint> The root mount point of the destination fs.",
|
"-m ROOTMOUNT the root mount point of the destination filesystem.",
|
||||||
" If you do not have /proc use this to tell us where ",
|
" If /proc is not accessible, use this to tell us where",
|
||||||
" this file system is mounted.",
|
" this file system is mounted.",
|
||||||
"--dump Exam and output metadata info of send stream.",
|
"--dump dump stream metadata, one line per operation,",
|
||||||
" Don't need <mount> parameter.",
|
" does not require the MOUNT parameter",
|
||||||
NULL
|
NULL
|
||||||
};
|
};
|
||||||
|
Loading…
Reference in New Issue
Block a user