Add btrfs-show man page
authorPeng Tao <bergwolf@gmail.com>
Wed, 3 Jun 2009 16:00:20 +0000 (12:00 -0400)
committerChris Mason <chris.mason@oracle.com>
Wed, 3 Jun 2009 16:15:40 +0000 (12:15 -0400)
Signed-off-by: Peng Tao <bergwolf@gmail.com>
Signed-off-by: Chris Mason <chris.mason@oracle.com>
man/Makefile
man/btrfs-show.8.in [new file with mode: 0644]

index b7a7340..4e8893b 100644 (file)
@@ -6,7 +6,8 @@ bindir = $(prefix)/bin
 mandir = $(prefix)/man
 man8dir = $(mandir)/man8
 
-MANPAGES = mkfs.btrfs.8.gz btrfsctl.8.gz btrfsck.8.gz btrfs-image.8.gz
+MANPAGES = mkfs.btrfs.8.gz btrfsctl.8.gz btrfsck.8.gz btrfs-image.8.gz \
+          btrfs-show.8.gz
 
 all: $(MANPAGES)
 
@@ -22,6 +23,9 @@ btrfsck.8.gz: btrfsck.8.in
 btrfs-image.8.gz: btrfs-image.8.in
        $(GZIP) -n -c btrfs-image.8.in > btrfs-image.8.gz
 
+btrfs-show.8.gz: btrfs-show.8.in
+       $(GZIP) -n -c btrfs-show.8.in > btrfs-show.8.gz
+
 clean :
        rm -f $(MANPAGES)
 
diff --git a/man/btrfs-show.8.in b/man/btrfs-show.8.in
new file mode 100644 (file)
index 0000000..cd341fc
--- /dev/null
@@ -0,0 +1,19 @@
+.TH MKFS.BTRFS 8
+.SH NAME
+btrfs-show \- scan the /dev directory for btrfs partitions and print results.
+.SH SYNOPSIS
+.B btrfs-show
+.SH DESCRIPTION
+.B btrfs-show
+is used to scan the /dev directory for btrfs partitions and display brief
+information such as lable, uuid, etc of each btrfs partition.
+.SH OPTIONS
+none
+.SH AVAILABILITY
+.B btrfs-show
+is part of btrfs-progs. Btrfs 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 btrfsck (8), btrfsctl (8), mkfs.btrfs (8), btrfs-image (8)