From patchwork Wed Apr 2 08:29:27 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qu Wenruo X-Patchwork-Id: 3927361 X-Patchwork-Delegate: dave@jikos.cz 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 3EA899F2B6 for ; Wed, 2 Apr 2014 08:29:15 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 626BB2024D for ; Wed, 2 Apr 2014 08:29:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 74E8220211 for ; Wed, 2 Apr 2014 08:29:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1758208AbaDBI3I (ORCPT ); Wed, 2 Apr 2014 04:29:08 -0400 Received: from cn.fujitsu.com ([59.151.112.132]:65370 "EHLO heian.cn.fujitsu.com" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1758199AbaDBI3E (ORCPT ); Wed, 2 Apr 2014 04:29:04 -0400 X-IronPort-AV: E=Sophos;i="4.97,778,1389715200"; d="scan'208";a="28775313" Received: from unknown (HELO edo.cn.fujitsu.com) ([10.167.33.5]) by heian.cn.fujitsu.com with ESMTP; 02 Apr 2014 16:26:23 +0800 Received: from G08CNEXCHPEKD03.g08.fujitsu.local (localhost.localdomain [127.0.0.1]) by edo.cn.fujitsu.com (8.14.3/8.13.1) with ESMTP id s328SlJu014962 for ; Wed, 2 Apr 2014 16:28:47 +0800 Received: from adam-work.lan (10.167.226.24) by G08CNEXCHPEKD03.g08.fujitsu.local (10.167.33.89) with Microsoft SMTP Server (TLS) id 14.3.146.2; Wed, 2 Apr 2014 16:28:54 +0800 From: Qu Wenruo To: Subject: [PATCH 16/27] btrfs-progs: Convert man page for btrfsck Date: Wed, 2 Apr 2014 16:29:27 +0800 Message-ID: <1396427378-10487-17-git-send-email-quwenruo@cn.fujitsu.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1396427378-10487-1-git-send-email-quwenruo@cn.fujitsu.com> References: <1396427378-10487-1-git-send-email-quwenruo@cn.fujitsu.com> MIME-Version: 1.0 X-Originating-IP: [10.167.226.24] 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.5 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=ham 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 Convert man page for btrfsck. Signed-off-by: Qu Wenruo --- Documentation/Makefile | 2 +- Documentation/btrfsck.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 Documentation/btrfsck.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 4040951..b4d8281 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -3,7 +3,7 @@ MAN8_TXT = # Top level commands MAN8_TXT += btrfs.txt -#MAN8_TXT += btrfsck.txt +MAN8_TXT += btrfsck.txt #MAN8_TXT += btrfs-convert.txt #MAN8_TXT += btrfs-debug-tree.txt #MAN8_TXT += btrfs-find-root.txt diff --git a/Documentation/btrfsck.txt b/Documentation/btrfsck.txt new file mode 100644 index 0000000..751c4d0 --- /dev/null +++ b/Documentation/btrfsck.txt @@ -0,0 +1,55 @@ +btrfsck(8) +========== + +NAME +---- +btrfsck - check or repair a btrfs filesystem offline + +SYNOPSIS +-------- +'btrfsck' [options] + +DESCRIPTION +----------- +'btrfsck' is used to check and optionally repair of a Btrfs filesystem. + +Now, it can only be run on an unmounted FS. + is the device file where the filesystem is stored. + +'btrfsck' is just an alias of 'btrfs check' command. + +WARNING: Considering it is not well-tested in real-life situations yet. +If you have a broken Btrfs filesystem, btrfsck may not repair but cause +additional damages. + + +OPTIONS +------- +-s|--support :: +use th superblock copy. +--repair:: +try to repair the filesystem. +--init-csum-tree:: +create a new CRC tree. +--init-extent-tree:: +create a new extent tree. + +EXIT STATUS +----------- +'btrfsck' 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-scrub`(8), +`btrfs-rescue`(8) +`btrfs-check`(8)