tweak some man pages

This commit is contained in:
Joe Thornber 2014-08-06 10:33:23 +01:00
parent 41ade2a259
commit bdec4b353c
3 changed files with 8 additions and 6 deletions

View File

@ -35,7 +35,7 @@ error. If any errors are discovered use
to correct. to correct.
.SH EXAMPLE .SH EXAMPLE
Analyses thin provisioning metadata on logical volume Analyse thin provisioning metadata on logical volume
/dev/vg/metadata: /dev/vg/metadata:
.sp .sp
.B era_check /dev/vg/metadata .B era_check /dev/vg/metadata

View File

@ -1,6 +1,6 @@
.TH THIN_CHECK 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*- .TH THIN_CHECK 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
.SH NAME .SH NAME
thin_check \- repair thin provisioning metadata on device or file thin_check \- validate thin provisioning metadata on device or file
.SH SYNOPSIS .SH SYNOPSIS
.B thin_check .B thin_check
@ -35,19 +35,18 @@ metadata.
.IP "\fB\-\-ignore\-non\-fatal\-errors\fP" .IP "\fB\-\-ignore\-non\-fatal\-errors\fP"
.B thin_check .B thin_check
will only return a non-zero exit code if it finds a fatal will only return a non-zero exit code if it finds a fatal
error. An example of a on fatal error is an incorrect data block error. An example of a non fatal error is an incorrect data block
reference count causing a block to be considered allocated when it in reference count causing a block to be considered allocated when it in
fact isn't. Ignoring errors for a long time is not advised, you fact isn't. Ignoring errors for a long time is not advised, you
really should be using thin_repair to fix them. really should be using thin_repair to fix them.
.SH EXAMPLE .SH EXAMPLE
Analyses and repairs thin provisioning metadata on logical volume Analyses thin provisioning metadata on logical volume
/dev/vg/metadata: /dev/vg/metadata:
.sp .sp
.B thin_check /dev/vg/metadata .B thin_check /dev/vg/metadata
The device may not be actively used by the target The device must not be actively used by the target when running.
when running.
.SH DIAGNOSTICS .SH DIAGNOSTICS
.B thin_check .B thin_check

View File

@ -24,6 +24,9 @@ If restored to a metadata
.I device .I device
, the metadata can be processed by the device-mapper target. , the metadata can be processed by the device-mapper target.
.IP "\fB\-q, \-\-quiet\fP"
Suppress output messages, return only exit code.
.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP" .IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Input file or device with metadata. Input file or device with metadata.