From e48aac091341036c9844ce772e1114a59a146752 Mon Sep 17 00:00:00 2001 From: Wang Shilong Date: Wed, 14 Aug 2013 12:29:11 +0800 Subject: [PATCH] Btrfs-progs: add missing man information for btrfs-debug-tree Signed-off-by: Wang Shilong Signed-off-by: Qu Wenruo Signed-off-by: David Sterba Signed-off-by: Chris Mason --- man/Makefile | 3 ++- man/btrfs-debug-tree.8.in | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 man/btrfs-debug-tree.8.in diff --git a/man/Makefile b/man/Makefile index 1ba23b5c..e5c1f7cc 100644 --- a/man/Makefile +++ b/man/Makefile @@ -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) diff --git a/man/btrfs-debug-tree.8.in b/man/btrfs-debug-tree.8.in new file mode 100644 index 00000000..9b0420b4 --- /dev/null +++ b/man/btrfs-debug-tree.8.in @@ -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\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\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 . +.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)