Reformat and fix man pages [Milan]
This commit is contained in:
parent
af1af61735
commit
3c6a58fb5a
@ -1,36 +1,47 @@
|
|||||||
.TH THIN_REPAIR 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
|
.TH THIN_REPAIR 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
|
||||||
.SH NAME
|
.SH NAME
|
||||||
thin_repair \- repair thin provisioning metadata on device or file
|
thin_check \- repair thin provisioning metadata on device or file
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B thin_repair {device|file}
|
.B thin_check
|
||||||
|
.RB [ options ]
|
||||||
|
.I {device|file}
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
thin_repair checks thin provisioning metadata created by
|
.B thin_check
|
||||||
the device-mapper thin provisioning target on a device or file (see
|
checks thin provisioning metadata created by
|
||||||
|
the device-mapper thin provisioning target on a
|
||||||
|
.I device
|
||||||
|
or
|
||||||
|
.I file.
|
||||||
|
See
|
||||||
.B thin_dump(8)
|
.B thin_dump(8)
|
||||||
) on how to dump metadata to a file.
|
how to dump metadata to a file.
|
||||||
A future release will be able to fix faulty metadata.
|
A future release will be able to fix faulty metadata.
|
||||||
|
|
||||||
.B thin_repair (device|file}
|
.SH OPTIONS
|
||||||
|
.IP "\fB\-h, \-\-help\fP"
|
||||||
|
Print help and exit.
|
||||||
|
|
||||||
.B thin_repair
|
.IP "\fB\-V, \-\-version\fP"
|
||||||
{-h|--help}
|
Output version information and exit.
|
||||||
|
|
||||||
.B thin_dump
|
|
||||||
{-V|--version}
|
|
||||||
|
|
||||||
.SH EXAMPLE
|
.SH EXAMPLE
|
||||||
"thin_repair /dev/vg/metadata"
|
Analyses and repairs thin provisioning metadata on logical volume
|
||||||
analyses and repairs thin provisioning metadata on logical volume
|
/dev/vg/metadata:
|
||||||
/dev/vg/metadata. The device may not be actively used by the target
|
.sp
|
||||||
|
.B thin_repair /dev/vg/metadata
|
||||||
|
|
||||||
|
The device may not be actively used by the target
|
||||||
when repairing!
|
when repairing!
|
||||||
|
|
||||||
.SH DIAGNOSTICS
|
.SH DIAGNOSTICS
|
||||||
thin_repair returns an exit code of 0 for success or 1 for error.
|
.B thin_check
|
||||||
|
returns an exit code of 0 for success or 1 for error.
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.B thin_dump(8), thin_restore(8)
|
.B thin_dump(8)
|
||||||
|
.B thin_restore(8)
|
||||||
|
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
Joe Thornber <ejt@redhat.com>
|
Joe Thornber <ejt@redhat.com>
|
||||||
|
@ -3,44 +3,49 @@
|
|||||||
thin_dump \- dump thin provisioning metadata from device or file to standard output
|
thin_dump \- dump thin provisioning metadata from device or file to standard output
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B thin_dump [options] {metadata device|file}
|
.B thin_dump
|
||||||
|
.RB [options]
|
||||||
|
.I {metadata device|file}
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
thin_dump dumps thin provisioning metadata created by the device-mapper
|
.B thin_dump
|
||||||
|
dumps thin provisioning metadata created by the device-mapper
|
||||||
thin provisioning target on a device or file to standard output for
|
thin provisioning target on a device or file to standard output for
|
||||||
analysis or postprocessing in either XML or human readable format.
|
analysis or postprocessing in either XML or human readable format.
|
||||||
XML formated metadata can be fed into thin_restore (see
|
XML formated metadata can be fed into thin_restore (see
|
||||||
.B thin_restore(8)
|
.BR thin_restore(8) )
|
||||||
) in order to put it back onto a metadata device (to process by
|
in order to put it back onto a metadata device (to process by
|
||||||
the device-mapper target) or file.
|
the device-mapper target) or file.
|
||||||
|
|
||||||
.B thin_dump
|
.IP "\fB\-f, \-\-format\fP \fI{xml|human_readable}\fP".
|
||||||
{-i|--input} {device|file}
|
Print output in XML or human readable format.
|
||||||
[{-f|--format} {xml|human_readable}]
|
|
||||||
|
|
||||||
.B thin_dump
|
.IP "\fB\-r, \-\-repair\fP".
|
||||||
{-r|--repair}
|
|
||||||
|
|
||||||
.B thin_dump
|
.IP "\fB\-h, \-\-help\fP".
|
||||||
{-h|--help}
|
Print help and exit.
|
||||||
|
|
||||||
.B thin_dump
|
.IP "\fB\-V, \-\-version\fP".
|
||||||
{-V|--version}
|
Output version information and exit.
|
||||||
|
|
||||||
.SH EXAMPLES
|
.SH EXAMPLES
|
||||||
"thin_dump -f human_redable -i /dev/vg/metadata"
|
Dumps the thin provisioning metadata on logical volume /dev/vg/metadata
|
||||||
dumps the thin provisioning metadata on logical volume /dev/vg/metadata
|
to standard output in human readable format:
|
||||||
to standard output in human readable format.
|
.sp
|
||||||
|
.B thin_dump -f human_redable /dev/vg/metadata
|
||||||
|
|
||||||
"thin_dump /dev/vg/metadata"
|
Dumps the thin provisioning metadata on logical volume /dev/vg/metadata
|
||||||
dumps the thin provisioning metadata on logical volume /dev/vg/metadata
|
to standard output in XML format:
|
||||||
to standard output in XML format.
|
.sp
|
||||||
|
.B thin_dump /dev/vg/metadata
|
||||||
|
|
||||||
.SH DIAGNOSTICS
|
.SH DIAGNOSTICS
|
||||||
thin_dump returns an exit code of 0 for success or 1 for error.
|
.B thin_dump
|
||||||
|
returns an exit code of 0 for success or 1 for error.
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.B thin_repair(8), thin_restore(8)
|
.B thin_check(8)
|
||||||
|
.B thin_restore(8)
|
||||||
|
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
Joe Thornber <ejt@redhat.com>
|
Joe Thornber <ejt@redhat.com>
|
||||||
|
@ -3,37 +3,49 @@
|
|||||||
thin_restore \- restore thin provisioning metadata file to device or file
|
thin_restore \- restore thin provisioning metadata file to device or file
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B thin_restore [options] file {metadata device|file}
|
.B thin_restore
|
||||||
|
.RB [ options ]
|
||||||
|
.RB -i
|
||||||
|
.I {device|file}
|
||||||
|
.RB -o
|
||||||
|
.I {device|file}
|
||||||
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
thin_restore restores thin provisioning metadata created by the
|
.B thin_restore
|
||||||
respective device-mapper target dumped into an XML formated (see
|
restores thin provisioning metadata created by the
|
||||||
.B thin_dump(8)
|
respective device-mapper target dumped into an XML formatted (see
|
||||||
) file, which optionally can be preproccessed to another device or file.
|
.BR thin_dump(8) )
|
||||||
|
file, which optionally can be preprocessed to another device or file.
|
||||||
If restored to a metadata device, the metadata can be processed
|
If restored to a metadata device, the metadata can be processed
|
||||||
by the device-mapper target.
|
by the device-mapper target.
|
||||||
|
|
||||||
.B thin_restore
|
.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
|
||||||
{-i|--input} {device|file}
|
Input file or device with metadata.
|
||||||
{-o|--output} {device|file}
|
|
||||||
|
|
||||||
.B thin_restore
|
.IP "\fB\-o, \-\-output\fP \fI{device|file}\fP"
|
||||||
-h|--help
|
Output file or device.
|
||||||
|
|
||||||
.B thin_dump
|
.IP "\fB\-h, \-\-help\fP"
|
||||||
{-V|--version}
|
Print help and exit.
|
||||||
|
|
||||||
|
.IP "\fB\-V, \-\-version\fP"
|
||||||
|
Output version information and exit.
|
||||||
|
|
||||||
.SH EXAMPLE
|
.SH EXAMPLE
|
||||||
"thin_restore -i metadata -o /dev/vg/metadata"
|
Restores the XML formatted thin provisioning metadata on file
|
||||||
restores the XML formatted thin provisioning metadata on file "metadata"
|
.B metadata
|
||||||
to logical volume /dev/vg/metadata for further processing by the
|
to logical volume /dev/vg/metadata for further processing by the
|
||||||
respective device-mapper target.
|
respective device-mapper target:
|
||||||
|
.sp
|
||||||
|
.B thin_restore -i metadata -o /dev/vg/metadata
|
||||||
|
|
||||||
.SH DIAGNOSTICS
|
.SH DIAGNOSTICS
|
||||||
thin_dump returns an exit code of 0 for success or 1 for error.
|
.B thin_dump
|
||||||
|
returns an exit code of 0 for success or 1 for error.
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.B thin_dump(8), thin_repair(8)
|
.B thin_dump(8)
|
||||||
|
.B thin_check(8)
|
||||||
|
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
Joe Thornber <ejt@redhat.com>
|
Joe Thornber <ejt@redhat.com>
|
||||||
|
Loading…
Reference in New Issue
Block a user