Manpage/btrfs-send

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Update from git, v5.14.2)
(remove content)
 
Line 1: Line 1:
=btrfs-send(8) manual page=
 
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs-send}}
 
|name=btrfs-send}}
 
==NAME==
 
btrfs-send - generate a stream of changes between two subvolume snapshots
 
 
==SYNOPSIS==
 
 
<p><b>btrfs send</b> [-ve] [-p <em>&lt;parent&gt;</em>] [-c <em>&lt;clone-src&gt;</em>] [-f <em>&lt;outfile&gt;</em>] <em>&lt;subvol&gt;</em> [<em>&lt;subvol&gt;</em>&#8230;]</p>
 
==DESCRIPTION==
 
 
<p>This command will generate a stream of instructions that describe changes
 
between two subvolume snapshots. The stream can be consumed by the <b>btrfs
 
receive</b> command to replicate the sent snapshot on a different filesystem.
 
The command operates in two modes: full and incremental.</p>
 
<p>All snapshots involved in one send command must be read-only, and this status
 
cannot be changed as long as there&#8217;s a running send operation that uses the
 
snapshot.</p>
 
<p>In the full mode, the entire snapshot data and metadata will end up in the
 
stream.</p>
 
<p>In the incremental mode (options <em>-p</em> and <em>-c</em>), previously sent snapshots that
 
are available on both the sending and receiving side can be used to reduce the
 
amount of information that has to be sent to reconstruct the sent snapshot on a
 
different filesystem.</p>
 
<p>The <em>-p <em>&lt;parent&gt;</em></em> option can be omitted when <em>-c <em>&lt;clone-src&gt;</em></em> options are
 
given, in which case <b>btrfs send</b> will determine a suitable parent from among
 
the clone sources.</p>
 
<p>You must not specify clone sources unless you guarantee that these snapshots
 
are exactly in the same state on both sides&#8212;both for the sender and the
 
receiver. For implications of changed read-write status of a received snapshot
 
please see section <em>SUBVOLUME FLAGS</em> in [[Manpage/btrfs-subvolume|btrfs-subvolume(8)]].</p>
 
<p><tt>Options</tt></p>
 
<dl>
 
<dt>
 
-e
 
<dd>
 
<p>
 
if sending multiple subvolumes at once, use the new format and omit the
 
<em>end cmd</em> marker in the stream separating the subvolumes
 
</p>
 
 
<dt>
 
-p <em>&lt;parent&gt;</em>
 
<dd>
 
<p>
 
send an incremental stream from <em>parent</em> to <em>subvol</em>
 
</p>
 
 
<dt>
 
-c <em>&lt;clone-src&gt;</em>
 
<dd>
 
<p>
 
use this snapshot as a clone source for an incremental send (multiple allowed)
 
</p>
 
 
<dt>
 
-f <em>&lt;outfile&gt;</em>
 
<dd>
 
<p>
 
output is normally written to standard output so it can be, for example, piped
 
to btrfs receive. Use this option to write it to a file instead.
 
</p>
 
 
<dt>
 
--no-data
 
<dd>
 
<p>
 
send in <em>NO_FILE_DATA</em> mode
 
</p>
 
<p>The output stream does not contain any file
 
data and thus cannot be used to transfer changes. This mode is faster and
 
is useful to show the differences in metadata.
 
-q|--quiet::::
 
(deprecated) alias for global <em>-q</em> option
 
-v|--verbose::
 
(deprecated) alias for global <em>-v</em> option</p>
 
 
</dl>
 
<p><tt>Global options</tt></p>
 
<dl>
 
<dt>
 
-q|--quiet
 
<dd>
 
<p>
 
suppress all messages except errors
 
</p>
 
 
<dt>
 
-v|--verbose
 
<dd>
 
<p>
 
increase output verbosity, print generated commands in a readable form
 
</p>
 
 
</dl>
 
==EXIT STATUS==
 
 
<p><b>btrfs send</b> returns a zero exit status if it succeeds. Non zero is
 
returned in case of failure.</p>
 
==AVAILABILITY==
 
 
<p><b>btrfs</b> is part of btrfs-progs.
 
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 
further details.</p>
 
==SEE ALSO==
 
 
<p>[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]],
 
[[Manpage/btrfs-receive|btrfs-receive(8)]],
 
[[Manpage/btrfs-subvolume|btrfs-subvolume(8)]]</p>
 
[[Category:Manpage]]
 

Latest revision as of 12:33, 12 January 2022

Note: manual pages are located at read-the-docs site, please update your links.


Personal tools