btrfs-progs/Documentation/btrfs-receive.asciidoc
Josef Bacik 420afa3edc btrfs-progs: specify mountpoint for recieve
In a chroot environment we may not have /proc mounted, which makes btrfs receive
freak out since it wants to know the base directory where are are mounted for
things like clone and such.  Give an option to specify where the mountpoint is
in these cases so you can still do a btrfs receive in a chroot.  Thanks,

Signed-off-by: Josef Bacik <jbacik@fb.com>
[added manpage documentation]
Signed-off-by: David Sterba <dsterba@suse.cz>
2015-06-02 17:35:43 +02:00

68 lines
1.7 KiB
Plaintext

btrfs-receive(8)
================
NAME
----
btrfs-receive - receive subvolumes from stdin/file.
SYNOPSIS
--------
*btrfs receive* [options] <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.
-C|--chroot::
Confine the process to <mount> using chroot.
-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.
--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.
-m::
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.
EXIT STATUS
-----------
*btrfs receive* returns a zero exit status if it succeeds. Non zero is
returned in case of failure.
AVAILABILITY
------------
*btrfs* is part of btrfs-progs.
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
further details.
SEE ALSO
--------
`mkfs.btrfs`(8),
`btrfs-send`(8)