2014-04-02 08:29:22 +00:00
|
|
|
btrfs-receive(8)
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2016-05-06 11:12:42 +00:00
|
|
|
btrfs-receive - receive subvolumes from send stream
|
2014-04-02 08:29:22 +00:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2015-04-19 11:46:28 +00:00
|
|
|
*btrfs receive* [options] <mount>
|
2014-04-02 08:29:22 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
2016-05-06 11:12:42 +00:00
|
|
|
Receive a stream of changes and replicate one or more subvolumes that were
|
|
|
|
|
previously used with *btrfs send* The received subvolumes are stored to
|
|
|
|
|
'mount'.
|
2014-04-02 08:29:22 +00:00
|
|
|
|
2016-05-06 11:12:42 +00:00
|
|
|
*btrfs receive* will fail int the following cases:
|
2014-04-02 08:29:22 +00:00
|
|
|
|
2016-05-06 11:12:42 +00:00
|
|
|
1. receiving subvolume already exists
|
2014-04-02 08:29:22 +00:00
|
|
|
|
2016-05-06 11:12:42 +00:00
|
|
|
2. previously received subvolume was changed after it was received
|
2014-04-02 08:29:22 +00:00
|
|
|
|
2016-05-06 11:12:42 +00:00
|
|
|
3. default subvolume has changed or you didn't mount BTRFS filesystem at the toplevel subvolume
|
|
|
|
|
|
|
|
|
|
A subvolume is made read-only after the receiving process finishes succesfully.
|
2014-04-02 08:29:22 +00:00
|
|
|
|
|
|
|
|
`Options`
|
|
|
|
|
|
|
|
|
|
-v::
|
2016-05-06 11:12:42 +00:00
|
|
|
enable verbose debug output, print each operation (each occurrence of this
|
|
|
|
|
option increases the verbosity level)
|
|
|
|
|
|
2014-04-02 08:29:22 +00:00
|
|
|
-f <infile>::
|
2016-05-06 11:12:42 +00:00
|
|
|
by default, btrfs receive uses standard input to receive the stream,
|
|
|
|
|
use this option to read from a file instead
|
|
|
|
|
|
2015-04-19 11:46:28 +00:00
|
|
|
-C|--chroot::
|
2016-05-06 11:12:42 +00:00
|
|
|
confine the process to 'mount' using `chroot`(1)
|
|
|
|
|
|
2014-04-02 08:29:22 +00:00
|
|
|
-e::
|
2016-05-06 11:12:42 +00:00
|
|
|
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
|
|
|
|
|
|
2014-05-23 19:14:56 +00:00
|
|
|
--max-errors <N>::
|
2016-05-06 11:12:42 +00:00
|
|
|
terminate as soon as N errors happened while processing commands from the send
|
|
|
|
|
stream, default value is 1, 0 means no limit
|
|
|
|
|
|
2016-03-16 02:01:11 +00:00
|
|
|
-m <mountpoint>::
|
2016-05-06 11:12:42 +00:00
|
|
|
the root mount point of the destination filesystem
|
2015-05-27 17:51:29 +00:00
|
|
|
+
|
2016-05-06 11:12:42 +00:00
|
|
|
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
|
2015-05-27 17:51:29 +00:00
|
|
|
us where this filesystem is mounted.
|
2014-04-02 08:29:22 +00:00
|
|
|
|
|
|
|
|
EXIT STATUS
|
|
|
|
|
-----------
|
2014-09-19 01:49:59 +00:00
|
|
|
*btrfs receive* returns a zero exit status if it succeeds. Non zero is
|
2014-04-02 08:29:22 +00:00
|
|
|
returned in case of failure.
|
|
|
|
|
|
|
|
|
|
AVAILABILITY
|
|
|
|
|
------------
|
2014-05-19 16:04:26 +00:00
|
|
|
*btrfs* is part of btrfs-progs.
|
2014-04-02 08:29:22 +00:00
|
|
|
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
|
|
|
|
|
further details.
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
`mkfs.btrfs`(8),
|
|
|
|
|
`btrfs-send`(8)
|
