Documentation/btrfs-receive.asciidoc

   1 btrfs-receive(8)
   2 ================
   3
   4 NAME
   5 ----
   6 btrfs-receive - receive subvolumes from stdin/file.
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs receive* [options] <mount>
  11
  12 DESCRIPTION
  13 -----------
  14 Receives one or more subvolumes that were previously
  15 sent with *btrfs send*. The received subvolumes are stored
  16 into <mount>.
  17
  18 *btrfs receive* will fail with the following case:
  19
  20 1. a receiving subvolume already exists.
  21
  22 2. a previously received subvolume was changed after it was received.
  23
  24 3. default subvolume is changed or you don't mount btrfs filesystem with
  25 fs tree.
  26
  27 After receiving a subvolume, it is immediately set to read only.
  28
  29 `Options`
  30
  31 -v::
  32 Enable verbose debug output. Each occurrence of this option increases the
  33 verbose level more.
  34 -f <infile>::
  35 By default, btrfs receive uses stdin to receive the subvolumes.
  36 Use this option to specify a file to use instead.
  37 -C|--chroot::
  38 Confine the process to <mount> using chroot.
  39 -e::
  40 Terminate after receiving an <end cmd> in the data stream.
  41 Without this option, the receiver terminates only if an error is recognized
  42 or on EOF.
  43 --max-errors <N>::
  44 Terminate as soon as N errors happened while processing commands from the send
  45 stream. Default value is 1. A value of 0 means no limit.
  46 -m::
  47 The root mount point of the destination fs.
  48 +
  49 By default the mountpoint is searched in /proc/self/mounts.
  50 If you do not have /proc, eg. in a chroot environment, use this option to tell
  51 us where this filesystem is mounted.
  52
  53 EXIT STATUS
  54 -----------
  55 *btrfs receive* returns a zero exit status if it succeeds. Non zero is
  56 returned in case of failure.
  57
  58 AVAILABILITY
  59 ------------
  60 *btrfs* is part of btrfs-progs.
  61 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  62 further details.
  63
  64 SEE ALSO
  65 --------
  66 `mkfs.btrfs`(8),
  67 `btrfs-send`(8)