Manpage/btrfs-restore

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(btrfs-restore(8) Manual Page: add link to git)
(Update from git, v4.2)
Line 1: Line 1:
 
 
=btrfs-restore(8) Manual Page=
 
=btrfs-restore(8) Manual Page=
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs-restore}}
 
|name=btrfs-restore}}
 
  
 
==NAME==
 
==NAME==
  
btrfs-restore - try to restore files from a damaged btrfs filesystem(unmounted)
+
btrfs-restore - try to restore files from a damaged btrfs filesystem image
  
 
==SYNOPSIS==
 
==SYNOPSIS==
Line 23: Line 21:
 
==OPTIONS==
 
==OPTIONS==
  
; -s
+
; -s|--snapshots
 
: get snapshots, btrfs restore skips snapshots in default.
 
: get snapshots, btrfs restore skips snapshots in default.
; -x
+
; -x|--xattr
 
: get extended attributes.
 
: get extended attributes.
; -v
+
; -m|--metadata
 +
: restore owner, mode and times.
 +
; -S|--symlinks
 +
: restore symbolic links as well as normal files.
 +
; -v|--verbose
 
: verbose.
 
: verbose.
; -i
+
; -i|--ignore-errors
 
: ignore errors.
 
: ignore errors.
; -o
+
; -o|--overwrite
 
: overwrite directories/files in <path>.
 
: overwrite directories/files in <path>.
 
; -t <bytenr>
 
; -t <bytenr>
Line 37: Line 39:
 
; -f <bytenr>
 
; -f <bytenr>
 
: only restore files that are under specified root whose root bytenr is <bytenr>.
 
: only restore files that are under specified root whose root bytenr is <bytenr>.
; -u <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,2.
; -r <rootid>
+
; -r|--root <rootid>
 
: only restore files that are under specified root whose objectid is <rootid>.
 
: only restore files that are under specified root whose objectid is <rootid>.
 
; -d
 
; -d
 
: find dir.
 
: find dir.
; -l
+
; -l|--list-roots
 
: list tree roots.
 
: list tree roots.
 
; -D|--dry-run
 
; -D|--dry-run
Line 50: Line 52:
 
: restore only filenames matching regex, you have to use following syntax (possibly quoted): <br /><code>^/(|home(|/username(|/Desktop(|/.*))))$</code>
 
: restore only filenames matching regex, you have to use following syntax (possibly quoted): <br /><code>^/(|home(|/username(|/Desktop(|/.*))))$</code>
 
; -c
 
; -c
: ignore case (--path-regrex only).
+
: ignore case (--path-regex only).
  
 
==EXIT STATUS==
 
==EXIT STATUS==
  
'''btrfs restore''' returns a zero exist status if it succeeds. Non zero is returned in case of failure.
+
'''btrfs restore''' returns a zero exit status if it succeeds. Non zero is returned in case of failure.
  
 
==AVAILABILITY==
 
==AVAILABILITY==
Line 63: Line 65:
  
 
[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]], [[Manpage/btrfs-rescue|btrfs-rescue(8)]], [[Manpage/btrfs-check|btrfs-check(8)]]
 
[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]], [[Manpage/btrfs-rescue|btrfs-rescue(8)]], [[Manpage/btrfs-check|btrfs-check(8)]]
 
  
 
[[Category:Manpage]]
 
[[Category:Manpage]]

Revision as of 14:55, 8 September 2015

Contents

btrfs-restore(8) Manual Page

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] <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|--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 <path>.
-t <bytenr>
use <bytenr> to read root tree.
-f <bytenr>
only restore files that are under specified root whose root bytenr is <bytenr>.
-u|--super <mirror>
use given superblock mirror identified by <mirror>, it can be 0,1,2.
-r|--root <rootid>
only restore files that are under specified root whose objectid is <rootid>.
-d
find dir.
-l|--list-roots
list tree roots.
-D|--dry-run
dry run (only list files that would be recovered).
--path-regex <regex>
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)

Personal tools