Manpage/btrfs-restore

btrfs-restore(8)

Note: manual pages are located at read-the-docs site, please update your links.

NAME

btrfs-restore - try to restore files from a damaged btrfs filesystem image

SYNOPSIS

btrfs restore [options] <emphasis><device></emphasis> <emphasis><path></emphasis> | -l <emphasis><device></emphasis>

DESCRIPTION

btrfs restore is used to try to salvage files from a damaged filesystem and restore them into <emphasis><path></emphasis> 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:<text:line-break/> https://btrfs.wiki.kernel.org/index.php/Restore

OPTIONS

-s|--snapshots

get snapshots, btrfs restore skips snapshots in default.

-x|--xattr

get extended attributes.

-m|--metadata

restore owner, mode and times.

-S|--symlinks

restore symbolic links as well as normal files.

-v|--verbose

verbose.

-i|--ignore-errors

ignore errors.

-o|--overwrite

overwrite directories/files in <emphasis><path></emphasis>.

-t <emphasis><bytenr></emphasis>

use <emphasis><bytenr></emphasis> to read root tree.

-f <emphasis><bytenr></emphasis>

only restore files that are under specified root whose root bytenr is <emphasis><bytenr></emphasis>.

-u|--super <emphasis><mirror></emphasis>

use given superblock mirror identified by <emphasis><mirror></emphasis>, it can be 0,1,2.

-r|--root <emphasis><rootid></emphasis>

only restore files that are under specified root whose objectid is <emphasis><rootid></emphasis>.

-d

find dir.

-l|--list-roots

list tree roots.

-D|--dry-run

dry run (only list files that would be recovered).

--path-regex <emphasis><regex></emphasis>

restore only filenames matching regex, you have to use following syntax (possibly quoted):

^/(|home(|/username(|/Desktop(|/.*))))$

-c

ignore case (--path-regex only).

EXIT STATUS

btrfs restore 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-rescue(8), btrfs-check(8)