summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-rescue.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-rescue.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-rescue.asciidoc')
-rw-r--r--Documentation/btrfs-rescue.asciidoc58
1 files changed, 58 insertions, 0 deletions
diff --git a/Documentation/btrfs-rescue.asciidoc b/Documentation/btrfs-rescue.asciidoc
new file mode 100644
index 00000000..e0acf091
--- /dev/null
+++ b/Documentation/btrfs-rescue.asciidoc
@@ -0,0 +1,58 @@
+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 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-scrub`(8),
+`btrfs-check`(8)