From patchwork Sun Jan 23 15:31:07 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Hubert Kario X-Patchwork-Id: 499151 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 p0NFVjK1025767 for ; Sun, 23 Jan 2011 15:31:45 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751490Ab1AWPbV (ORCPT ); Sun, 23 Jan 2011 10:31:21 -0500 Received: from dervish.wsisiz.edu.pl ([213.135.44.54]:54900 "EHLO dervish.wsisiz.edu.pl" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751018Ab1AWPbN (ORCPT ); Sun, 23 Jan 2011 10:31:13 -0500 Received: from localhost (localhost.localdomain [127.0.0.1]) by dervish.wsisiz.edu.pl (Postfix) with ESMTP id 07C1FC54081 for ; Sun, 23 Jan 2011 16:31:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wit.edu.pl; h= message-id:content-transfer-encoding:content-type:content-type :mime-version:user-agent:date:date:subject:subject:from:from :received:received; s=amavisd; t=1295796670; bh=f5ZoWxZNUsizVlTi KW79iVT838mQaUrqa1LPr0cHvY4=; b=Iw6M6PD6CgG1FnFzRTG+arQMXJjH8CJ7 hdxw1z2wPla0QZnfacUjSVNyULDaKI1PdsZOsED46uklTkNbMZvth3cCqfAFKu8r /fr3/CHzvKk63AeSm/uoimGGQjoBFrZWv39tkQCQDK0F6eOHYdJu516e6NvDY3Ki 75bdWmbZMnk= X-Virus-Scanned: amavisd-new at wit.edu.pl Received: from dervish.wsisiz.edu.pl ([127.0.0.1]) by localhost (dervish.wsisiz.edu.pl [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id GyVNhzUmJaTM for ; Sun, 23 Jan 2011 16:31:10 +0100 (CET) Received: from bursa23.localnet (bursa22.wsisiz.edu.pl [213.135.49.150]) by dervish.wsisiz.edu.pl (Postfix) with ESMTPSA id 9C605C54097 for ; Sun, 23 Jan 2011 16:31:10 +0100 (CET) From: Hubert Kario To: linux-btrfs@vger.kernel.org Subject: [PATCH] update man page to new defragment command interface Date: Sun, 23 Jan 2011 16:31:07 +0100 User-Agent: KMail/1.13.5 (Linux/2.6.36-ARCH; KDE/4.5.5; i686; ; ) MIME-Version: 1.0 Message-Id: <201101231631.07631.kario@wit.edu.pl> 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]); Sun, 23 Jan 2011 15:31:47 +0000 (UTC) diff --git a/man/btrfs.8.in b/man/btrfs.8.in index 26ef982..cba2de1 100644 --- a/man/btrfs.8.in +++ b/man/btrfs.8.in @@ -15,7 +15,7 @@ btrfs \- control a btrfs filesystem .PP \fBbtrfs\fP \fBsubvolume set-default\fP\fI \fP .PP -\fBbtrfs\fP \fBfilesystem defrag\fP\fI | [|...]\fP +\fBbtrfs\fP \fBfilesystem defragment\fP\fI [-vcf] [-s start] [-l len] [-t size] | [|...]\fP .PP \fBbtrfs\fP \fBfilesystem sync\fP\fI \fP .PP @@ -34,6 +34,8 @@ btrfs \- control a btrfs filesystem .PP \fBbtrfs\fP \fBhelp|\-\-help|\-h \fP\fI\fP .PP +\fBbtrfs\fP \fB \-\-help \fP\fI\fP +.PP .SH DESCRIPTION .B btrfs is used to control the filesystem and the files and directories stored. It is @@ -60,12 +62,12 @@ returns an error. If a command is terminated by .I --help -, the relevant help is showed. If the passed command matches more commands, -the help of all the matched commands are showed. For example +, the detailed help is showed. If the passed command matches more commands, +detailed help of all the matched commands is showed. For example .I btrfs dev --help shows the help of all .I device* -command. +commands. .SH COMMANDS .TP @@ -98,12 +100,29 @@ mount time via the \fIsubvol=\fR option. \fBsubvolume set-default\fR\fI \fR Set the subvolume of the filesystem \fI\fR which is mounted as -\fIdefault\fR. The subvolume is identified by \fB\fR, which +\fIdefault\fR. The subvolume is identified by \fI\fR, which is returned by the \fBsubvolume list\fR command. .TP -\fBfilesystem defragment\fP\fI | [|...]\fR -Defragment files and/or directories. +\fBfilesystem defragment\fP\fI [-vcf] [-s start] [-l len] [-t size] | [|...]\fR +Defragment file data and/or directory metadata. To defragment all files in a +directory you have to specify each one on its own or use your shell wildcards. + +\fB-v\fP be verbose + +\fB-c\fP compress file contents while defragmenting + +\fB-f\fP flush filesystem after defragmenting + +\fB-s start\fP defragment only from byte \fIstart\fR onward + +\fB-l len\fP defragment only up to \fIlen\fR bytes + +\fB-t size\fP defragment only files at least \fIsize\fR bytes big + +NOTE: defragmenting with kernels up to 2.6.37 will unlink COW-ed copies of data, don't +use it if you use snapshots, have de-duplicated your data or made copies with +\fBcp --reflink\fP. .TP \fBdevice scan\fR \fI[ [..]]\fR