diff --git a/man/btrfs.8.in b/man/btrfs.8.in index b31473b9..faa7bf85 100644 --- a/man/btrfs.8.in +++ b/man/btrfs.8.in @@ -35,7 +35,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 .PP @@ -205,6 +213,60 @@ Add device(s) to the filesystem identified by \fI\fR. Remove device(s) from a filesystem identified by \fI\fR. .PP +\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 + .SH EXIT STATUS \fBbtrfs\fR returns a zero exist status if it succeeds. Non zero is returned in case of failure.