path: root/Documentation/btrfs-receive.asciidoc
diff options
authorNicholas D Steeves <>2016-04-23 00:41:30 +0100
committerNicholas D Steeves <>2016-04-23 00:41:30 +0100
commitcec572daccafa1e912cbed363df6f84687778c6f (patch)
tree7d99ab9f73d25c1ed8eaf6393f6374edf5316b03 /Documentation/btrfs-receive.asciidoc
btrfs-progs (4.4.1-1.1) unstable; urgency=medium
* Non-maintainer upload. * New upstream release. * Rename package to btrfs-progs (Closes: #780081) * Update standards version to 3.9.7 (no changes needed). * debian/control: Add "Breaks" per Gianfranco Costamagna's suggestion * Change lintian override to reflect package rename * Switch from using postinst and postrm to using triggers per Christian Seiler's recommendation. # imported from the archive
Diffstat (limited to 'Documentation/btrfs-receive.asciidoc')
1 files changed, 67 insertions, 0 deletions
diff --git a/Documentation/btrfs-receive.asciidoc b/Documentation/btrfs-receive.asciidoc
new file mode 100644
index 00000000..84b85c1c
--- /dev/null
+++ b/Documentation/btrfs-receive.asciidoc
@@ -0,0 +1,67 @@
+btrfs-receive - receive subvolumes from stdin/file.
+*btrfs receive* [options] <mount>
+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.
+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.
+Confine the process to <mount> using chroot.
+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.
+--max-errors <N>::
+Terminate as soon as N errors happened while processing commands from the send
+stream. Default value is 1. A value of 0 means no limit.
+The root mount point of the destination fs.
+By default the mountpoint is searched in /proc/self/mounts.
+If you do not have /proc, eg. in a chroot environment, use this option to tell
+us where this filesystem is mounted.
+*btrfs receive* returns a zero exit status if it succeeds. Non zero is
+returned in case of failure.
+*btrfs* is part of btrfs-progs.
+Please refer to the btrfs wiki for
+further details.