btrfs-progs: Convert man page for btrfs-rescue
[platform/upstream/btrfs-progs.git] / Documentation / btrfs-rescue.txt
1 btrfs-check(8)
2 ==============
3
4 NAME
5 ----
6 btrfs-rescue - Recover a damaged btrfs filesystem
7
8 SYNOPSIS
9 --------
10 'btrfs rescue' <subcommand> <args>
11
12 DESCRIPTION
13 -----------
14 'btrfs rescue' is used to try to recover a damaged btrfs filesystem.
15
16 SUBCOMMAND
17 ----------
18 'chunk-recover' [options] <device>::
19 Recover the chunk tree by scanning the devices
20 +
21 `Options`
22 +
23 -y::::
24 assume an answer of 'yes' to all questions.
25 -v::::
26 verbose mode.
27 -h::::
28 help.
29
30 NOTE: Since 'chunk-recover' will scan the whole device, it will be *VERY* slow
31 especially executed on a large device.
32
33 'super-recover' [options] <device>::
34 Recover bad superblocks from good copies.
35 +
36 `Options`
37 +
38 -y::::
39 assume an answer of 'yes' to all questions.
40 -v::::
41 verbose mode.
42
43 EXIT STATUS
44 -----------
45 'btrfs rescue' returns a zero exist status if it succeeds. Non zero is
46 returned in case of failure.
47
48 AVAILABILITY
49 ------------
50 'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
51 development,
52 and not suitable for any uses other than benchmarking and review.
53 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
54 further details.
55
56 SEE ALSO
57 --------
58 `mkfs.btrfs`(8),
59 `btrfs-scrub`(8),
60 `btrfs-check`(8)