linux-btrfs.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Qu Wenruo <quwenruo@cn.fujitsu.com>
To: <linux-btrfs@vger.kernel.org>
Subject: [PATCH 1/4] btrfs-progs: Convert man page for btrfs-restore.
Date: Tue, 15 Apr 2014 15:04:49 +0800	[thread overview]
Message-ID: <1397545492-3054-1-git-send-email-quwenruo@cn.fujitsu.com> (raw)

Convert man page for btrfs-restore, which I forgot to convert in the
previous patchset. :P

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
 Documentation/Makefile          |  1 +
 Documentation/btrfs-restore.txt | 72 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+)
 create mode 100644 Documentation/btrfs-restore.txt

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 97a775a..dfacb93 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -30,6 +30,7 @@ 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_TXT = $(MAN8_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 0000000..ea18ebb
--- /dev/null
+++ b/Documentation/btrfs-restore.txt
@@ -0,0 +1,72 @@
+btrfs-restore(8)
+================
+
+NAME
+----
+btrfs-restore - try to restore files from a damaged btrfs filesystem(unmounted)
+
+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 `btrfsck`(8) or `btrfs-rescue`(8) only has very limited usage,
+'btrfs restore' is normally a better choice.
+
+OPTIONS
+-------
+-s::
+get snapshots.
+
+-x::
+get extended attributes.
+
+-v::
+verbose.
+
+-i::
+ignore errors.
+
+-o::
+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.
+
+-d::
+find dir.
+
+-l::
+list tree roots.
+
+EXIT STATUS
+-----------
+'btrfs restore' returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+
+AVAILABILITY
+------------
+'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+development,
+and not suitable for any uses other than benchmarking and review.
+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)
-- 
1.9.2


             reply	other threads:[~2014-04-15  7:03 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-15  7:04 Qu Wenruo [this message]
2014-04-15  7:04 ` [PATCH 2/4] btrfs-progs: Convert man page for btrfs-property Qu Wenruo
2014-04-15  7:04 ` [PATCH 3/4] btrfs-progs: Add btrfs wiki reference to man pages Qu Wenruo
2014-04-15 16:55   ` David Sterba
2014-04-15  7:04 ` [PATCH 4/4] btrfs-progs: Fix the return value when executing 'btrfs pro get' on a uncompress file Qu Wenruo
2014-04-15  9:09   ` Filipe David Manana
2014-04-15  9:15     ` Qu Wenruo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1397545492-3054-1-git-send-email-quwenruo@cn.fujitsu.com \
    --to=quwenruo@cn.fujitsu.com \
    --cc=linux-btrfs@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).