diff options
Diffstat (limited to 'Documentation/btrfs-scrub.txt')
| -rw-r--r-- | Documentation/btrfs-scrub.txt | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/btrfs-scrub.txt b/Documentation/btrfs-scrub.txt index c8765873..2928e1d1 100644 --- a/Documentation/btrfs-scrub.txt +++ b/Documentation/btrfs-scrub.txt @@ -7,21 +7,21 @@ btrfs-scrub - scrub btrfs filesystem SYNOPSIS -------- -'btrfs scrub' <subcommand> <args> +*btrfs scrub* <subcommand> <args> DESCRIPTION ----------- -'btrfs scrub' is used to scrub a btrfs filesystem, which will reading all data +*btrfs scrub* is used to scrub a btrfs filesystem, which will reading all data from all disks and verifying checksums. SUBCOMMAND ---------- -'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 a single <device>. + 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 *scrub status* command. Scrubbing involves reading all data from all disks and verifying checksums. Errors are corrected along the way if possible. + @@ -50,7 +50,7 @@ Set IO priority classdata (see `ionice`(1) manpage). force to check whether scrub has started or resumed in userspace. this is useful when scrub stat record file is damaged. -'cancel' <path>|<device>:: +*cancel* <path>|<device>:: 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 @@ -58,7 +58,7 @@ using the scrub resume command. If a <device> is given, the corresponding filesystem is found and 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 canceled or interrupted scrub cycle on the filesystem identified by <path> or on a given <device>. + @@ -66,9 +66,9 @@ Does not start a new scrub if the last scrub finished successfully. + `Options` + -see 'scrub start'. +see *scrub start*. -'status' [-d] <path>|<device>:: +*status* [-d] <path>|<device>:: Show status of a running scrub for the filesystem identified by <path> or for the specified <device>. + @@ -82,12 +82,12 @@ Print separate statistics for each device of the filesystem. EXIT STATUS ----------- -'btrfs scrub' returns a zero exist status if it succeeds. Non zero is +*btrfs scrub* returns a zero exist status if it succeeds. Non zero is returned in case of failure. AVAILABILITY ------------ -'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +*btrfs* is part of btrfs-progs. Btrfs filesystem is currently under heavy development, and not suitable for any uses other than benchmarking and review. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for |