From patchwork Wed Apr 2 08:29:17 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qu Wenruo X-Patchwork-Id: 3927491 X-Patchwork-Delegate: dave@jikos.cz Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 012ACBF540 for ; Wed, 2 Apr 2014 08:30:49 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 0757B20240 for ; Wed, 2 Apr 2014 08:30:48 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 1E53720211 for ; Wed, 2 Apr 2014 08:30:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1758196AbaDBI3C (ORCPT ); Wed, 2 Apr 2014 04:29:02 -0400 Received: from cn.fujitsu.com ([59.151.112.132]:16608 "EHLO heian.cn.fujitsu.com" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1758018AbaDBI25 (ORCPT ); Wed, 2 Apr 2014 04:28:57 -0400 X-IronPort-AV: E=Sophos;i="4.97,778,1389715200"; d="scan'208";a="28775301" Received: from unknown (HELO edo.cn.fujitsu.com) ([10.167.33.5]) by heian.cn.fujitsu.com with ESMTP; 02 Apr 2014 16:26:14 +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 s328Scre014926 for ; Wed, 2 Apr 2014 16:28:38 +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:45 +0800 From: Qu Wenruo To: Subject: [PATCH 06/27] btrfs-progs: Convert man page for btrfs-scrub Date: Wed, 2 Apr 2014 16:29:17 +0800 Message-ID: <1396427378-10487-7-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 btrfs-scrub. Signed-off-by: Qu Wenruo --- Documentation/Makefile | 2 +- Documentation/btrfs-scrub.txt | 98 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 99 insertions(+), 1 deletion(-) create mode 100644 Documentation/btrfs-scrub.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 79ae9de..68b7e1f 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -20,7 +20,7 @@ MAN8_TXT += btrfs-subvolume.txt MAN8_TXT += btrfs-filesystem.txt MAN8_TXT += btrfs-balance.txt MAN8_TXT += btrfs-device.txt -#MAN8_TXT += btrfs-scrub.txt +MAN8_TXT += btrfs-scrub.txt #MAN8_TXT += btrfs-check.txt #MAN8_TXT += btrfs-rescue.txt #MAN8_TXT += btrfs-inspect-internal.txt diff --git a/Documentation/btrfs-scrub.txt b/Documentation/btrfs-scrub.txt new file mode 100644 index 0000000..3973f31 --- /dev/null +++ b/Documentation/btrfs-scrub.txt @@ -0,0 +1,98 @@ +btrfs-scrub(8) +============== + +NAME +---- +btrfs-scrub - scrub btrfs filesystem + +SYNOPSIS +-------- +'btrfs scrub' + +DESCRIPTION +----------- +'btrfs scrub' is used to scrub a btrfs filesystem, which will reading all data +from all disks and verifying checksums. + +SUBCOMMAND +---------- +'start' [-BdqrRf] [-c ioprio_class -n ioprio_classdata] |:: +Start a scrub on all devices of the filesystem identified by or on +a single . ++ +Without options, scrub is started as a background process. +Progress can be obtained with the 'scrub status' command. Scrubbing +involves reading all data from all disks and verifying checksums. Errors are +corrected along the way if possible. ++ +The default IO priority of scrub is the idle class. The priority can be +configured similar to the `ionice`(1) syntax using '-c' and '-n' options. ++ +`Options` ++ +-B:::: +Do not background and print scrub statistics when finished. +-d:::: +Print separate statistics for each device of the filesystem (-B only). +-q:::: +Quiet. Omit error messages and statistics. +-r:::: +Read only mode. Do not attempt to correct anything. +-R:::: +Raw print mode. Print full data instead of summary. +-c ioprio_class:::: +Set IO priority class (see + ionice (1) +manpage). +-n ioprio_classdata:::: +Set IO priority classdata (see `ionice`(1) manpage). +-f:::: +force to check whether scrub has started or resumed in userspace. +this is useful when scrub stat record file is damaged. + +'cancel' |:: +If a scrub is running on the filesystem identified by , cancel it. ++ +Progress is saved in the scrub progress file and scrubbing can be resumed later +using the scrub resume command. +If a is given, the corresponding filesystem is found and +scrub cancel behaves as if it was called on that filesystem. + +'resume' [-BdqrR] [-c ioprio_class -n ioprio_classdata] |:: +Resume a canceled or interrupted scrub cycle on the filesystem identified by + or on a given . ++ +Does not start a new scrub if the last scrub finished successfully. ++ +`Options` ++ +see 'scrub start'. + +'status' [-d] |:: +Show status of a running scrub for the filesystem identified by or +for the specified . ++ +If no scrub is running, show statistics of the last finished or canceled scrub +for that filesystem or device. ++ +`Options` ++ +-d:::: +Print separate statistics for each device of the filesystem. + +EXIT STATUS +----------- +'btrfs scrub' 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),