From: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
To: linux-btrfs@vger.kernel.org
Subject: [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck
Date: Thu, 1 Aug 2013 13:35:25 +0800 [thread overview]
Message-ID: <1375335334-32540-1-git-send-email-wangsl.fnst@cn.fujitsu.com> (raw)
Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
man/btrfsck.8.in | 35 ++++++++++++++++++++++++++++++-----
1 file changed, 30 insertions(+), 5 deletions(-)
diff --git a/man/btrfsck.8.in b/man/btrfsck.8.in
index 5004ba0..6087c14 100644
--- a/man/btrfsck.8.in
+++ b/man/btrfsck.8.in
@@ -1,11 +1,35 @@
.TH BTRFSCK 8
.SH NAME
-btrfsck \- check a btrfs filesystem
+btrfsck \- check and repair of a Btrfs filesystem
.SH SYNOPSIS
-.B btrfsck \fI device\fP
+.B btrfsck [\fIoptions\fP] \fI<device>\fP
.SH DESCRIPTION
-\fBbtrfsck\fP is used to check a btrfs filesystem.
-\fIdevice\fP is the device file where the filesystem is stored.
+\fBbtrfsck\fP is used to check and optionally repair of a Btrfs filesystem. Now, it can only be run on an unmounted FS. Considering it is not well-tested
+in real-life situations yet. if you have a broken Btrfs filesystem, btrfsck may not repair but cause aditional damages. \fI<device>\fP is the device file
+where the filesystem is stored.
+
+\fIOptions\fP
+.IP "\fB-s,--super \fI<superblock>\fP" 5
+specify which superblock copy that you want to use.
+.IP "\fB--repair\fP" 5
+try to repair the filesystem.
+.IP "\fB--init-csum-tree\fP" 5
+create a new CRC tree.
+.IP "\fB--init-extent-tree\fP" 5
+create a new extent tree.
+
+.SH EXIT CODE
+\fBbtrfsck\fR will return 0 exit code if no error happened.
+Other exit code means some problems happened.
+
+.SH AUTHOR
+Written by Shilong Wang and Wenruo Qu.
+
+.SH COPYRIGHT
+Copyright \(co 2013 Fujitsu, Inc.
+License GPLv3: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
.SH AVAILABILITY
.B btrfsck
is part of btrfs-progs. Btrfs is currently under heavy development,
@@ -13,4 +37,5 @@ 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.
.SH SEE ALSO
-.BR mkfs.btrfs (8)
+.BR mkfs.btrfs (8),
+.BR btrfs (8)
--
1.8.0.1
next reply other threads:[~2013-08-01 5:37 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-01 5:35 Wang Shilong [this message]
2013-08-01 5:35 ` [PATCH 02/10] Btrfs-progs: add missing man information for btrfs-debug-tree Wang Shilong
2013-08-01 5:35 ` [PATCH 03/10] Btrfs-progs: add missing man page for btrfs-show-super Wang Shilong
2013-08-01 5:35 ` [PATCH 04/10] Btrfs-progs: add man page information for btrfs-find-root Wang Shilong
2013-08-01 5:35 ` [PATCH 05/10] Btrfs-progs: add man page information for btrfs-convert Wang Shilong
2013-08-01 5:35 ` [PATCH 06/10] Btrfs-progs: add missing man page for btrfstune Wang Shilong
2013-08-01 5:35 ` [PATCH 07/10] Btrfs-progs: add missing man page information for btrfs-zero-log Wang Shilong
2013-08-01 5:35 ` [PATCH 08/10] btrfs-progs: Update usage string of btrfs-map-logical Wang Shilong
2013-08-01 5:35 ` [PATCH 09/10] btrfs-progs: Fix the return value " Wang Shilong
2013-08-06 13:48 ` David Sterba
2013-08-06 13:55 ` Wang Shilong
2013-08-01 5:35 ` [PATCH 10/10] Btrfs-progs: add missing man page for btrfs-map-logical Wang Shilong
2013-08-01 9:43 ` [PATCH 01/10] Btrfs-progs: add missing man page information for btrfsck Stefan Behrens
2013-08-06 15:13 ` David Sterba
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=1375335334-32540-1-git-send-email-wangsl.fnst@cn.fujitsu.com \
--to=wangsl.fnst@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).