RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-04-07 09:41:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

btrfs-progs: docs: update btrfs-scrub

Browse Source 
Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2016-05-06 12:42:21 +02:00
parent b3751c131a
commit 162257574a
1 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
Documentation/btrfs-scrub.asciidoc
View File

@ -3,7 +3,7 @@ btrfs-scrub(8)
NAME NAME
---- ----
btrfs-scrub - scrub btrfs filesystem btrfs-scrub - scrub btrfs filesystem, verify block checksums
SYNOPSIS SYNOPSIS
-------- --------
@ -12,21 +12,22 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
*btrfs scrub* is used to scrub a btrfs filesystem, which will read all data *btrfs scrub* is used to scrub a btrfs filesystem, which will read all data
from all disks and verify checksums. and metadata blocks from all disks and verify checksums. Automatically repair
corrupted blocks if there's a correct copy available.
SUBCOMMAND SUBCOMMAND
---------- ----------
*cancel* <path>|<device>:: *cancel* <path>|<device>::
If a scrub is running on the filesystem identified by <path>, cancel it. If a scrub is running on the filesystem identified by 'path>' cancel it.
+ +
Progress is saved in the scrub progress file and scrubbing can be resumed later Progress is saved in the scrub progress file ('/var/lib/btrfs/scrub.status.UUID')
using the scrub resume command. and scrubbing can be resumed later using the *btrfs scrub resume* command.
If a <device> is given, the corresponding filesystem is found and If a 'device' is specified, the corresponding filesystem is found and
scrub cancel behaves as if it was called on that filesystem. *btrfs scrub cancel* behaves as if it was called on that filesystem.
*resume* [-BdqrR] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>:: *resume* [-BdqrR] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>::
Resume a cancelled or interrupted scrub cycle on the filesystem identified by Resume a cancelled or interrupted scrub on the filesystem identified by
<path> or on a given <device>. 'path' or on a given 'device'.
+ +
Does not start a new scrub if the last scrub finished successfully. Does not start a new scrub if the last scrub finished successfully.
+ +
@ -35,11 +36,11 @@ Does not start a new scrub if the last scrub finished successfully.
see *scrub start*. see *scrub start*.
*start* [-BdqrRf] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>:: *start* [-BdqrRf] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>::
Start a scrub on all devices of the filesystem identified by <path> or on Start a scrub on all devices of the filesystem identified by 'path' or on
a single <device>. If a scrub is already running, the new one fails. a single 'device'. If a scrub is already running, the new one fails.
+ +
Without options, scrub is started as a background process. Without options, scrub is started as a background process.
Progress can be obtained with the *scrub status* command. Scrubbing Progress can be obtained with the *btrfs scrub status* command. Scrubbing
involves reading all data from all disks and verifying checksums. Errors are involves reading all data from all disks and verifying checksums. Errors are
corrected along the way if possible. corrected along the way if possible.
+ +
@ -49,26 +50,28 @@ configured similar to the `ionice`(1) syntax using '-c' and '-n' options.
`Options` `Options`
+ +
-B:::: -B::::
Do not background and print scrub statistics when finished. do not background and print scrub statistics when finished
-d:::: -d::::
Print separate statistics for each device of the filesystem (-B only). print separate statistics for each device of the filesystem ('-B' only)
-q:::: -q::::
Quiet. Omit error messages and statistics. be quiet, omit error messages and statistics
-r:::: -r::::
Read only mode. Do not attempt to correct anything. read only mode, do not attempt to correct anything, can be run on a read-only
filesystem
-R:::: -R::::
Raw print mode. Print full data instead of summary. print raw statistics per-device instead of a summary
-c <ioprio_class>:::: -c <ioprio_class>::::
Set IO priority class (see `ionice`(1) manpage). set IO priority class (see `ionice`(1) manpage)
-n <ioprio_classdata>:::: -n <ioprio_classdata>::::
Set IO priority classdata (see `ionice`(1) manpage). set IO priority classdata (see `ionice`(1) manpage)
-f:::: -f::::
Force starting new scrub even if a scrub is already running. force starting new scrub even if a scrub is already running,
This is useful when scrub status record file is damaged. this is useful when scrub status file is damaged and reports a running
scrub although it is not
*status* [-d] <path>|<device>:: *status* [-d] <path>|<device>::
Show status of a running scrub for the filesystem identified by <path> or Show status of a running scrub for the filesystem identified by 'path' or
for the specified <device>. for the specified 'device'.
+ +
If no scrub is running, show statistics of the last finished or cancelled scrub If no scrub is running, show statistics of the last finished or cancelled scrub
for that filesystem or device. for that filesystem or device.
@ -76,7 +79,7 @@ for that filesystem or device.
`Options` `Options`
+ +
-d:::: -d::::
Print separate statistics for each device of the filesystem. print separate statistics for each device of the filesystem
EXIT STATUS EXIT STATUS
----------- -----------