btrfs-progs/Documentation/btrfs-restore.txt
David Sterba 7d0ac617c3 btrfs-progs: doc: update the Availability section
Does not reflect the current state. The wiki contains more details on
the first page.

Signed-off-by: David Sterba <dsterba@suse.cz>
2014-05-19 18:04:26 +02:00

75 lines
1.3 KiB
Plaintext

btrfs-restore(8)
================
NAME
----
btrfs-restore - try to restore files from a damaged btrfs filesystem(unmounted)
SYNOPSIS
--------
*btrfs restore* [options] <device> <path> | -l <device>
DESCRIPTION
-----------
*btrfs restore* is used to try to salvage files from a damaged filesystem and
restore them into <path> or just list the tree roots.
Since current `btrfs-check`(8) or `btrfs-rescue`(8) only has very limited usage,
*btrfs restore* is normally a better choice.
NOTE: It is recommended to read the following btrfs wiki page if your data is
not salvaged with default option: +
https://btrfs.wiki.kernel.org/index.php/Restore
OPTIONS
-------
-s::
get snapshots.
-x::
get extended attributes.
-v::
verbose.
-i::
ignore errors.
-o::
overwrite directories/files in <path>.
-t <location>::
use <location> to read root tree.
-f <offset>::
use <offset> to read fs tree.
-u <block>::
use given superblock mirror identified by <block>.
-r <rootid>::
use <rootid> as root objectid.
-d::
find dir.
-l::
list tree roots.
EXIT STATUS
-----------
*btrfs restore* returns a zero exist 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-rescue`(8),
`btrfs-check`(8)