From patchwork Thu Aug 1 05:35:25 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wang Shilong X-Patchwork-Id: 2836743 Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id E00D09F7D6 for ; Thu, 1 Aug 2013 05:37:06 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 09D45200FF for ; Thu, 1 Aug 2013 05:37:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id E89E7200F7 for ; Thu, 1 Aug 2013 05:37:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753663Ab3HAFhB (ORCPT ); Thu, 1 Aug 2013 01:37:01 -0400 Received: from cn.fujitsu.com ([222.73.24.84]:52312 "EHLO song.cn.fujitsu.com" rhost-flags-OK-FAIL-OK-OK) by vger.kernel.org with ESMTP id S1753165Ab3HAFhA (ORCPT ); Thu, 1 Aug 2013 01:37:00 -0400 X-IronPort-AV: E=Sophos;i="4.89,791,1367942400"; d="scan'208";a="8084168" Received: from unknown (HELO tang.cn.fujitsu.com) ([10.167.250.3]) by song.cn.fujitsu.com with ESMTP; 01 Aug 2013 13:33:56 +0800 Received: from fnstmail02.fnst.cn.fujitsu.com (tang.cn.fujitsu.com [127.0.0.1]) by tang.cn.fujitsu.com (8.14.3/8.13.1) with ESMTP id r715avKO009257 for ; Thu, 1 Aug 2013 13:36:57 +0800 Received: from localhost.localdomain ([10.167.226.104]) by fnstmail02.fnst.cn.fujitsu.com (Lotus Domino Release 8.5.3) with ESMTP id 2013080113344348-317036 ; Thu, 1 Aug 2013 13:34:43 +0800 From: Wang Shilong 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 Message-Id: <1375335334-32540-1-git-send-email-wangsl.fnst@cn.fujitsu.com> X-Mailer: git-send-email 1.8.0.1 X-MIMETrack: Itemize by SMTP Server on mailserver/fnst(Release 8.5.3|September 15, 2011) at 2013/08/01 13:34:43, Serialize by Router on mailserver/fnst(Release 8.5.3|September 15, 2011) at 2013/08/01 13:34:43, Serialize complete at 2013/08/01 13:34:43 Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Spam-Status: No, score=-7.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY, URI_NOVOWEL autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Signed-off-by: Wang Shilong Signed-off-by: Qu Wenruo --- 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\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\fP is the device file +where the filesystem is stored. + +\fIOptions\fP +.IP "\fB-s,--super \fI\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 . +.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)