summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-debug-tree.asciidoc
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.cz>2015-04-14 17:37:23 +0200
committerDavid Sterba <dsterba@suse.cz>2015-04-14 17:41:27 +0200
commit7ffccaf0c3b4d4979d7d74bab3d79d9541a6e665 (patch)
tree1d64b306503787588d0d79ab467b95f8c6a83c99 /Documentation/btrfs-debug-tree.asciidoc
parent32ca2fa502c0a00a7dc40adbdae2e7b7765e6d63 (diff)
btrfs-progs: Documentaion: rename to .asciidoc
A few minor benefits: * editors set highliting according to the extensions * web access to the git repository (github) renders the .asciidoc files: * we can link to them from the wiki * the files are editable via browser and such editations can be submitted for merge easily Signed-off-by: David Sterba <dsterba@suse.cz>
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)