Manpage/btrfs-restore

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Update from git, v4.4)
(Update from git, v4.5.3)
Line 1: Line 1:
=btrfs-restore(8) Manual Page=
+
=btrfs-restore(8)=
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs-restore}}
 
|name=btrfs-restore}}
  
 
==NAME==
 
==NAME==
 
 
btrfs-restore - try to restore files from a damaged btrfs filesystem image
 
btrfs-restore - try to restore files from a damaged btrfs filesystem image
  
 
==SYNOPSIS==
 
==SYNOPSIS==
  
'''btrfs restore''' [options] <device> <path> | -l <device>
+
<p><b>btrfs restore</b> [options] <emphasis>&lt;device&gt;</emphasis> <emphasis>&lt;path&gt;</emphasis> | -l <emphasis>&lt;device&gt;</emphasis></p>
 
+
 
==DESCRIPTION==
 
==DESCRIPTION==
  
'''btrfs restore''' is used to try to salvage files from a damaged filesystem and restore them into &lt;path&gt; or just list the tree roots.
+
<p><b>btrfs restore</b> is used to try to salvage files from a damaged filesystem and
 +
restore them into <emphasis>&lt;path&gt;</emphasis> or just list the tree roots.</p>
 +
<p>Since current [[Manpage/btrfs-check|btrfs-check(8)]] or [[Manpage/btrfs-rescue|btrfs-rescue(8)]] only has very limited usage,
 +
<b>btrfs restore</b> is normally a better choice.</p>
 +
<blockquote><b>Note:</b>
 +
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</blockquote>
 +
==OPTIONS==
  
Since current [[Manpage/btrfs-check|btrfs-check(8)]] or [[Manpage/btrfs-rescue|btrfs-rescue(8)]] only has very limited usage, '''btrfs restore''' is normally a better choice.
+
<dl>
 +
<dt>
 +
-s|--snapshots
 +
<dd>
 +
<p>
 +
get snapshots, btrfs restore skips snapshots in default.
 +
</p>
  
'''Note:''' It is recommended to read the following btrfs wiki page if your data is not salvaged with default option:<br />https://btrfs.wiki.kernel.org/index.php/Restore
+
<dt>
 +
-x|--xattr
 +
<dd>
 +
<p>
 +
get extended attributes.
 +
</p>
  
==OPTIONS==
+
<dt>
 +
-m|--metadata
 +
<dd>
 +
<p>
 +
restore owner, mode and times.
 +
</p>
  
; -s|--snapshots
+
<dt>
: get snapshots, btrfs restore skips snapshots in default.
+
-S|--symlinks
; -x|--xattr
+
<dd>
: get extended attributes.
+
<p>
; -m|--metadata
+
restore symbolic links as well as normal files.
: restore owner, mode and times.
+
</p>
; -S|--symlinks
+
: restore symbolic links as well as normal files.
+
; -v|--verbose
+
: verbose.
+
; -i|--ignore-errors
+
: ignore errors.
+
; -o|--overwrite
+
: overwrite directories/files in &lt;path&gt;.
+
; -t &lt;bytenr&gt;
+
: use &lt;bytenr&gt; to read root tree.
+
; -f &lt;bytenr&gt;
+
: only restore files that are under specified root whose root bytenr is &lt;bytenr&gt;.
+
; -u|--super &lt;mirror&gt;
+
: use given superblock mirror identified by &lt;mirror&gt;, it can be 0,1,2.
+
; -r|--root &lt;rootid&gt;
+
: only restore files that are under specified root whose objectid is &lt;rootid&gt;.
+
; -d
+
: find dir.
+
; -l|--list-roots
+
: list tree roots.
+
; -D|--dry-run
+
: dry run (only list files that would be recovered).
+
; --path-regex &lt;regex&gt;
+
: restore only filenames matching regex, you have to use following syntax (possibly quoted): <br /><code>^/(|home(|/username(|/Desktop(|/.*))))$</code>
+
; -c
+
: ignore case (--path-regex only).
+
  
==EXIT STATUS==
+
<dt>
 +
-v|--verbose
 +
<dd>
 +
<p>
 +
verbose.
 +
</p>
  
'''btrfs restore''' returns a zero exit status if it succeeds. Non zero is returned in case of failure.
+
<dt>
 +
-i|--ignore-errors
 +
<dd>
 +
<p>
 +
ignore errors.
 +
</p>
  
==AVAILABILITY==
+
<dt>
 +
-o|--overwrite
 +
<dd>
 +
<p>
 +
overwrite directories/files in <emphasis>&lt;path&gt;</emphasis>.
 +
</p>
  
'''btrfs''' is part of btrfs-progs. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for further details.
+
<dt>
 +
-t <emphasis>&lt;bytenr&gt;</emphasis>
 +
<dd>
 +
<p>
 +
use <emphasis>&lt;bytenr&gt;</emphasis> to read root tree.
 +
</p>
  
==SEE ALSO==
+
<dt>
 +
-f <emphasis>&lt;bytenr&gt;</emphasis>
 +
<dd>
 +
<p>
 +
only restore files that are under specified root whose root bytenr is <emphasis>&lt;bytenr&gt;</emphasis>.
 +
</p>
  
[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]], [[Manpage/btrfs-rescue|btrfs-rescue(8)]], [[Manpage/btrfs-check|btrfs-check(8)]]
+
<dt>
 +
-u|--super <emphasis>&lt;mirror&gt;</emphasis>
 +
<dd>
 +
<p>
 +
use given superblock mirror identified by <emphasis>&lt;mirror&gt;</emphasis>, it can be 0,1,2.
 +
</p>
 +
 
 +
<dt>
 +
-r|--root <emphasis>&lt;rootid&gt;</emphasis>
 +
<dd>
 +
<p>
 +
only restore files that are under specified root whose objectid is <emphasis>&lt;rootid&gt;</emphasis>.
 +
</p>
 +
 
 +
<dt>
 +
-d
 +
<dd>
 +
<p>
 +
find dir.
 +
</p>
 +
 
 +
<dt>
 +
-l|--list-roots
 +
<dd>
 +
<p>
 +
list tree roots.
 +
</p>
 +
 
 +
<dt>
 +
-D|--dry-run
 +
<dd>
 +
<p>
 +
dry run (only list files that would be recovered).
 +
</p>
 +
 
 +
<dt>
 +
--path-regex <emphasis>&lt;regex&gt;</emphasis>
 +
<dd>
 +
<p>
 +
restore only filenames matching regex, you have to use following syntax (possibly quoted):
 +
</p>
 +
<p><tt>^/(|home(|/username(|/Desktop(|/.*))))$</tt></p>
 +
 
 +
<dt>
 +
-c
 +
<dd>
 +
<p>
 +
ignore case (--path-regex only).
 +
</p>
 +
 
 +
</dl>
 +
==EXIT STATUS==
 +
 
 +
<p><b>btrfs restore</b> returns a zero exit status if it succeeds. Non zero is
 +
returned in case of failure.</p>
 +
==AVAILABILITY==
 +
 
 +
<p><b>btrfs</b> is part of btrfs-progs.
 +
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 +
further details.</p>
 +
==SEE ALSO==
  
 +
<p>[[Manpage/mkfs.btrfs|mkfs.btrfs(8)]],
 +
[[Manpage/btrfs-rescue|btrfs-rescue(8)]],
 +
[[Manpage/btrfs-check|btrfs-check(8)]]</p>
 
[[Category:Manpage]]
 
[[Category:Manpage]]

Revision as of 10:10, 20 May 2016

Contents

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)

Personal tools