diff options
authorQu Wenruo <>2014-04-02 16:29:19 +0800
committerDavid Sterba <>2014-04-22 14:15:21 +0200
commit9184296d9dacba104d2521b6ee4068b7e671f6a2 (patch)
parente3cd48c751e97b54fcd732c15861e6316e661657 (diff)
btrfs-progs: Convert man page for btrfs-rescue
Convert man page for btrfs-rescue. Signed-off-by: Qu Wenruo <> Signed-off-by: David Sterba <>
2 files changed, 61 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index a838ca1d..ebe04553 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -22,7 +22,7 @@ MAN8_TXT += btrfs-balance.txt
MAN8_TXT += btrfs-device.txt
MAN8_TXT += btrfs-scrub.txt
MAN8_TXT += btrfs-check.txt
-#MAN8_TXT += btrfs-rescue.txt
+MAN8_TXT += btrfs-rescue.txt
#MAN8_TXT += btrfs-inspect-internal.txt
#MAN8_TXT += btrfs-send.txt
#MAN8_TXT += btrfs-receive.txt
diff --git a/Documentation/btrfs-rescue.txt b/Documentation/btrfs-rescue.txt
new file mode 100644
index 00000000..f66ca856
--- /dev/null
+++ b/Documentation/btrfs-rescue.txt
@@ -0,0 +1,60 @@
+btrfs-rescue - Recover a damaged btrfs filesystem
+'btrfs rescue' <subcommand> <args>
+'btrfs rescue' is used to try to recover a damaged btrfs filesystem.
+'chunk-recover' [options] <device>::
+Recover the chunk tree by scanning the devices
+assume an answer of 'yes' to all questions.
+verbose mode.
+NOTE: Since 'chunk-recover' will scan the whole device, it will be *VERY* slow
+especially executed on a large device.
+'super-recover' [options] <device>::
+Recover bad superblocks from good copies.
+assume an answer of 'yes' to all questions.
+verbose mode.
+'btrfs rescue' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki for
+further details.