diff options
author | David Sterba <dsterba@suse.cz> | 2015-04-14 17:37:23 +0200 |
---|---|---|
committer | David Sterba <dsterba@suse.cz> | 2015-04-14 17:41:27 +0200 |
commit | 7ffccaf0c3b4d4979d7d74bab3d79d9541a6e665 (patch) | |
tree | 1d64b306503787588d0d79ab467b95f8c6a83c99 /Documentation/btrfs-send.asciidoc | |
parent | 32ca2fa502c0a00a7dc40adbdae2e7b7765e6d63 (diff) |
btrfs-progs: Documentaion: rename to .asciidoc
A few minor benefits:
* editors set highliting according to the extensions
* web access to the git repository (github) renders the .asciidoc
files:
* we can link to them from the wiki
* the files are editable via browser and such editations can be
submitted for merge easily
Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-send.asciidoc')
-rw-r--r-- | Documentation/btrfs-send.asciidoc | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/Documentation/btrfs-send.asciidoc b/Documentation/btrfs-send.asciidoc new file mode 100644 index 00000000..6721428d --- /dev/null +++ b/Documentation/btrfs-send.asciidoc @@ -0,0 +1,58 @@ +btrfs-send(8) +============= + +NAME +---- +btrfs-send - send data of subvolume(s) to stdout/file. + +SYNOPSIS +-------- +*btrfs send* [-ve] [-p <parent>] [-c <clone-src>] [-f <outfile>] <subvol> [<subvol>...] + +DESCRIPTION +----------- +Sends the subvolume(s) specified by <subvol> to stdout. + +By default, this will send the whole subvolume. To do an incremental +send, use '-p <parent>'. + +If you want to allow btrfs to clone from any additional local snapshots, +use '-c <clone-src>' (multiple times where applicable). + +You must not specify clone sources unless you guarantee that these snapshots +are exactly in the same state on both sides, the sender and the receiver. + +It is allowed to omit the '-p <parent>' option when '-c <clone-src>' options +are given, in which case *btrfs send* will determine a suitable parent among the +clone sources itself. + +`Options` + +-v:: +Enable verbose debug output. Each occurrence of this option increases the +verbose level more. +-e:: +If sending multiple subvols at once, use the new format and omit the <end cmd> between the subvols. +-p <parent>:: +Send an incremental stream from <parent> to <subvol>. +-c <clone-src>:: +Use this snapshot as a clone source for an incremental send (multiple allowed). +-f <outfile>:: +Output is normally written to stdout. To write to a file, use this option. +An alternative would be to use pipes. + +EXIT STATUS +----------- +*btrfs send* 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-receive`(8) |