From patchwork Wed Mar 30 16:53:13 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jan Schmidt X-Patchwork-Id: 674791 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by demeter1.kernel.org (8.14.4/8.14.3) with ESMTP id p2UGrMno024879 for ; Wed, 30 Mar 2011 16:53:23 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932714Ab1C3QxS (ORCPT ); Wed, 30 Mar 2011 12:53:18 -0400 Received: from mort.rzone.de ([81.169.144.234]:22699 "EHLO mort.rzone.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756100Ab1C3QxP (ORCPT ); Wed, 30 Mar 2011 12:53:15 -0400 Received: from gargravarr.store (gargravarr.store [192.168.42.236]) by mort.rzone.de (Postfix) with ESMTP id 8D05C6C1; Wed, 30 Mar 2011 18:53:13 +0200 (MEST) Received: by gargravarr.store (Postfix, from userid 32566) id 8601144B96; Wed, 30 Mar 2011 18:53:13 +0200 (CEST) From: Jan Schmidt To: chris.mason@oracle.com, linux-btrfs@vger.kernel.org Subject: [PATCH v2 5/5] scrub added to manpage Date: Wed, 30 Mar 2011 18:53:13 +0200 Message-Id: X-Mailer: git-send-email 1.7.3.4 In-Reply-To: References: In-Reply-To: References: Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Greylist: IP, sender and recipient auto-whitelisted, not delayed by milter-greylist-4.2.6 (demeter1.kernel.org [140.211.167.41]); Wed, 30 Mar 2011 16:53:23 +0000 (UTC) diff --git a/man/btrfs.8.in b/man/btrfs.8.in index 26ef982..35aa44c 100644 --- a/man/btrfs.8.in +++ b/man/btrfs.8.in @@ -29,7 +29,15 @@ btrfs \- control a btrfs filesystem .PP \fBbtrfs\fP \fBdevice add\fP\fI [..] \fP .PP -\fBbtrfs\fP \fBdevice delete\fP\fI [..] \fP] +\fBbtrfs\fP \fBdevice delete\fP\fI [..] \fP +.PP +\fBbtrfs\fP \fBscrub start\fP [-Bdqru] {\fI\fP|\fI\fP} +.PP +\fBbtrfs\fP \fBscrub cancel\fP {\fI\fP|\fI\fP} +.PP +\fBbtrfs\fP \fBscrub resume\fP [-Bdqru] {\fI\fP|\fI\fP} +.PP +\fBbtrfs\fP \fBscrub status\fP [-d] {\fI\fP|\fI\fP} .PP \fBbtrfs\fP \fBhelp|\-\-help|\-h \fP\fI\fP @@ -154,6 +162,62 @@ Add device(s) to the filesystem identified by \fI\fR. \fBdevice delete\fR\fI [..] \fR Remove device(s) from a filesystem identified by \fI\fR. +.TP + +\fBscrub start\fP [-Bdqru] {\fI\fP|\fI\fP} +Start a scrub on all devices of the filesystem identified by \fI\fR or on +a single \fI\fR. Without options, scrub is started as a background +process. Progress can be obtained with the \fBscrub status\fR command. Scrubbing +involves reading all data from all disks and verifying checksums. Errors are +corrected along the way if possible. +.RS + +\fIOptions\fR +.IP -B 5 +Do not background and print scrub statistics when finished. +.IP -d 5 +Print separate statistics for each device of the filesystem (-B only). +.IP -q 5 +Quiet. Omit error messages and statistics. +.IP -r 5 +Read only mode. Do not attempt to correct anything. +.IP -u 5 +Scrub unused space as well. (NOT IMPLEMENTED) +.RE +.TP + +\fBscrub cancel\fP {\fI\fP|\fI\fP} +If a scrub is running on the filesystem identified by \fI\fR, cancel it. +Progress is saved in the scrub progress file and scrubbing can be resumed later +using the \fBscrub resume\fR command. +If a \fI\fR is given, the corresponding filesystem is found and +\fBscrub cancel\fP behaves as if it was called on that filesystem. +.TP + +\fBscrub resume\fP [-Bdqru] {\fI\fP|\fI\fP} +Resume a canceled or interrupted scrub cycle on the filesystem identified by +\fI\fR or on a given \fI\fR. Does not start a new scrub if the +last scrub finished successfully. +.RS + +\fIOptions\fR +.TP +see \fBscrub start\fP. +.RE +.TP + +\fBscrub status\fP [-d] {\fI\fP|\fI\fP} +Show status of a running scrub for the filesystem identified by \fI\fR or +for the specified \fI\fR. +If no scrub is running, show statistics of the last finished or canceled scrub +for that filesystem or device. +.RS + +\fIOptions\fR +.IP -d 5 +Print separate statistics for each device of the filesystem. +.RE + .PP .SH EXIT STATUS