← Back to branch summary

~ubuntu-branches/debian/jessie/btrfs-tools/jessie

« back to all changes in this revision

Viewing changes to man/btrfs.8.in

  • Committer: Package Import Robot
  • Author(s): Dimitri John Ledkov
  • Date: 2014-04-19 12:12:11 UTC
  • mfrom: (1.2.12) (6.1.37 sid)
  • Revision ID: package-import@ubuntu.com-20140419121211-mski0g757tsdv4x1
Tags: 3.14.1-1
* New upstream release.
* Switch to git-dpm.
* Rebase and cleanup patches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/btrfs.8.in
8
8
.SH SYNOPSIS
9
9
\fBbtrfs\fP \fBsubvolume create\fP [-i \fI<qgroupid>\fP] [\fI<dest>\fP/]\fI<name>\fP
10
10
.PP
11
 
\fBbtrfs\fP \fBsubvolume delete\fP \fI<subvolume>\fP [\fI<subvolume>...\fP]
 
11
\fBbtrfs\fP \fBsubvolume delete\fP [\fIoptions\fP] \fI<subvolume>\fP [\fI<subvolume>...\fP]
12
12
.PP
13
13
\fBbtrfs\fP \fBsubvolume list\fP [\fIoptions\fP] [-G [+|-]\fIvalue\fP] [-C [+|-]\fIvalue\fP] [--sort=rootid,gen,ogen,path] \fI<path>\fP
14
14
.PP
58
58
\fBbtrfs\fP \fBdevice stats\fP [-z] {\fI<path>\fP|\fI<device>\fP}
59
59
.PP
60
60
.PP
61
 
\fBbtrfs\fP \fBscrub start\fP [-BdqrR] [-c \fIioprio_class\fP -n \fIioprio_classdata\fP] {\fI<path>\fP|\fI<device>\fP}
 
61
\fBbtrfs\fP \fBscrub start\fP [-BdqrRf] [-c \fIioprio_class\fP -n \fIioprio_classdata\fP] {\fI<path>\fP|\fI<device>\fP}
62
62
.PP
63
63
\fBbtrfs\fP \fBscrub cancel\fP {\fI<path>\fP|\fI<device>\fP}
64
64
.PP
85
85
\fBbtrfs\fP \fBinspect-internal rootid\fP \fI<path>\fP
86
86
.PP
87
87
.PP
88
 
\fBbtrfs\fP \fBsend\fP [-v] [-p \fI<parent>\fP] [-c \fI<clone-src>\fP] [-f \fI<outfile>\fP] \fI<subvol>\fP
 
88
\fBbtrfs\fP \fBsend\fP [-ve] [-p \fI<parent>\fP] [-c \fI<clone-src>\fP] [-f \fI<outfile>\fP] \fI<subvol>\fP [\fI<subvol>\fP...]
89
89
.PP
90
90
\fBbtrfs\fP \fBreceive\fP [-ve] [-f \fI<infile>\fP] \fI<mount>\fP
91
91
.PP
168
168
.RE
169
169
.TP
170
170
 
171
 
\fBsubvolume delete\fR\fI <subvolume> \fP[\fI<subvolume>...\fP]\fR
172
 
Delete the subvolume \fI<subvolume>\fR. If \fI<subvolume>\fR is not a
173
 
subvolume, \fBbtrfs\fR returns an error.
 
171
\fBsubvolume delete\fR [\fIoptions\fP] \fI<subvolume>\fP [\fI<subvolume>...\fP]\fR
 
172
Delete the subvolume(s) from the filesystem. If \fI<subvolume>\fR is not a
 
173
subvolume, \fBbtrfs\fR returns an error but continues if there are more arguments
 
174
to process.
 
175
 
 
176
The corresponding directory is removed instantly but the data blocks are
 
177
removed later.  The deletion does not involve full commit by default due to
 
178
performance reasons (as a consequence, the subvolume may appear again after a
 
179
crash).  Use one of the --commit options to wait until the operation is safely
 
