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>
Signed-off-by: David Sterba <dsterba@suse.cz>
Signed-off-by: Chris Mason <chris.mason@fusionio.com>
This commit is contained in:
Wang Shilong 2013-08-14 12:29:13 +08:00 committed by David Sterba
parent af129354c0
commit 14898abe91
2 changed files with 31 additions and 1 deletions

View File

@ -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)

30
man/btrfs-find-root.8.in Normal file
View File

@ -0,0 +1,30 @@
.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 SEE ALSO
.BR mkfs.btrfs (8)