summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-receive.txt
blob: a67bc6645051800c6040f6a7dd3cf3fc40b93b2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
btrfs-receive(8)
================

NAME
----
btrfs-receive - receive subvolumes from stdin/file.

SYNOPSIS
--------
'btrfs receive' [-ve] [-f <infile>] <mount>

DESCRIPTION
-----------
Receives one or more subvolumes that were previously
sent with 'btrfs send'. The received subvolumes are stored
into <mount>.

'btrfs receive' will fail with the following case:

1. a receiving subvolume already exists.

2. a previously received subvolume was changed after it was received.

3. default subvolume is changed or you don't mount btrfs filesystem with
fs tree.

After receiving a subvolume, it is immediately set to read only.

`Options`

-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.

EXIT STATUS
-----------
'btrfs receive' returns a zero exist status if it succeeds. Non zero is
returned in case of failure.

AVAILABILITY
------------
'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
development,
and not suitable for any uses other than benchmarking and review.
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
further details.

SEE ALSO
--------
`mkfs.btrfs`(8),
`btrfs-send`(8)