Manpage/btrfs-restore

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Update from git, v4.5.3)
(Update from git, v4.5.3)
Line 1: Line 1:
=btrfs-restore(8)=
+
=btrfs-restore(8) manual page=
 
{{GeneratedManpage
 
{{GeneratedManpage
 
|name=btrfs-restore}}
 
|name=btrfs-restore}}
Line 8: Line 8:
 
==SYNOPSIS==
 
==SYNOPSIS==
  
<p><b>btrfs restore</b> [options] <emphasis>&lt;device&gt;</emphasis> <emphasis>&lt;path&gt;</emphasis> | -l <emphasis>&lt;device&gt;</emphasis></p>
+
<p><b>btrfs restore</b> [options] <em>&lt;device&gt;</em> <em>&lt;path&gt;</em> | -l <em>&lt;device&gt;</em></p>
 
==DESCRIPTION==
 
==DESCRIPTION==
  
 
<p><b>btrfs restore</b> is used to try to salvage files from a damaged filesystem and
 
<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>
+
restore them into <em>&lt;path&gt;</em> 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,
 
<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>
 
<b>btrfs restore</b> is normally a better choice.</p>
 
<blockquote><b>Note:</b>
 
<blockquote><b>Note:</b>
 
It is recommended to read the following btrfs wiki page if your data is
 
It is recommended to read the following btrfs wiki page if your data is
not salvaged with default option:<text:line-break/>
+
not salvaged with default option:<br/>
 
https://btrfs.wiki.kernel.org/index.php/Restore</blockquote>
 
https://btrfs.wiki.kernel.org/index.php/Restore</blockquote>
 
==OPTIONS==
 
==OPTIONS==
Line 68: Line 68:
 
<dd>
 
<dd>
 
<p>
 
<p>
overwrite directories/files in <emphasis>&lt;path&gt;</emphasis>.
+
overwrite directories/files in <em>&lt;path&gt;</em>.
 
</p>
 
</p>
  
 
<dt>
 
<dt>
-t <emphasis>&lt;bytenr&gt;</emphasis>
+
-t <em>&lt;bytenr&gt;</em>
 
<dd>
 
<dd>
 
<p>
 
<p>
use <emphasis>&lt;bytenr&gt;</emphasis> to read root tree.
+
use <em>&lt;bytenr&gt;</em> to read root tree.
 
</p>
 
</p>
  
 
<dt>
 
<dt>
-f <emphasis>&lt;bytenr&gt;</emphasis>
+
-f <em>&lt;bytenr&gt;</em>
 
<dd>
 
<dd>
 
<p>
 
<p>
only restore files that are under specified root whose root bytenr is <emphasis>&lt;bytenr&gt;</emphasis>.
+
only restore files that are under specified root whose root bytenr is <em>&lt;bytenr&gt;</em>.
 
</p>
 
</p>
  
 
<dt>
 
<dt>
-u|--super <emphasis>&lt;mirror&gt;</emphasis>
+
-u|--super <em>&lt;mirror&gt;</em>
 
<dd>
 
<dd>
 
<p>
 
<p>
use given superblock mirror identified by <emphasis>&lt;mirror&gt;</emphasis>, it can be 0,1,2.
+
use given superblock mirror identified by <em>&lt;mirror&gt;</em>, it can be 0,1,2.
 
</p>
 
</p>
  
 
<dt>
 
<dt>
-r|--root <emphasis>&lt;rootid&gt;</emphasis>
+
-r|--root <em>&lt;rootid&gt;</em>
 
<dd>
 
<dd>
 
<p>
 
<p>
only restore files that are under specified root whose objectid is <emphasis>&lt;rootid&gt;</emphasis>.
+
only restore files that are under specified root whose objectid is <em>&lt;rootid&gt;</em>.
 
</p>
 
</p>
  
Line 121: Line 121:
  
 
<dt>
 
<dt>
--path-regex <emphasis>&lt;regex&gt;</emphasis>
+
--path-regex <em>&lt;regex&gt;</em>
 
<dd>
 
<dd>
 
<p>
 
<p>

Revision as of 10:36, 20 May 2016

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