summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-inspect-internal.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-inspect-internal.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-inspect-internal.asciidoc')
-rw-r--r--Documentation/btrfs-inspect-internal.asciidoc67
1 files changed, 67 insertions, 0 deletions
diff --git a/Documentation/btrfs-inspect-internal.asciidoc b/Documentation/btrfs-inspect-internal.asciidoc
new file mode 100644
index 00000000..9f6ffac8
--- /dev/null
+++ b/Documentation/btrfs-inspect-internal.asciidoc
@@ -0,0 +1,67 @@
+btrfs-inspect-internal(8)
+=========================
+
+NAME
+----
+btrfs-inspect-internal - resolve different btrfs items for debug purpose
+
+SYNOPSIS
+--------
+*btrfs inspect-internal* <subcommand> <args>
+
+DESCRIPTION
+-----------
+*btrfs inspect-internal* is used to resolve different items for debug purpose.
+
+SUBCOMMAND
+----------
+*inode-resolve* [-v] <inode> <path>::
+Resolves an <inode> in subvolume <path> to all filesystem paths.
++
+`Options`
++
+-v::::
+verbose mode. print count of returned paths and ioctl() return value
+
+*logical-resolve* [-Pv] [-s <bufsize>] <logical> <path>::
+Resolves a <logical> address in the filesystem mounted at <path> to all inodes.
++
+By default, each inode is then resolved to a file system path (similar to the
+inode-resolve subcommand).
++
+`Options`
++
+-P::::
+skip the path resolving and print the inodes instead
+-v::::
+verbose mode. print count of returned paths and all ioctl() return values
+-s <bufsize>::::
+set inode container's size.
++
+This is used to increase inode container's size in case it is
+not enough to read all the resolved results. The max value one can set is 64k.
+
+*rootid* <path>::
+For a given file or directory, return the containing tree root id. For a
+subvolume return it's own tree id.
++
+The result is undefined for the so-called empty subvolumes (identified by inode number 2).
+
+*subvolid-resolve* <subvolid> <path>::
+Get file system paths for the given subvolume ID.
+
+EXIT STATUS
+-----------
+*btrfs inspect-internal* returns a zero exit status if it succeeds. Non zero is
+returned in case of failure.
+
+AVAILABILITY
+------------
+*btrfs* is part of btrfs-progs.
+Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
+further details.
+
+SEE ALSO
+--------
+`mkfs.btrfs`(8),
+`btrfs-debug-tree`(8)