Add era_dump man page.

This commit is contained in:
Joe Thornber 2014-08-05 15:43:54 +01:00
parent 460c0ef8d2
commit a2d6e86c51
1 changed files with 56 additions and 0 deletions

56
man8/era_dump.8 Normal file
View File

@ -0,0 +1,56 @@
.TH ERA_DUMP 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
.SH NAME
era_dump \- dump era metadata from device or file to standard output
.SH SYNOPSIS
.B era_dump
.RB [options]
.I {device|file}
.SH DESCRIPTION
.B era_dump
dumps binary era metadata created by the device-mapper
era target on a
.I device
or
.I file
to standard output for
analysis or postprocessing in XML format.
XML formated metadata can be fed into era_restore (see
.BR era_restore(8) )
in order to put it back onto a metadata
.I device
(to process by the device-mapper target) or
.I file.
.IP "\fB\-r, \-\-repair\fP".
Repair the metadata whilst dumping it.
.IP "\fB\-h, \-\-help\fP".
Print help and exit.
.IP "\fB\-V, \-\-version\fP".
Output version information and exit.
.IP "\fB\-\-logical\fP".
Fold any unprocessed write sets into the final era array. You
probably want to do this if you're intending to process the results as
it simplifies the XML.
.SH EXAMPLES
Dumps era metadata on logical volume /dev/vg/metadata
to standard output in XML format:
.sp
.B era_dump /dev/vg/metadata
.SH DIAGNOSTICS
.B era_dump
returns an exit code of 0 for success or 1 for error.
.SH SEE ALSO
.B era_check(8)
.B era_repair(8)
.B era_restore(8)
.B era_invalidate(8)
.SH AUTHOR
Joe Thornber <ejt@redhat.com>