180
stored on the media.
 
181
.RS
 
182
 
 
183
\fIOptions\fP
 
184
.IP "\fB-c|--commit-after\fP" 5
 
185
wait for transaction commit at the end of the operation
 
186
.IP "\fB-C|--commit-each\fP" 5
 
187
wait for transaction commit after deleting each subvolume
 
188
.RE
174
189
.TP
175
190
 
176
191
\fBsubvolume list\fR [\fIoptions\fP] [-G [+|-]\fIvalue\fP] [-C [+|-]\fIvalue\fP] [--sort=rootid,gen,ogen,path] \fI<path>\fR
461
476
Set IO priority classdata (see
462
477
.BR ionice (1)
463
478
manpage).
 
479
.IP "\fB-f\fP" 5
 
480
force to check whether scrub has started or resumed in userspace.
 
481
this is useful when scrub stat record file is damaged.
464
482
.RE
465
483
.TP
466
484
 
607
625
The result is undefined for the so-called empty subvolumes (identified by inode number 2).
608
626
.TP
609
627
 
610
 
\fBsend\fP [-v] [-p \fI<parent>\fP] [-c \fI<clone-src>\fP] [-f \fI<outfile>\fP] \fI<subvol>\fP
611
 
Send the subvolume to stdout.
612
 
Sends the subvolume specified by \fI<subvol>\fR to stdout.
 
628
\fBsend\fP [-ve] [-p \fI<parent>\fP] [-c \fI<clone-src>\fP] [-f \fI<outfile>\fP] \fI<subvol>\fP [\fI<subvol>...\fP]
 
629
Send the subvolume(s) to stdout.
 
630
Sends the subvolume(s) specified by \fI<subvol>\fR to stdout.
613
631
By default, this will send the whole subvolume. To do an incremental
614
632
send, use '\fI-p <parent>\fR'. If you want to allow btrfs to clone from
615
633
any additional local snapshots, use '\fI-c <clone-src>\fR' (multiple times
616
634
where applicable). You must not specify clone sources unless you
617
635
guarantee that these snapshots are exactly in the same state on both
618
 
sides, the sender and the receiver. It is allowed to omit the
619
 
'\fI-p <parent>\fR' option when '\fI-c <clone-src>\fR' options are given, in
 
636
sides, the sender and the receiver. It is allowed to omit the '\fI-p <parent>\fR'
 
637
option when '\fI-c <clone-src>\fR' options are given, in
620
638
which case '\fBbtrfs send\fP' will determine a suitable parent among the
621
639
clone sources itself.
622
640
.RS
625
643
.IP "\fB-v\fP" 5
626
644
Enable verbose debug output. Each occurrence of this option increases the
627
645
verbose level more.
 
646
.IP "\fB-e\fP" 5
 
647
If sending multiple subvols at once, use the new format and omit the <end cmd> between the subvols.
628
648
.IP "\fB-p \fI<parent>\fP" 5
629
649
Send an incremental stream from \fI<parent>\fR to \fI<subvol>\fR.
630
650
.IP "\fB-c \fI<clone-src>\fP" 5
640
660
Receives one or more subvolumes that were previously
641
661
sent with btrfs send. The received subvolumes are stored
642
662
into \fI<mount>\fP.
643
 
btrfs receive will fail in case a receiving subvolume
644
 
already exists. It will also fail in case a previously
645
 
received subvolume was changed after it was received.
646
 
After receiving a subvolume, it is immediately set to
647
 
read only.
 
663
btrfs receive will fail with the following case:
 
664
 
 
665
1.a receiving subvolume already exists.
 
666
 
 
667
2.a previously received subvolume was changed after it was received.
 
668
 
 
669
3.default subvolume is changed or you don't mount btrfs filesystem with
 
670
fs tree.
 
671
 
 
672
After receiving a subvolume, it is immediately set to read only.
648
673
.RS
649
674
 
650
675
\fIOptions\fR