Wang Shilong
2013-Aug-07 08:30 UTC
[patch v2 resend 4/8] Btrfs-progs: add man page information for btrfs-find-root
Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
V1->V2: GPLv3->GPLv2
Thanks to Stefan Behrens
---
man/Makefile | 2 +-
man/btrfs-find-root.8.in | 36 ++++++++++++++++++++++++++++++++++++
2 files changed, 37 insertions(+), 1 deletion(-)
create mode 100644 man/btrfs-find-root.8.in
diff --git a/man/Makefile b/man/Makefile
index b1d3645..3d2e3ba 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -12,7 +12,7 @@ man8dir = $(mandir)/man8
.SUFFIXES: .in .gz
MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
- btrfs-debug-tree.8.gz btrfs-show-super.8.gz
+ btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz
INFILES = ${MANPAGES:.in=.gz}
all: $(MANPAGES)
diff --git a/man/btrfs-find-root.8.in b/man/btrfs-find-root.8.in
new file mode 100644
index 0000000..966bd33
--- /dev/null
+++ b/man/btrfs-find-root.8.in
@@ -0,0 +1,36 @@
+.TH BTRFS-FIND-ROOT 8
+.SH NAME
+btrfs-find-root \- filter to find btrfs root.
+.SH SYNOPSIS
+.B btrfs-find-root [\fIoptions\fP] \fI<dev>\fP
+.SH DESCRIPTION
+\fBbtrfs-find-root\fP is used to find the satisfied root, you can filter by
root tree''s objectid, generation, level.
+
+\fIOptions\fP
+.IP "\fB-g \fI<generation>\fP" 5
+filter root tree by it''s original transaction id, tree root''s
generation in default.
+.IP "\fB-o \fI<objectid>\fP" 5
+filter root tree by it''s objectid,tree root''s objectid in
default.
+.IP "\fB-l \fI<level>\fP" 5
+filter root tree by B-+ tree''s level, level 0 in default.
+
+.SH EXIT CODE
+\fBbtrfs-find-root\fP will return 0 if no error happened.
+If any problems happened, 1 will be returned.
+
+.SH AUTHOR
+Written by Shilong Wang and Wenruo Qu.
+
+.SH COPYRIGHT
+Copyright \(co 2013 Fujitsu, Inc.
+License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it. There
is NO WARRANTY, to the extent permitted by law.
+.SH AVAILABILITY
+.B btrfs-find-root
+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 mkfs.btrfs (8)
--
1.8.0.1
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html