summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-rescue.txt
diff options
context:
space:
mode:
authorQu Wenruo <quwenruo@cn.fujitsu.com>2014-04-02 16:29:19 +0800
committerDavid Sterba <dsterba@suse.cz>2014-04-22 14:15:21 +0200
commit9184296d9dacba104d2521b6ee4068b7e671f6a2 (patch)
treea8723826244ac8225d50ccdf6af6ffab3641153e /Documentation/btrfs-rescue.txt
parente3cd48c751e97b54fcd732c15861e6316e661657 (diff)
btrfs-progs: Convert man page for btrfs-rescue
Convert man page for btrfs-rescue. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-rescue.txt')
-rw-r--r--Documentation/btrfs-rescue.txt60
1 files changed, 60 insertions, 0 deletions
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-check(8)
+==============
+
+NAME
+----
+btrfs-rescue - Recover a damaged btrfs filesystem
+
+SYNOPSIS
+--------
+'btrfs rescue' <subcommand> <args>
+
+DESCRIPTION
+-----------
+'btrfs rescue' is used to try to recover a damaged btrfs filesystem.
+
+SUBCOMMAND
+----------
+'chunk-recover' [options] <device>::
+Recover the chunk tree by scanning the devices
++
+`Options`
++
+-y::::
+assume an answer of 'yes' to all questions.
+-v::::
+verbose mode.
+-h::::
+help.
+
+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.
++
+`Options`
++
+-y::::
+assume an answer of 'yes' to all questions.
+-v::::
+verbose mode.
+
+EXIT STATUS
+-----------
+'btrfs rescue' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+
+AVAILABILITY
+------------
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+development,
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
+further details.
+
+SEE ALSO
+--------
+`mkfs.btrfs`(8),
+`btrfs-scrub`(8),
+`btrfs-check`(8)