Documentation/btrfs-receive.asciidoc

   1 btrfs-receive(8)
   2 ================
   3
   4 NAME
   5 ----
   6 btrfs-receive - receive subvolumes from send stream
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs receive* [options] <path>
  11
  12 DESCRIPTION
  13 -----------
  14
  15 Receive a stream of changes and replicate one or more subvolumes that were
  16 previously used with *btrfs send* The received subvolumes are stored to
  17 'path'.
  18
  19 *btrfs receive* will fail int the following cases:
  20
  21 1. receiving subvolume already exists
  22
  23 2. previously received subvolume was changed after it was received
  24
  25 3. default subvolume has changed or you didn't mount BTRFS filesystem at the toplevel subvolume
  26
  27 A subvolume is made read-only after the receiving process finishes succesfully.
  28
  29 `Options`
  30
  31 -v::
  32 enable verbose debug output, print each operation (each occurrence of this
  33 option increases the verbosity level)
  34
  35 -f <infile>::
  36 by default, btrfs receive uses standard input to receive the stream,
  37 use this option to read from a file instead
  38
  39 -C|--chroot::
  40 confine the process to 'path' using `chroot`(1)
  41
  42 -e::
  43 terminate after receiving an 'end cmd' marker in the stream.
  44 +
  45 Without this option, the receiver terminates only if an error is encountered
  46 or at end of file
  47
  48 --max-errors <N>::
  49 terminate as soon as N errors happened while processing commands from the send
  50 stream, default value is 1, 0 means no limit
  51
  52 -m <mountpoint>::
  53 the root mount point of the destination filesystem
  54 +
  55 By default the mountpoint is searched in '/proc/self/mounts'.
  56 If you do not have '/proc', eg. in a chroot environment, use this option to tell
  57 us where this filesystem is mounted.
  58
  59 EXIT STATUS
  60 -----------
  61 *btrfs receive* returns a zero exit status if it succeeds. Non zero is
  62 returned in case of failure.
  63
  64 AVAILABILITY
  65 ------------
  66 *btrfs* is part of btrfs-progs.
  67 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  68 further details.
  69
  70 SEE ALSO
  71 --------
  72 `mkfs.btrfs`(8),
  73 `btrfs-send`(8)