All of lore.kernel.org
 help / color / mirror / Atom feed
From: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
To: linux-btrfs@vger.kernel.org
Cc: dsterba@suse.cz
Subject: [PATCH v3 1/8] Btrfs-progs: add missing man page information for btrfsck
Date: Wed, 14 Aug 2013 12:29:10 +0800	[thread overview]
Message-ID: <1376454557-3041-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>
---
v2->v3: availiable parts is not true anymore,remove it.
v1->v2: remove wrong copyrights.
---
 man/btrfsck.8.in | 35 ++++++++++++++++++++++++-----------
 1 file changed, 24 insertions(+), 11 deletions(-)

diff --git a/man/btrfsck.8.in b/man/btrfsck.8.in
index 5004ba0..bf65e3c 100644
--- a/man/btrfsck.8.in
+++ b/man/btrfsck.8.in
@@ -1,16 +1,29 @@
 .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.
-.SH AVAILABILITY
-.B btrfsck
-is part of btrfs-progs. Btrfs 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.
+\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.
+
+.br
+This is free software: you are free  to  change  and  redistribute  it. There is NO WARRANTY, to the extent permitted by law.
 .SH SEE ALSO
-.BR mkfs.btrfs (8)
+.BR mkfs.btrfs (8),
+.BR btrfs (8)
-- 
1.8.0.1


             reply	other threads:[~2013-08-14  4:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-14  4:29 Wang Shilong [this message]
2013-08-14  4:29 ` [PATCH v3 2/8] Btrfs-progs: add missing man information for btrfs-debug-tree Wang Shilong
2013-08-14  4:29 ` [PATCH v3 3/8] Btrfs-progs: add missing man page for btrfs-show-super Wang Shilong
2013-08-14  4:29 ` [PATCH v3 4/8] Btrfs-progs: add man page information for btrfs-find-root Wang Shilong
2013-08-14  4:29 ` [PATCH v3 5/8] Btrfs-progs: add man page information for btrfs-convert Wang Shilong
2013-08-14  4:29 ` [PATCH v3 6/8] Btrfs-progs: add missing man page for btrfstune Wang Shilong
2013-08-14  4:29 ` [PATCH v3 7/8] Btrfs-progs: add missing man page information for btrfs-zero-log Wang Shilong
2013-08-14  4:29 ` [PATCH v3 8/8] Btrfs-progs: add missing man page for btrfs-map-logical Wang Shilong
2013-08-30 15:58 ` [PATCH v3 1/8] Btrfs-progs: add missing man page information for btrfsck 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=1376454557-3041-1-git-send-email-wangsl.fnst@cn.fujitsu.com \
    --to=wangsl.fnst@cn.fujitsu.com \
    --cc=dsterba@suse.cz \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.