Btrfs-progs: add missing man information for btrfs-debug-tree

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>
master
Wang Shilong 2013-08-14 12:29:11 +08:00 committed by David Sterba
parent e9c0fe428e
commit e48aac0913
2 changed files with 37 additions and 1 deletions

View File

@ -11,7 +11,8 @@ man8dir = $(mandir)/man8
# list only those we use
.SUFFIXES: .in .gz
MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz
MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
btrfs-debug-tree.8.gz
INFILES = ${MANPAGES:.in=.gz}
all: $(MANPAGES)

View File

@ -0,0 +1,35 @@
.TH BTRFS-DEBUG-TREE 8
.SH NAME
btrfs-debug-tree \- dump Btrfs filesystem metadata into stdout.
.SH SYNOPSIS
.B btrfs-debug-tree [\fIoptions\fP] \fI<device>\fP
.SH DESCRIPTION
\fBbtrfs-debug-tree\fP is used to dump the whole tree of the given device.
This is maybe useful for analyzing filesystem state or inconsistence and has
a positive educational effect on understanding the internal structure.
\fIdevice\fP is the device file where the filesystem is stored.
\fIOptions\fP
.IP "\fB-e\fP" 5
print detailed extents info.
.IP "\fB-d\fP" 5
print info of btrfs device and root tree dirs only.
.IP "\fB-r\fP" 5
print info of roots only.
.IP "\fB-b \fI<block_num>\fP" 5
print info of the specified block only.
.SH EXIT CODE
\fBbtrfs-debug-tree\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)