summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man8/btrfs-scrub.8
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man8/btrfs-scrub.8')
-rw-r--r--upstream/archlinux/man8/btrfs-scrub.860
1 files changed, 24 insertions, 36 deletions
diff --git a/upstream/archlinux/man8/btrfs-scrub.8 b/upstream/archlinux/man8/btrfs-scrub.8
index e415fac8..6061cadf 100644
--- a/upstream/archlinux/man8/btrfs-scrub.8
+++ b/upstream/archlinux/man8/btrfs-scrub.8
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "BTRFS-SCRUB" "8" "Feb 14, 2024" "6.7.1" "BTRFS"
+.TH "BTRFS-SCRUB" "8" "May 03, 2024" "6.8.1" "BTRFS"
.SH NAME
btrfs-scrub \- scrub btrfs filesystem, verify block checksums
.SH SYNOPSIS
@@ -68,19 +68,19 @@ scrub only a selected device. See \fI\%btrfs scrub start\fP for more.
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
-The \fBionice(1)\fP may not be generally supported by all IO schedulers and
+The \X'tty: link https://man7.org/linux/man-pages/man1/ionice.1.html'\fI\%ionice(1)\fP\X'tty: link' may not be generally supported by all IO schedulers and
the options to \fBbtrfs scrub start\fP may not work as expected.
.UNINDENT
.UNINDENT
.sp
-In the past when the \fI\%CFQ IO scheduler\fP was generally used
-the \fBionice(1)\fP syscalls set the priority to \fIidle\fP so the IO would not
+In the past when the \X'tty: link https://en.wikipedia.org/wiki/Completely_fair_queueing'\fI\%CFQ IO scheduler\fP\X'tty: link' was generally used
+the \X'tty: link https://man7.org/linux/man-pages/man1/ionice.1.html'\fI\%ionice(1)\fP\X'tty: link' syscalls set the priority to \fIidle\fP so the IO would not
interfere with regular IO. Since the kernel 5.0 the CFQ is not available.
.sp
-The IO scheduler known to support that is \fI\%BFQ\fP, but first read the
+The IO scheduler known to support that is \X'tty: link https://docs.kernel.org/block/bfq-iosched.html'\fI\%BFQ\fP\X'tty: link', but first read the
documentation before using it!
.sp
-For other commonly used schedulers like \fI\%mq\-deadline\fP it\(aqs recommended to use
+For other commonly used schedulers like \X'tty: link https://docs.kernel.org/block/blk-mq.html'\fI\%mq\-deadline\fP\X'tty: link' it\(aqs recommended to use
\fIcgroup2 IO controller\fP which could be managed by e.g. \fIsystemd\fP
(documented in \fBsystemd.resource\-control\fP). However, starting scrub like that
is not yet completely straightforward. The IO controller must know the physical
@@ -89,11 +89,9 @@ belong to the same accounting group.
.INDENT 0.0
.INDENT 3.5
.sp
-.nf
-.ft C
-$ systemd\-run \-p \(dqIOBandwidthReadMax=/dev/sdx 10M\(dq btrfs scrub start \-B /
-.ft P
-.fi
+.EX
+$ systemd\-run \-p \(dqIOReadBandwidthMax=/dev/sdx 10M\(dq btrfs scrub start \-B /
+.EE
.UNINDENT
.UNINDENT
.sp
@@ -105,16 +103,14 @@ limit\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
-.nf
-.ft C
+.EX
$ echo 100m > /sys/fs/btrfs/9b5fd16e\-1b64\-4f9b\-904a\-74e74c0bbadc/devinfo/1/scrub_speed_max
$ btrfs scrub limit /
UUID: 9b5fd16e\-1b64\-4f9b\-904a\-74e74c0bbadc
Id Limit Path
\-\- \-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-
1 100.00MiB /dev/sdx
-.ft P
-.fi
+.EE
.UNINDENT
.UNINDENT
.SH SUBCOMMAND
@@ -226,14 +222,14 @@ necessary
.INDENT 7.0
.TP
.BI \-c \ <ioprio_class>
-set IO priority class (see \fBionice(1)\fP manual page) if the IO
+set IO priority class (see \X'tty: link https://man7.org/linux/man-pages/man1/ionice.1.html'\fI\%ionice(1)\fP\X'tty: link' manual page) if the IO
scheduler configured for the device supports ionice. This is
only supported by BFQ or Kyber but is \fInot\fP supported by
mq\-deadline. Please read the section about
-\fI\%IO limiting\fP\&.
+\X'tty: link btrfs-scrub//#scrub-io-limiting'\fI\%IO limiting\fP\X'tty: link'\&.
.TP
.BI \-n \ <ioprio_classdata>
-set IO priority classdata (see \fBionice(1)\fP manpage)
+set IO priority classdata (see \X'tty: link https://man7.org/linux/man-pages/man1/ionice.1.html'\fI\%ionice(1)\fP\X'tty: link' manpage)
.TP
.B \-q
(deprecated) alias for global \fI\-q\fP option
@@ -286,8 +282,7 @@ A status on a filesystem without any error looks like the following:
.INDENT 7.0
.INDENT 3.5
.sp
-.nf
-.ft C
+.EX
# btrfs scrub start /
# btrfs scrub status /
UUID: 76fac721\-2294\-4f89\-a1af\-620cde7a1980
@@ -300,8 +295,7 @@ Total to scrub: 28.32GiB
Bytes scrubbed: 13.76GiB (48.59%)
Rate: 2.75GiB/s
Error summary: no errors found
-.ft P
-.fi
+.EE
.UNINDENT
.UNINDENT
.sp
@@ -309,14 +303,12 @@ With some errors found:
.INDENT 7.0
.INDENT 3.5
.sp
-.nf
-.ft C
+.EX
Error summary: csum=72
Corrected: 2
Uncorrectable: 72
Unverified: 0
-.ft P
-.fi
+.EE
.UNINDENT
.UNINDENT
.INDENT 7.0
@@ -346,15 +338,13 @@ It\(aqs possible to set a per\-device limit via file
\fBsysfs/fs/btrfs/FSID/devinfo/scrub_speed_max\fP\&. In that case
the limit is printed on the \fIRate:\fP line if option \fI\-d\fP is specified,
or without it on a single\-device filesystem. Read more about tat in
-section about \fI\%scrub IO limiting\fP\&.
+section about \X'tty: link btrfs-scrub//#scrub-io-limiting'\fI\%scrub IO limiting\fP\X'tty: link'\&.
.INDENT 7.0
.INDENT 3.5
.sp
-.nf
-.ft C
+.EX
Rate: 989.0MiB/s (limit 1.0G/s)
-.ft P
-.fi
+.EE
.UNINDENT
.UNINDENT
.sp
@@ -364,11 +354,9 @@ some limits are set:
.INDENT 7.0
.INDENT 3.5
.sp
-.nf
-.ft C
+.EX
Rate: 36.37MiB/s (some device limits set)
-.ft P
-.fi
+.EE
.UNINDENT
.UNINDENT
.UNINDENT
@@ -390,7 +378,7 @@ scrub found uncorrectable errors
.SH AVAILABILITY
.sp
\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at
-\fI\%https://btrfs.readthedocs.io\fP\&.
+\X'tty: link https://btrfs.readthedocs.io'\fI\%https://btrfs.readthedocs.io\fP\X'tty: link'\&.
.SH SEE ALSO
.sp
\fI\%mkfs.btrfs(8)\fP