summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/Makefile2
-rw-r--r--Documentation/btrfs-find-root.txt45
2 files changed, 46 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 42a4bb1c..03a37876 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -5,7 +5,7 @@ MAN8_TXT =
MAN8_TXT += btrfs.txt
MAN8_TXT += btrfs-convert.txt
MAN8_TXT += btrfs-debug-tree.txt
-#MAN8_TXT += btrfs-find-root.txt
+MAN8_TXT += btrfs-find-root.txt
#MAN8_TXT += btrfs-image.txt
#MAN8_TXT += btrfs-map-logical.txt
#MAN8_TXT += btrfs-show-super.txt
diff --git a/Documentation/btrfs-find-root.txt b/Documentation/btrfs-find-root.txt
new file mode 100644
index 00000000..18b1e845
--- /dev/null
+++ b/Documentation/btrfs-find-root.txt
@@ -0,0 +1,45 @@
+btrfs-find-root(8)
+==================
+
+NAME
+----
+btrfs-find-root - filter to find btrfs root
+
+SYNOPSIS
+--------
+'btrfs-find-root' [options] <dev>
+
+DESCRIPTION
+-----------
+'btrfs-find-root' is used to find the satisfied root, you can filter by
+root tree's objectid, generation, level.
+
+OPTIONS
+-------
+-g <generation>::
+Filter root tree by it's original transaction id, tree root's generation in default.
+-o <objectid>::
+Filter root tree by it's objectid,tree root's objectid in default.
+-l <level>::
+Filter root tree by B-+ tree's level, level 0 in default.
+
+EXIT STATUS
+-----------
+'btrfs-find-root' 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 <http://gnu.org/licenses/gpl.html>.
+
+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)