RepoMirrors
/
btrfs-progs
mirror of https://github.com/kdave/btrfs-progs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update man page to new defragment command interface 

Update

        btrfs filesystem defragment

command explanation. Add explanation of advanced parameters and notes
about general usage.

Add few notes about the

        btrfs <command> --help

usage, fix related grammar.

Signed-off-by: Hubert Kario <kario@wit.edu.pl>
Signed-off-by: Chris Mason <chris.mason@oracle.com>
This commit is contained in:
Hubert Kario 2011-01-23 15:31:07 +00:00 committed by Chris Mason
parent eb5418933f
commit 0646719841
1 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
man/btrfs.8.in
View File

@ -15,7 +15,7 @@ btrfs \- control a btrfs filesystem
.PP .PP
\fBbtrfs\fP \fBsubvolume set-default\fP\fI <id> <path>\fP \fBbtrfs\fP \fBsubvolume set-default\fP\fI <id> <path>\fP
.PP .PP
\fBbtrfs\fP \fBfilesystem defrag\fP\fI <file>|<dir> [<file>|<dir>...]\fP \fBbtrfs\fP \fBfilesystem defragment\fP\fI [-vcf] [-s start] [-l len] [-t size] <file>|<dir> [<file>|<dir>...]\fP
.PP .PP
\fBbtrfs\fP \fBfilesystem sync\fP\fI <path> \fP \fBbtrfs\fP \fBfilesystem sync\fP\fI <path> \fP
.PP .PP
@ -34,6 +34,8 @@ btrfs \- control a btrfs filesystem
.PP .PP
\fBbtrfs\fP \fBhelp|\-\-help|\-h \fP\fI\fP \fBbtrfs\fP \fBhelp|\-\-help|\-h \fP\fI\fP
.PP .PP
\fBbtrfs\fP \fB<command> \-\-help \fP\fI\fP
.PP
.SH DESCRIPTION .SH DESCRIPTION
.B btrfs .B btrfs
is used to control the filesystem and the files and directories stored. It is 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 If a command is terminated by
.I --help .I --help
, the relevant help is showed. If the passed command matches more commands, , the detailed help is showed. If the passed command matches more commands,
the help of all the matched commands are showed. For example detailed help of all the matched commands is showed. For example
.I btrfs dev --help .I btrfs dev --help
shows the help of all shows the help of all
.I device* .I device*
command. commands.
.SH COMMANDS .SH COMMANDS
.TP .TP
@ -98,12 +100,29 @@ mount time via the \fIsubvol=\fR option.
\fBsubvolume set-default\fR\fI <id> <path>\fR \fBsubvolume set-default\fR\fI <id> <path>\fR
Set the subvolume of the filesystem \fI<path>\fR which is mounted as Set the subvolume of the filesystem \fI<path>\fR which is mounted as
\fIdefault\fR. The subvolume is identified by \fB<id>\fR, which \fIdefault\fR. The subvolume is identified by \fI<id>\fR, which
is returned by the \fBsubvolume list\fR command. is returned by the \fBsubvolume list\fR command.
.TP .TP
\fBfilesystem defragment\fP\fI <file>|<dir> [<file>|<dir>...]\fR \fBfilesystem defragment\fP\fI [-vcf] [-s start] [-l len] [-t size] <file>|<dir> [<file>|<dir>...]\fR
Defragment files and/or directories. 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 .TP
\fBdevice scan\fR \fI[<device> [<device>..]]\fR \fBdevice scan\fR \fI[<device> [<device>..]]\fR