Man pages

This commit is contained in:
Heinz Mauelshagen 2011-12-15 13:56:48 +01:00
parent 79c26ee253
commit 977716d673
4 changed files with 118 additions and 1 deletions

43
man8/thin_dump.8 Normal file
View File

@ -0,0 +1,43 @@
.TH THIN-PROVISIONING-TOOLS 8 "Thin Provisioning Tools" "Red Hat GmbH" \" -*- nroff -*-
.SH NAME
thin_dump \- dump thin provisioning metadata from device or file to standard output
.SH SYNOPSIS
.B thin_dump [options] {metadata device|file}
.SH DESCRIPTION
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 redable 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
the device-mapper target) or file.
.B thin_dump
{-i|--input} {device|file}
[{-f|--format} {xml|human_readable}]
.B thin_dump
{-h|--help}
.B thin_dump
{-V|--version}
.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.
"thin_dump /dev/vg/metadata"
dumps the thin provisioning metadata on logical volume /dev/vg/metadata
to standard output in XML format.
.SH DIAGNOSTICS
thin_dump returns an exit code of 0 for success or 1 for error.
.SH SEE ALSO
.B thin_repair(8), thin_restore(8)
.SH AUTHOR
Heinz Mauelshagen <HeinzM@RedHat.com>

35
man8/thin_repair.8 Normal file
View File

@ -0,0 +1,35 @@
.TH THIN-PROVISIONING-TOOLS 8 "Thin Provisioning Tools" "Red Hat GmbH" \" -*- nroff -*-
.SH NAME
thin_repair \- repair thin provisioning metadata on device or file
.SH SYNOPSIS
.B thin_repair {metadata device|file}
.SH DESCRIPTION
thin_repair analyses and repairs thin provisioning metadata created by
the device-mapper thin provisioning target on a device or file (see
.B thin_dump(8)
) on how to dump metadata to a file.
.B thin_repair (device|file}
.B thin_repair
{-h|--help}
.B thin_dump
{-V|--version}
.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
when repairing!
.SH DIAGNOSTICS
thin_repair returns an exit code of 0 for success or 1 for error.
.SH SEE ALSO
.B thin_dump(8), thin_restore(8)
.SH AUTHOR
Heinz Mauelshagen <HeinzM@RedHat.com>

39
man8/thin_restore.8 Normal file
View File

@ -0,0 +1,39 @@
.TH THIN-PROVISIONING-TOOLS 8 "Thin Provisioning Tools" "Red Hat GmbH" \" -*- nroff -*-
.SH NAME
thin_restore \- restore thin provisioning metadata file to device or file
.SH SYNOPSIS
.B thin_restore [options] file {metadata 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.
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}
.B thin_restore
-h|--help
.B thin_dump
{-V|--version}
.SH EXAMPLE
"thin_restore -i metadata -o /dev/vg/metadata"
restores the XML formatted thin provisioning metadata on file "metadata"
to logical volume /dev/vg/metadata for further processing by the
respective device-mapper target.
.SH DIAGNOSTICS
thin_dump returns an exit code of 0 for success or 1 for error.
.SH SEE ALSO
.B thin_dump(8), thin_repair(8)
.SH AUTHOR
Heinz Mauelshagen <HeinzM@RedHat.com>

View File

@ -28,7 +28,7 @@ manage device-mapper thin provisioning target metadata devices.
%define _sbindir /usr/sbin %define _sbindir /usr/sbin
%define _libdir /%{_lib} %define _libdir /%{_lib}
%configure --enable-testing %configure
%install %install
make install make install