path: root/Documentation
diff options
authorQu Wenruo <>2014-04-15 15:04:49 +0800
committerDavid Sterba <>2014-04-22 14:15:25 +0200
commit01c42d908a46929e86a9354f6705f34ea12f1958 (patch)
tree61e91c38e437ad91b0e7d0363dd109f48b36938f /Documentation
parentdad1c8ba3a52afd72dd4b6d46b985dac163925bf (diff)
btrfs-progs: Convert man page for btrfs-restore.
Convert man page for btrfs-restore, which I forgot to convert in the previous patchset. :P Signed-off-by: Qu Wenruo <> Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation')
2 files changed, 73 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index a879ed37..ba54eefd 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -28,7 +28,7 @@ MAN8_TXT += btrfs-receive.txt
MAN8_TXT += btrfs-quota.txt
MAN8_TXT += btrfs-qgroup.txt
MAN8_TXT += btrfs-replace.txt
-#MAN8_TXT += btrfs-dedup.txt
+MAN8_TXT += btrfs-restore.txt
MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
diff --git a/Documentation/btrfs-restore.txt b/Documentation/btrfs-restore.txt
new file mode 100644
index 00000000..ea18ebbd
--- /dev/null
+++ b/Documentation/btrfs-restore.txt
@@ -0,0 +1,72 @@
+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 `btrfsck`(8) or `btrfs-rescue`(8) only has very limited usage,
+'btrfs restore' is normally a better choice.
+get snapshots.
+get extended attributes.
+ignore errors.
+overwrite directories/files in <path>.
+-t <location>::
+use <location> to read root tree.
+-f <offset>::
+use <offset> to read fs tree.
+-u <block>::
+use given superblock mirror identified by <block>.
+-r <rootid>::
+use <rootid> as root objectid.
+find dir.
+list tree roots.
+'btrfs restore' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+and not suitable for any uses other than benchmarking and review.
+Please refer to the btrfs wiki for
+further details.