summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-debug-tree.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/btrfs-debug-tree.asciidoc')
-rw-r--r--Documentation/btrfs-debug-tree.asciidoc38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/btrfs-debug-tree.asciidoc b/Documentation/btrfs-debug-tree.asciidoc
new file mode 100644
index 00000000..23fc1156
--- /dev/null
+++ b/Documentation/btrfs-debug-tree.asciidoc
@@ -0,0 +1,38 @@
+btrfs-debug-tree(8)
+===================
+
+NAME
+----
+btrfs-debug-tree - dump btrfs filesystem metadata into stdout
+
+SYNOPSIS
+--------
+*btrfs-debug-tree* [options] <device>
+
+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.
+<device> 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 <block_num>::
+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.
+
+SEE ALSO
+--------
+`mkfs.btrfs`(8)