Documentation/btrfs-send.asciidoc

   1 btrfs-send(8)
   2 =============
   3
   4 NAME
   5 ----
   6 btrfs-send - send data of subvolume(s) to stdout/file.
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs send* [-ve] [-p <parent>] [-c <clone-src>] [-f <outfile>] <subvol> [<subvol>...]
  11
  12 DESCRIPTION
  13 -----------
  14 Sends the subvolume(s) specified by <subvol> to stdout.
  15 <subvol> should be read-only here.
  16
  17 By default, this will send the whole subvolume. To do an incremental
  18 send, use '-p <parent>'.
  19
  20 If you want to allow btrfs to clone from any additional local snapshots,
  21 use '-c <clone-src>' (multiple times where applicable).
  22
  23 You must not specify clone sources unless you guarantee that these snapshots
  24 are exactly in the same state on both sides, the sender and the receiver.
  25
  26 It is allowed to omit the '-p <parent>' option when '-c <clone-src>' options
  27 are given, in which case *btrfs send* will determine a suitable parent among the
  28 clone sources itself.
  29
  30 `Options`
  31
  32 -v::
  33 Enable verbose debug output. Each occurrence of this option increases the
  34 verbose level more.
  35 -e::
  36 If sending multiple subvols at once, use the new format and omit the <end cmd> between the subvols.
  37 -p <parent>::
  38 Send an incremental stream from <parent> to <subvol>.
  39 -c <clone-src>::
  40 Use this snapshot as a clone source for an incremental send (multiple allowed).
  41 -f <outfile>::
  42 Output is normally written to stdout. To write to a file, use this option.
  43 An alternative would be to use pipes.
  44 --no-data::
  45 Send in NO_FILE_DATA mode. The output stream does not contain any file
  46 data and thus cannot be used to transfer changes. This mode is faster and
  47 useful to show the differences in metadata.
  48
  49 EXIT STATUS
  50 -----------
  51 *btrfs send* returns a zero exit status if it succeeds. Non zero is
  52 returned in case of failure.
  53
  54 AVAILABILITY
  55 ------------
  56 *btrfs* is part of btrfs-progs.
  57 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  58 further details.
  59
  60 SEE ALSO
  61 --------
  62 `mkfs.btrfs`(8),
  63 `btrfs-receive`(8)