path: root/Documentation/btrfs-restore.asciidoc
diff options
authorDavid Sterba <>2015-04-14 17:37:23 +0200
committerDavid Sterba <>2015-04-14 17:41:27 +0200
commit7ffccaf0c3b4d4979d7d74bab3d79d9541a6e665 (patch)
tree1d64b306503787588d0d79ab467b95f8c6a83c99 /Documentation/btrfs-restore.asciidoc
parent32ca2fa502c0a00a7dc40adbdae2e7b7765e6d63 (diff)
btrfs-progs: Documentaion: rename to .asciidoc
A few minor benefits: * editors set highliting according to the extensions * web access to the git repository (github) renders the .asciidoc files: * we can link to them from the wiki * the files are editable via browser and such editations can be submitted for merge easily Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation/btrfs-restore.asciidoc')
1 files changed, 85 insertions, 0 deletions
diff --git a/Documentation/btrfs-restore.asciidoc b/Documentation/btrfs-restore.asciidoc
new file mode 100644
index 00000000..20fc366a
--- /dev/null
+++ b/Documentation/btrfs-restore.asciidoc
@@ -0,0 +1,85 @@
+btrfs-restore - try to restore files from a damaged btrfs filesystem(unmounted)
+*btrfs restore* [options] <device> <path> | -l <device>
+*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: +
+get snapshots, btrfs restore skips snapshots in default.
+get extended attributes.
+ignore errors.
+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 <mirror>::
+use given superblock mirror identified by <mirror>, it can be 0,1,2.
+-r <rootid>::
+only restore files that are under specified root whose objectid is <rootid>.
+find dir.
+list tree roots.
+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):
+ignore case (--path-regrex only).
+*btrfs restore* returns a zero exit status if it succeeds. Non zero is
+returned in case of failure.
+*btrfs* is part of btrfs-progs.
+Please refer to the btrfs wiki for
+further details.