forked from Mirrors/btrfs-progs
btrfs-progs: docs: update btrfs-restore manual page
Signed-off-by: David Sterba <dsterba@suse.com>master
parent
81b427afcf
commit
b8288277fb
|
@ -12,10 +12,22 @@ SYNOPSIS
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
*btrfs restore* is used to try to salvage files from a damaged filesystem and
|
*btrfs restore* is used to try to salvage files from a damaged filesystem and
|
||||||
restore them into <path> or just list the tree roots.
|
restore them into <path> or just list the subvolume tree roots. The filesystem
|
||||||
|
image is not modified.
|
||||||
|
|
||||||
Since current `btrfs-check`(8) or `btrfs-rescue`(8) only has very limited usage,
|
If the filesystem is damaged and cannot be repaired by the other tools
|
||||||
*btrfs restore* is normally a better choice.
|
(`btrfs-check`(8) or `btrfs-rescue`(8)), *btrfs restore* could be used to
|
||||||
|
retrieve file data, as far as the metadata are readable. The checks done by
|
||||||
|
restore are less strict and the process is usually able to get far enough to
|
||||||
|
retrieve data from the whole filesystem. This comes at a cost that some data
|
||||||
|
might be incomplete or from older versions if they're available.
|
||||||
|
|
||||||
|
There are several options to attempt restoration of various file metadata type.
|
||||||
|
You can try a dry run first to see how well the process goes and use further
|
||||||
|
options to extend the set of restored metadata.
|
||||||
|
|
||||||
|
For images with damaged tree structures, there are several options to point the
|
||||||
|
process to some spare copy.
|
||||||
|
|
||||||
NOTE: It is recommended to read the following btrfs wiki page if your data is
|
NOTE: It is recommended to read the following btrfs wiki page if your data is
|
||||||
not salvaged with default option: +
|
not salvaged with default option: +
|
||||||
|
@ -24,54 +36,59 @@ https://btrfs.wiki.kernel.org/index.php/Restore
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
-s|--snapshots::
|
-s|--snapshots::
|
||||||
get snapshots, btrfs restore skips snapshots in default.
|
get also snapshots that are skippped by default
|
||||||
|
|
||||||
-x|--xattr::
|
-x|--xattr::
|
||||||
get extended attributes.
|
get extended attributes
|
||||||
|
|
||||||
-m|--metadata::
|
-m|--metadata::
|
||||||
restore owner, mode and times.
|
restore owner, mode and times for files and directories
|
||||||
|
|
||||||
-S|--symlinks::
|
-S|--symlinks::
|
||||||
restore symbolic links as well as normal files.
|
restore symbolic links as well as normal files
|
||||||
|
|
||||||
-v|--verbose::
|
-v|--verbose::
|
||||||
verbose.
|
be verbose and print what is being restored
|
||||||
|
|
||||||
-i|--ignore-errors::
|
-i|--ignore-errors::
|
||||||
ignore errors.
|
ignore errors during restoration and continue
|
||||||
|
|
||||||
-o|--overwrite::
|
-o|--overwrite::
|
||||||
overwrite directories/files in <path>.
|
overwrite directories/files in <path>, eg. for repeated runs
|
||||||
|
|
||||||
-t <bytenr>::
|
-t <bytenr>::
|
||||||
use <bytenr> to read root tree.
|
use <bytenr> to read the root tree
|
||||||
|
|
||||||
-f <bytenr>::
|
-f <bytenr>::
|
||||||
only restore files that are under specified root whose root bytenr is <bytenr>.
|
only restore files that are under specified subvolume root pointed by <bytenr>
|
||||||
|
|
||||||
-u|--super <mirror>::
|
-u|--super <mirror>::
|
||||||
use given superblock mirror identified by <mirror>, it can be 0,1,2.
|
use given superblock mirror identified by <mirror>, it can be 0,1 or 2
|
||||||
|
|
||||||
-r|--root <rootid>::
|
-r|--root <rootid>::
|
||||||
only restore files that are under specified root whose objectid is <rootid>.
|
only restore files that are under a specified subvolume whose objectid is <rootid>
|
||||||
|
|
||||||
-d::
|
-d::
|
||||||
find dir.
|
find directory
|
||||||
|
|
||||||
-l|--list-roots::
|
-l|--list-roots::
|
||||||
list tree roots.
|
list subvolume tree roots, can be used as argument for '-r'
|
||||||
|
|
||||||
-D|--dry-run::
|
-D|--dry-run::
|
||||||
dry run (only list files that would be recovered).
|
dry run (only list files that would be recovered)
|
||||||
|
|
||||||
--path-regex <regex>::
|
--path-regex <regex>::
|
||||||
restore only filenames matching regex, you have to use following syntax (possibly quoted):
|
restore only filenames matching a regular expression (`regex`(7)) with a
|
||||||
|
mandatory format
|
||||||
+
|
+
|
||||||
+^/(|home(|/username(|/Desktop(|/.*))))$+
|
+^/(|home(|/username(|/Desktop(|/.*))))$+
|
||||||
|
+
|
||||||
|
The format is not very comfortable and restores all files in the directories
|
||||||
|
in the whole path, so this is not useful for restoring single file in a deep
|
||||||
|
hierarchy.
|
||||||
|
|
||||||
-c::
|
-c::
|
||||||
ignore case (--path-regex only).
|
ignore case (--path-regex only)
|
||||||
|
|
||||||
EXIT STATUS
|
EXIT STATUS
|
||||||
-----------
|
-----------
|
||||||
|
|
Loading…
Reference in New Issue