1BTRFS-RECEIVE(8) Btrfs Manual BTRFS-RECEIVE(8)
2
3
4
6 btrfs-receive - receive subvolumes from send stream
7
9 btrfs receive [options] <path>
10
11 or
12
13 btrfs receive --dump [options]
14
16 Receive a stream of changes and replicate one or more subvolumes that
17 were previously generated by btrfs send. The received subvolumes are
18 stored to path, unless --dump option is given.
19
20 If --dump option is specified, btrfs receive will only do the
21 validation of the stream, and print the stream metadata, one operation
22 per line.
23
24 btrfs receive will fail int the following cases:
25
26 1. receiving subvolume already exists
27
28 2. previously received subvolume has been changed after it was
29 received
30
31 3. default subvolume has changed or you didn’t mount the filesystem at
32 the toplevel subvolume
33
34 A subvolume is made read-only after the receiving process finishes
35 succesfully.
36
37 Options
38
39 -v
40 increase verbosity about performed actions, print details about
41 each operation
42
43 -f <FILE>
44 read the stream from <FILE> instead of stdin,
45
46 -C|--chroot
47 confine the process to path using chroot(1)
48
49 -e
50 terminate after receiving an end cmd marker in the stream.
51
52 Without this option the receiver side terminates only in case of an
53 error on end of file.
54
55 -E|--max-errors <NERR>
56 terminate as soon as NERR errors occur while stream processing
57 commands from the stream
58
59 Default value is 1. A value of 0 means no limit.
60
61 -m <ROOTMOUNT>
62 the root mount point of the destination filesystem
63
64 By default the mountpoint is searched in /proc/self/mounts. If
65 /proc is not accessible, eg. in a chroot environment, use this
66 option to tell us where this filesystem is mounted.
67
68 --dump
69 dump the stream metadata, one line per operation
70
71 Does not require the path parameter. The filesystem chanded.
72
74 btrfs receive returns a zero exit status if it succeeds. Non zero is
75 returned in case of failure.
76
78 btrfs is part of btrfs-progs. Please refer to the btrfs wiki
79 http://btrfs.wiki.kernel.org for further details.
80
82 mkfs.btrfs(8), btrfs-send(8)
83
84
85
86Btrfs v4.9.1 08/06/2017 BTRFS-RECEIVE(8)