emo/thin-provisioning-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat and fix man pages [Milan]

Browse Source
This commit is contained in:
Heinz Mauelshagen 2012-03-05 19:34:55 +01:00
parent af1af61735
commit 3c6a58fb5a
3 changed files with 82 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
man8/thin_check.8
View File

@ -1,36 +1,47 @@
.TH THIN_REPAIR 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
.SH NAME
thin_repair \- repair thin provisioning metadata on device or file
thin_check \- repair thin provisioning metadata on device or file
.SH SYNOPSIS
.B thin_repair {device|file}
.B thin_check
.RB [ options ]
.I {device|file}
.SH DESCRIPTION
thin_repair checks thin provisioning metadata created by
the device-mapper thin provisioning target on a device or file (see
.B thin_check
checks thin provisioning metadata created by
the device-mapper thin provisioning target on a
.I device
or
.I file.
See
.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.
.B thin_repair (device|file}
.SH OPTIONS
.IP "\fB\-h, \-\-help\fP"
Print help and exit.
.B thin_repair
{-h|--help}
.B thin_dump
{-V|--version}
.IP "\fB\-V, \-\-version\fP"
Output version information and exit.
.SH EXAMPLE
"thin_repair /dev/vg/metadata"
analyses and repairs thin provisioning metadata on logical volume
/dev/vg/metadata. The device may not be actively used by the target
Analyses and repairs thin provisioning metadata on logical volume
/dev/vg/metadata:
.sp
.B thin_repair /dev/vg/metadata
The device may not be actively used by the target
when repairing!
.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
.B thin_dump(8), thin_restore(8)
.B thin_dump(8)
.B thin_restore(8)
.SH AUTHOR
Joe Thornber <ejt@redhat.com>

47
man8/thin_dump.8
View File

@ -3,44 +3,49 @@
thin_dump \- dump thin provisioning metadata from device or file to standard output
.SH SYNOPSIS
.B thin_dump [options] {metadata device|file}
.B thin_dump
.RB [options]
.I {metadata device|file}
.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
analysis or postprocessing in either XML or human readable format.
XML formated metadata can be fed into thin_restore (see
.B thin_restore(8)
) in order to put it back onto a metadata device (to process by
.BR thin_restore(8) )
in order to put it back onto a metadata device (to process by
the device-mapper target) or file.
.B thin_dump
{-i|--input} {device|file}
[{-f|--format} {xml|human_readable}]
.IP "\fB\-f, \-\-format\fP \fI{xml|human_readable}\fP".
Print output in XML or human readable format.
.B thin_dump
{-r|--repair}
.IP "\fB\-r, \-\-repair\fP".
.B thin_dump
{-h|--help}
.IP "\fB\-h, \-\-help\fP".
Print help and exit.
.B thin_dump
{-V|--version}
.IP "\fB\-V, \-\-version\fP".
Output version information and exit.
.SH EXAMPLES
"thin_dump -f human_redable -i /dev/vg/metadata"
dumps the thin provisioning metadata on logical volume /dev/vg/metadata
to standard output in human readable format.
Dumps the thin provisioning metadata on logical volume /dev/vg/metadata
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
to standard output in XML format.
Dumps the thin provisioning metadata on logical volume /dev/vg/metadata
to standard output in XML format:
.sp
.B thin_dump /dev/vg/metadata
.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
.B thin_repair(8), thin_restore(8)
.B thin_check(8)
.B thin_restore(8)
.SH AUTHOR
Joe Thornber <ejt@redhat.com>

46
man8/thin_restore.8
View File

@ -3,37 +3,49 @@
thin_restore \- restore thin provisioning metadata file to device or file
.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
thin_restore restores thin provisioning metadata created by the
respective device-mapper target dumped into an XML formated (see
.B thin_dump(8)
) file, which optionally can be preproccessed to another device or file.
.B thin_restore
restores thin provisioning metadata created by the
respective device-mapper target dumped into an XML formatted (see
.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
by the device-mapper target.
.B thin_restore
{-i|--input} {device|file}
{-o|--output} {device|file}
.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Input file or device with metadata.
.B thin_restore
-h|--help
.IP "\fB\-o, \-\-output\fP \fI{device|file}\fP"
Output file or device.
.B thin_dump
{-V|--version}
.IP "\fB\-h, \-\-help\fP"
Print help and exit.
.IP "\fB\-V, \-\-version\fP"
Output version information and exit.
.SH EXAMPLE
"thin_restore -i metadata -o /dev/vg/metadata"
restores the XML formatted thin provisioning metadata on file "metadata"
Restores the XML formatted thin provisioning metadata on file
.B metadata
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
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
.B thin_dump(8), thin_repair(8)
.B thin_dump(8)
.B thin_check(8)
.SH AUTHOR
Joe Thornber <ejt@redhat.com>