btrfs-progs: Convert man page for mkfs.btrfs.
[platform/upstream/btrfs-progs.git] / man / btrfs-debug-tree.8.in
1 .TH BTRFS-DEBUG-TREE 8
2 .SH NAME
3 btrfs-debug-tree \- dump Btrfs filesystem metadata into stdout.
4 .SH SYNOPSIS
5 .B btrfs-debug-tree [\fIoptions\fP] \fI<device>\fP
6 .SH DESCRIPTION
7 \fBbtrfs-debug-tree\fP is used to dump the whole tree of the given device.
8 This is maybe useful for analyzing filesystem state or inconsistence and has
9 a positive educational effect on understanding the internal structure.
10 \fIdevice\fP is the device file where the filesystem is stored.
11
12 \fIOptions\fP
13 .IP "\fB-e\fP" 5
14 print detailed extents info.
15 .IP "\fB-d\fP" 5
16 print info of btrfs device and root tree dirs only.
17 .IP "\fB-r\fP" 5
18 print info of roots only.
19 .IP "\fB-b \fI<block_num>\fP" 5
20 print info of the specified block only.
21
22 .SH EXIT CODE
23 \fBbtrfs-debug-tree\fP will return 0 if no error happened.
24 If any problems happened, 1 will be returned.
25
26 .SH AUTHOR
27 Written by Shilong Wang and Wenruo Qu.
28
29 .SH COPYRIGHT
30 Copyright \(co 2013 FUJITSU LIMITED.
31 License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
32 .br
33 This is free software: you are free  to  change  and  redistribute  it. There is NO WARRANTY, to the extent permitted by law.
34 .SH SEE ALSO
35 .BR mkfs.btrfs (8)