Skip to contentSkip to conversation

btrfs, a new tool to manage a btrfs filesystem; man page

PATCH In review Goffredo Baroncelli 1 participant 1 message Feb 17, 2010 Btrfs file system

lore
Share & tools
lore
#0 lore raw

PATCH v2 2/2 btrfs, a new tool to manage a btrfs filesystem; man page

This is the source code of the man page of btrfs. The main changes from my previous patch are:
- Rearranged the short command in order to avoid conflicts
- Renamed the 'create' verb is 'subvolume'

Thanks to Daniel for some tweaks on the syntax

BR
G.Baroncelli

man/Makefile +4 -1
index 4e8893b..4a90b75 100644
@@ -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 +64 -0

64 lines not on this page · raw message

scans
+all the block devices.
+.TP
+
+\fBfssync|\-y\fR\fI <path> \fR
+Force a sync for the filesystem identified by \fI<path>\fR.
+.TP
+
+.\"
+.\" Some wording are extracted by the resize2fs man page
+.\"
+
+\fBresize|\-z\fR\fI [+/\-]<size>[gkm]|max <filesystem>\fR +Resize a file system identified 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 or decreased
+by the quantity \fI<size>\fR.
+If no units are specified, the unit of the \fI<size>\fR parameter is the byte.
+Optionally, the size parameter may be suffixed by one of the following the units
+designators: 'K', 'M', or 'G', kilobytes, megabytes, or gigabytes, respectively.
+
+If 'max' is passed, the filesystem will occupy all available space on the +volume(s).
+
+The \fBresize\fR command \fBdoes not\fR manipulate the size of underlying +partitions. If you wish to enlarge/reduce a filesystem, you must make sure you
+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 labels are +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
+
+\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 returned in
+case of failure.
+
+.SH AVAILABILITY
+.B btrfs
+is part of btrfs-progs. Btrfs filesystem is currently under heavy development,
+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)

Signature · 2 lines
gpg key@ keyserver.linux.it: Goffredo Baroncelli (ghigo) <[email protected]>
Key fingerprint = 4769 7E51 5293 D36C 814E  C054 BF04 F161 3DC5 0512