btrfs: a new tool to manage a btrfs filesystem - man page
PATCH 2/2 btrfs: a new tool to manage a btrfs filesystem - man page
This is the man page of the btrfs command.
man/Makefile +4 -1
@@ -7,13 +7,16 @@ mandir = $(prefix)/man man8dir = $(mandir)/man8 MANPAGES = mkfs.btrfs.8.gz btrfsctl.8.gz btrfsck.8.gz btrfs-image.8.gz \ - btrfs-show.8.gz + btrfs-show.8.gz btrfs.8.gz all: $(MANPAGES) mkfs.btrfs.8.gz: mkfs.btrfs.8.in $(GZIP) -n -c mkfs.btrfs.8.in > mkfs.btrfs.8.gz +btrfs.8.gz: btrfs.8.in + $(GZIP) -n -c btrfs.8.in > btrfs.8.gz + btrfsctl.8.gz: btrfsctl.8.in $(GZIP) -n -c btrfsctl.8.in > btrfsctl.8.gz
man/btrfs.8.in new file +122 -0
122 lines not on this page · raw message
Signature · 2 lines
gpg key@ keyserver.linux.it: Goffredo Baroncelli (ghigo) <kreijackATinwind.it> Key fingerprint = 4769 7E51 5293 D36C 814E C054 BF04 F161 3DC5 0512
Hi Geffredo,
Quoted 10 lines · Goffredo Baroncelli
This is the man page of the btrfs command.
man/Makefile +0
-0@@ -7,13 +7,16 @@ mandir =3D $(prefix)/man=A0man8dir =3D $(mandir)/man8
=A0MANPAGES =3D mkfs.btrfs.8.gz btrfsctl.8.gz btrfsck.8.gz btrfs-imag=
e.8.gz \
Quoted 20 lines
- =A0 =A0 =A0 =A0 =A0btrfs-show.8.gz
+ =A0 =A0 =A0 =A0 =A0btrfs-show.8.gz btrfs.8.gz=A0all: $(MANPAGES)
=A0mkfs.btrfs.8.gz: mkfs.btrfs.8.in
=A0 =A0 =A0 =A0$(GZIP) -n -c mkfs.btrfs.8.in > mkfs.btrfs.8.gzman/Makefile +3
-0+btrfs.8.gz: btrfs.8.in + =A0 =A0 =A0 $(GZIP) -n -c btrfs.8.in > btrfs.8.gz +=A0btrfsctl.8.gz: btrfsctl.8.in
=A0 =A0 =A0 =A0$(GZIP) -n -c btrfsctl.8.in > btrfsctl.8.gzman/btrfs.8.in new file +0
-0
man/btrfs.8.in line 3
Quoted 3 lines
man/btrfs.8.in new file +3
-0@@ -0,0 +1,122 @@ +.TH BTRFS 8 "" "btrfs" "btrfs" +.\" +.\" Man page writte by Goffredo Baroncelli <[email protected]> (Feb=
2010)
Quoted 5 lines
man/btrfs.8.in new file +5
-0+.\" +.SH NAME +btrfs \- control a btrfs filesystem +.SH SYNOPSIS +\fBbtrfs\fP \fB snapshot|\-s \fP\fI <source> [<dest>/]<name>\fP
man/btrfs.8.in
Quoted 10 lines
man/btrfs.8.in new file +10
-0+.PP +\fBbtrfs\fP \fB delete|\-D \fP\fI <subvolume>\fP +.PP +\fBbtrfs\fP \fB create|\-S \fP\fI [<dest>/]<name>\fP +.PP +\fBbtrfs\fP \fB defrag|\-d \fP\fI <file>|<dir> [<file>|<dir>...]\fP +.PP +\fBbtrfs\fP \fB fssync|\-c \fP\fI <path> \fP +.PP +\fBbtrfs\fP \fB resize|\-r \fP\fI [+/\-]<size>[gkm]|max <filesystem>=
\fP
Quoted 7 lines
man/btrfs.8.in new file +7
-0+.PP +\fBbtrfs\fP \fB scan|\-a \fP\fI [<device> [<device>..]]\fP +.PP +\fBbtrfs\fP \fB show|\-l \fP\fI <dev>|<label> [<dev>|<label>...]\fP +.PP +\fBbtrfs\fP \fB balance|\-b \fP\fI <path> \fP +.PP
man/btrfs.8.in
Quoted 10 lines
man/btrfs.8.in new file +10
-0+\fBbtrfs\fP \fB add\-dev|\-A \fP\fI <dev> [<dev>..] <path> \fP +.PP +\fBbtrfs\fP \fB rm\-dev|\-R \fP\fI <dev> [<dev>..] <path> \fP] + +.PP +\fBbtrfs\fP \fB help|\-\-help|\-h \fP\fI\fP +.PP +.SH DESCRIPTION +.B btrfs +is used to control the filesystem and the files and directories stor=
ed. It is
man/btrfs.8.in line 36
Quoted 1 line
man/btrfs.8.in new file +1
-0+the tool to create or destroy a new snapshot or a new subvolume for =
the
man/btrfs.8.in line 37
Quoted 1 line
man/btrfs.8.in new file +1
-0+filesystem, to defrag a file or a directory, to flush the dato to th=
e disk,
man/btrfs.8.in
Quoted 7 lines
man/btrfs.8.in new file +7
-0+to resize a filesystem, to scan the devive + +.SH OPTIONS +.TP + +\fBsnapshot|\-s\fR\fI <source> [<dest>/]<name>\fR +Create a writeble snapshot of the subvolume \fI<source>\fR with the =
name
man/btrfs.8.in line 45
Quoted 1 line
man/btrfs.8.in new file +1
-0+\fI<name>\fR in the \fI<dest>\fR directory. If \fI<source>\fR is not=
a
man/btrfs.8.in
Quoted 5 lines
man/btrfs.8.in new file +5
-0+subvolume, \fBbtrfs\fR returns an error. +.TP + +\fBdelete|\-D\fR\fI <subvolume>\fR +Delete the subvolume \fI<subvolume>\fR. If \fI<subvolume>\fR is not =
a
Quoted 4 lines
man/btrfs.8.in new file +4
-0+subvolume, \fBbtrfs\fR returns an error. +.TP + +\fBcreate|\-S\fR\fI [<dest>/]<name>\fR
man/btrfs.8.in
Quoted 10 lines
man/btrfs.8.in new file +10
-0+Create a subvolume in \fI<dest>\fR (or in the current directory if +\fI<dest>\fR is not passed). +.TP + +\fBdefrag|\-d\fP\fI <file>|<dir> [<file>|<dir>...]\fR +Defragment files and/or directories. +.TP + +\fBscan|\-a\fR \fI[<device> [<device>..]]\fR +Scan devices for a btrfs filesystem. If no devices are passed, \fBbt=
rfs\fR scans
Quoted 5 lines
man/btrfs.8.in new file +5
-0+all the block devices. +.TP + +\fBfssync|\-c\fR\fI <path> \fR +Force a sync for the filesystem identified by \fI<path>\fR.
man/btrfs.8.in
Quoted 10 lines
man/btrfs.8.in new file +10
-0+.TP + +.\" +.\" Some wording are extracted by the resize2fs man page +.\" + +\fBresize|\-r\fR\fI [+/\-]<size>[gkm]|max <filesystem>\fR +Resize a file system indentified by \fI<path>\fR. +The \fI<size>\fR parameter specifies the new size of the filesystem. +If the prefix \fI+\fR or \fI\-\fR is present the size is increased o=
r decreased
man/btrfs.8.in line 81
Quoted 2 lines
man/btrfs.8.in new file +2
-0+by the quantity \fI<size>\fR. +If no units are specified, the unit of the \fI<size>\fR parameter is=
the byte.
man/btrfs.8.in line 82
Quoted 1 line
man/btrfs.8.in new file +1
-0+Optionally, the size parameter may be suffixed by one of the followi=
ng the units
man/btrfs.8.in line 83
Quoted 1 line
man/btrfs.8.in new file +1
-0+designators: 'K', 'M', or 'G', kilobytes, megabytes, or gigabytes, r=
espectively.
man/btrfs.8.in line 85
Quoted 2 lines
man/btrfs.8.in new file +2
-0+ +If 'max' is passed, the filesystem will occupe all available space o=
n the
man/btrfs.8.in
Quoted 3 lines
man/btrfs.8.in new file +3
-0+volume(s). + +The \fBresize\fR command \fBdoes not\fR manipulate the size of under=
lying
man/btrfs.8.in line 89
Quoted 1 line
man/btrfs.8.in new file +1
-0+partitions. =A0If you wish to enlarge/reduce a filesystem, you must =
make sure you
man/btrfs.8.in
Quoted 5 lines
man/btrfs.8.in new file +5
-0+can expand/reduce the size of the partition also. +.TP + +\fBshow|\-l\fR [<dev>|<label>...]\fR +Show the btrfs devices with some additional info. If no devices or l=
abels are
Quoted 8 lines
man/btrfs.8.in new file +8
-0+passed, \fBbtrfs\fR scans all the block devices. +.TP + +\fBbalance|\-b\fR \fI<path>\fR +Balance the chunk of the filesystem identified by \fI<path>\fR +across the devices. +.TP +
man/btrfs.8.in
Quoted 10 lines
man/btrfs.8.in new file +10
-0+\fBadd\-dev|\-A \fR\fI <dev> [<dev>..] <path>\fR +Add device(s) to the filesystem identified by \fI<path>\fR. +.TP + +\fBrm\-dev|\-R \fR\fI <dev> [<dev>..] <path>\fR +Remove device(s) to the filesystem identified by \fI<path>\fR. +.PP + +.SH EXIT STATUS +\fBbtrf\fR returns a zero exist status if it succeeds. Non zero is r=
eturned in
man/btrfs.8.in
Quoted 5 lines
man/btrfs.8.in new file +5
-0+case of failure. + +.SH AVAILABILITY +.B btrfs +is part of btrfs-progs. Btrfs filesystem is currently under heavy de=
velopment,
man/btrfs.8.in line 122
Quoted 5 lines
man/btrfs.8.in new file +5
-0+and not suitable for any uses other than benchmarking and review. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. +.SH SEE ALSO +.BR mkfs.btrfs (8)
Great work. A couple of quick tweaks:
"dato to the disk, to resize a filesystem, to scan the devive" -> "data to the disk, to resize the filesystem, to scan the device"
"indentified by"
-> "identified by"
"will occupe"
-> "will occupy"
Thanks,
Daniel
--=20
Daniel J Blueman
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" = in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html