From e7a2edd1b693e4dbe17309f9ac1782a0eefbd653 Mon Sep 17 00:00:00 2001 From: Qu Wenruo Date: Wed, 2 Apr 2014 16:29:29 +0800 Subject: [PATCH] btrfs-progs: Convert man page for btrfs-debug-tree. Convert man page for btrfs-debug-tree. Signed-off-by: Qu Wenruo Signed-off-by: David Sterba --- Documentation/Makefile | 2 +- Documentation/btrfs-debug-tree.txt | 50 ++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 Documentation/btrfs-debug-tree.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index a4e4131d..42a4bb1c 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -4,7 +4,7 @@ MAN8_TXT = # Top level commands MAN8_TXT += btrfs.txt MAN8_TXT += btrfs-convert.txt -#MAN8_TXT += btrfs-debug-tree.txt +MAN8_TXT += btrfs-debug-tree.txt #MAN8_TXT += btrfs-find-root.txt #MAN8_TXT += btrfs-image.txt #MAN8_TXT += btrfs-map-logical.txt diff --git a/Documentation/btrfs-debug-tree.txt b/Documentation/btrfs-debug-tree.txt new file mode 100644 index 00000000..80a85d44 --- /dev/null +++ b/Documentation/btrfs-debug-tree.txt @@ -0,0 +1,50 @@ +btrfs-debug-tree(8) +=================== + +NAME +---- +btrfs-debug-tree - dump btrfs filesystem metadata into stdout + +SYNOPSIS +-------- +'btrfs-debug-tree' [options] + +DESCRIPTION +----------- +'btrfs-debug-tree' 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. + is the device file where the filesystem is stored. + +OPTIONS +------- +-e:: +Print detailed extents info. +-d:: +Print info of btrfs device and root tree dirs only. +-r:: +Print info of roots only. +-b :: +Print info of the specified block only. + +EXIT STATUS +----------- +'btrfs-debug-tree' will return 0 if no error happened. +If any problems happened, 1 will be returned. + +AUTHOR +------ +Written by Shilong Wang and Wenruo Qu. + +COPYRIGHT +--------- +Copyright (C) 2013 FUJITSU LIMITED. + +License GPLv2: GNU GPL version 2 . + +This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. + +SEE ALSO +-------- +`mkfs.btrfs`(8)