Heinz Mauelshagen dcf7329
diff --git a/man8/cache_check.8 b/man8/cache_check.8
Heinz Mauelshagen dcf7329
new file mode 100644
Heinz Mauelshagen dcf7329
index 0000000..5cc7dff
Heinz Mauelshagen dcf7329
--- /dev/null
Heinz Mauelshagen dcf7329
+++ b/man8/cache_check.8
Heinz Mauelshagen dcf7329
@@ -0,0 +1,62 @@
Heinz Mauelshagen dcf7329
+.TH CACHE_CHECK 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
Heinz Mauelshagen dcf7329
+.SH NAME
Heinz Mauelshagen dcf7329
+cache_check \- repair cache metadata on device or file
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SYNOPSIS
Heinz Mauelshagen dcf7329
+.B cache_check
Heinz Mauelshagen dcf7329
+.RB [ options ]
Heinz Mauelshagen dcf7329
+.I {device|file}
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DESCRIPTION
Heinz Mauelshagen dcf7329
+.B cache_check
Heinz Mauelshagen dcf7329
+checks cache  metadata created by
Heinz Mauelshagen dcf7329
+the device-mapper cache target on a
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+or
Heinz Mauelshagen dcf7329
+.I file.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH OPTIONS
Heinz Mauelshagen dcf7329
+.IP "\fB\-q, \-\-quiet\fP"
Heinz Mauelshagen dcf7329
+Suppress output messages, return only exit code.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-h, \-\-help\fP"
Heinz Mauelshagen dcf7329
+Print help and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-V, \-\-version\fP"
Heinz Mauelshagen dcf7329
+Output version information and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-\-super\-block\-only\fP"
Heinz Mauelshagen dcf7329
+Only check the superblock is present.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-\-skip-mappings\fP"
Heinz Mauelshagen dcf7329
+Skip checking of the block mappings which make up the bulk of the
Heinz Mauelshagen dcf7329
+metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-\-skip-hints\fP"
Heinz Mauelshagen dcf7329
+Skip checking of the policy hint values metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-\-skip-discards\fP"
Heinz Mauelshagen dcf7329
+Skip checking of the discard bits in the metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH EXAMPLE
Heinz Mauelshagen dcf7329
+Analyses and repairs cache metadata on logical volume
Heinz Mauelshagen dcf7329
+/dev/vg/metadata:
Heinz Mauelshagen dcf7329
+.sp
Heinz Mauelshagen dcf7329
+.B cache_check /dev/vg/metadata
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+The device may not be actively used by the target
Heinz Mauelshagen dcf7329
+when running.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DIAGNOSTICS
Heinz Mauelshagen dcf7329
+.B cache_check
Heinz Mauelshagen dcf7329
+returns an exit code of 0 for success or 1 for error.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SEE ALSO
Heinz Mauelshagen dcf7329
+.B cache_dump(8)
Heinz Mauelshagen dcf7329
+.B cache_repair(8)
Heinz Mauelshagen dcf7329
+.B cache_restore(8)
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH AUTHOR
Heinz Mauelshagen dcf7329
+Joe Thornber <ejt@redhat.com>
Heinz Mauelshagen dcf7329
+.br
Heinz Mauelshagen dcf7329
+Heinz Mauelshagen <HeinzM@RedHat.com>
Heinz Mauelshagen dcf7329
diff --git a/man8/cache_dump.8 b/man8/cache_dump.8
Heinz Mauelshagen dcf7329
new file mode 100644
Heinz Mauelshagen dcf7329
index 0000000..a0c2924
Heinz Mauelshagen dcf7329
--- /dev/null
Heinz Mauelshagen dcf7329
+++ b/man8/cache_dump.8
Heinz Mauelshagen dcf7329
@@ -0,0 +1,59 @@
Heinz Mauelshagen dcf7329
+.TH CACHE_DUMP 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
Heinz Mauelshagen dcf7329
+.SH NAME
Heinz Mauelshagen dcf7329
+cache_dump \- dump cache metadata from device or file to standard output
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SYNOPSIS
Heinz Mauelshagen dcf7329
+.B cache_dump
Heinz Mauelshagen dcf7329
+.RB [options]
Heinz Mauelshagen dcf7329
+.I {device|file}
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DESCRIPTION
Heinz Mauelshagen dcf7329
+.B cache_dump
Heinz Mauelshagen dcf7329
+dumps binary cache metadata created by
Heinz Mauelshagen dcf7329
+the device-mapper cache target on a
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+or
Heinz Mauelshagen dcf7329
+.I file
Heinz Mauelshagen dcf7329
+to standard output for
Heinz Mauelshagen dcf7329
+analysis or postprocessing in XML format.
Heinz Mauelshagen dcf7329
+XML formated metadata can be fed into cache_restore (see
Heinz Mauelshagen dcf7329
+.BR cache_restore(8) )
Heinz Mauelshagen dcf7329
+in order to put it back onto a metadata
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+(to process by the device-mapper target) or
Heinz Mauelshagen dcf7329
+.I file.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-r, \-\-repair\fP".
Heinz Mauelshagen dcf7329
+Repair the metadata whilst dumping it.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-h, \-\-help\fP".
Heinz Mauelshagen dcf7329
+Print help and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-V, \-\-version\fP".
Heinz Mauelshagen dcf7329
+Output version information and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH EXAMPLES
Heinz Mauelshagen dcf7329
+Dumps the cache metadata on logical volume /dev/vg/metadata
Heinz Mauelshagen dcf7329
+to standard output in XML format:
Heinz Mauelshagen dcf7329
+.sp
Heinz Mauelshagen dcf7329
+.B cache_dump /dev/vg/metadata
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH EXAMPLES
Heinz Mauelshagen dcf7329
+Dumps the cache metadata on logical volume /dev/vg/metadata
Heinz Mauelshagen dcf7329
+whilst repairing it to standard output in XML format:
Heinz Mauelshagen dcf7329
+.sp
Heinz Mauelshagen dcf7329
+.B cache_dump --repair /dev/vg/metadata
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DIAGNOSTICS
Heinz Mauelshagen dcf7329
+.B cache_dump
Heinz Mauelshagen dcf7329
+returns an exit code of 0 for success or 1 for error.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SEE ALSO
Heinz Mauelshagen dcf7329
+.B cache_check(8)
Heinz Mauelshagen dcf7329
+.B cache_repair(8)
Heinz Mauelshagen dcf7329
+.B cache_restore(8)
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH AUTHOR
Heinz Mauelshagen dcf7329
+Joe Thornber <ejt@redhat.com>
Heinz Mauelshagen dcf7329
+.br
Heinz Mauelshagen dcf7329
+Heinz Mauelshagen <HeinzM@RedHat.com>
Heinz Mauelshagen dcf7329
diff --git a/man8/cache_repair.8 b/man8/cache_repair.8
Heinz Mauelshagen dcf7329
new file mode 100644
Heinz Mauelshagen dcf7329
index 0000000..ef04a7f
Heinz Mauelshagen dcf7329
--- /dev/null
Heinz Mauelshagen dcf7329
+++ b/man8/cache_repair.8
Heinz Mauelshagen dcf7329
@@ -0,0 +1,61 @@
Heinz Mauelshagen dcf7329
+.TH CACHE_REPAIR 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
Heinz Mauelshagen dcf7329
+.SH NAME
Heinz Mauelshagen dcf7329
+cache_repair \- repair cache binary metadata from device/file to device/file
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SYNOPSIS
Heinz Mauelshagen dcf7329
+.B cache_repair
Heinz Mauelshagen dcf7329
+.RB [ options ]
Heinz Mauelshagen dcf7329
+.RB -i
Heinz Mauelshagen dcf7329
+.I {device|file}
Heinz Mauelshagen dcf7329
+.RB -o
Heinz Mauelshagen dcf7329
+.I {device|file}
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DESCRIPTION
Heinz Mauelshagen dcf7329
+.B cache_repair
Heinz Mauelshagen dcf7329
+reads binary cache metadata created by the
Heinz Mauelshagen dcf7329
+respective device-mapper target from one
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+or
Heinz Mauelshagen dcf7329
+.I file
Heinz Mauelshagen dcf7329
+, repairs it and writes it to another
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+or
Heinz Mauelshagen dcf7329
+.I file.
Heinz Mauelshagen dcf7329
+If written to a metadata
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+, the metadata can be processed
Heinz Mauelshagen dcf7329
+by the device-mapper target.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Heinz Mauelshagen dcf7329
+Input file or device with binary metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-o, \-\-output\fP \fI{device|file}\fP"
Heinz Mauelshagen dcf7329
+Output file or device for repaired binary metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-h, \-\-help\fP"
Heinz Mauelshagen dcf7329
+Print help and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-V, \-\-version\fP"
Heinz Mauelshagen dcf7329
+Output version information and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH EXAMPLE
Heinz Mauelshagen dcf7329
+Reads the binary cache metadata from file
Heinz Mauelshagen dcf7329
+.B metadata
Heinz Mauelshagen dcf7329
+, repairs it and writes it to logical volume /dev/vg/metadata
Heinz Mauelshagen dcf7329
+for further processing by the respective device-mapper target:
Heinz Mauelshagen dcf7329
+.sp
Heinz Mauelshagen dcf7329
+.B cache_repair -i metadata -o /dev/vg/metadata
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DIAGNOSTICS
Heinz Mauelshagen dcf7329
+.B cache_repair
Heinz Mauelshagen dcf7329
+returns an exit code of 0 for success or 1 for error.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SEE ALSO
Heinz Mauelshagen dcf7329
+.B cache_dump(8)
Heinz Mauelshagen dcf7329
+.B cache_check(8)
Heinz Mauelshagen dcf7329
+.B cache_restore(8)
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH AUTHOR
Heinz Mauelshagen dcf7329
+Joe Thornber <ejt@redhat.com>
Heinz Mauelshagen dcf7329
+.br
Heinz Mauelshagen dcf7329
+Heinz Mauelshagen <HeinzM@RedHat.com>
Heinz Mauelshagen dcf7329
diff --git a/man8/cache_restore.8 b/man8/cache_restore.8
Heinz Mauelshagen dcf7329
new file mode 100644
Heinz Mauelshagen dcf7329
index 0000000..5f9fdca
Heinz Mauelshagen dcf7329
--- /dev/null
Heinz Mauelshagen dcf7329
+++ b/man8/cache_restore.8
Heinz Mauelshagen dcf7329
@@ -0,0 +1,64 @@
Heinz Mauelshagen dcf7329
+.TH CACHE_RESTORE 8 "Thin Provisioning Tools" "Red Hat, Inc." \" -*- nroff -*-
Heinz Mauelshagen dcf7329
+.SH NAME
Heinz Mauelshagen dcf7329
+cache_restore \- restore cache metadata file to device or file
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SYNOPSIS
Heinz Mauelshagen dcf7329
+.B cache_restore
Heinz Mauelshagen dcf7329
+.RB [ options ]
Heinz Mauelshagen dcf7329
+.RB -i
Heinz Mauelshagen dcf7329
+.I {device|file}
Heinz Mauelshagen dcf7329
+.RB -o
Heinz Mauelshagen dcf7329
+.I {device|file}
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DESCRIPTION
Heinz Mauelshagen dcf7329
+.B cache_restore
Heinz Mauelshagen dcf7329
+restores cache metadata created by the respective
Heinz Mauelshagen dcf7329
+device-mapper target dumped into an XML formatted (see
Heinz Mauelshagen dcf7329
+.BR cache_dump(8) )
Heinz Mauelshagen dcf7329
+.I file
Heinz Mauelshagen dcf7329
+, which optionally can be preprocessed before the restore to another
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+or
Heinz Mauelshagen dcf7329
+.I file.
Heinz Mauelshagen dcf7329
+If restored to a metadata
Heinz Mauelshagen dcf7329
+.I device
Heinz Mauelshagen dcf7329
+, the metadata can be processed by the device-mapper target.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-i, \-\-input\fP \fI{device|file}\fP"
Heinz Mauelshagen dcf7329
+Input file or device with metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-o, \-\-output\fP \fI{device|file}\fP"
Heinz Mauelshagen dcf7329
+Output file or device.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB{\-\-debug-override-metadata-version}\fP \fI<integer>\fP"
Heinz Mauelshagen dcf7329
+ONLY FOR DEBUGGING PURPOSES:
Heinz Mauelshagen dcf7329
+.br
Heinz Mauelshagen dcf7329
+override the version stored in the metadata.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-h, \-\-help\fP"
Heinz Mauelshagen dcf7329
+Print help and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.IP "\fB\-V, \-\-version\fP"
Heinz Mauelshagen dcf7329
+Output version information and exit.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH EXAMPLE
Heinz Mauelshagen dcf7329
+Restores the XML formatted cache metadata on file
Heinz Mauelshagen dcf7329
+.B metadata
Heinz Mauelshagen dcf7329
+to logical volume /dev/vg/metadata for further processing by the
Heinz Mauelshagen dcf7329
+respective device-mapper target:
Heinz Mauelshagen dcf7329
+.sp
Heinz Mauelshagen dcf7329
+.B cache_restore -i metadata -o /dev/vg/metadata
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH DIAGNOSTICS
Heinz Mauelshagen dcf7329
+.B cache_restore
Heinz Mauelshagen dcf7329
+returns an exit code of 0 for success or 1 for error.
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH SEE ALSO
Heinz Mauelshagen dcf7329
+.B cache_dump(8)
Heinz Mauelshagen dcf7329
+.B cache_check(8)
Heinz Mauelshagen dcf7329
+.B cache_repair(8)
Heinz Mauelshagen dcf7329
+
Heinz Mauelshagen dcf7329
+.SH AUTHOR
Heinz Mauelshagen dcf7329
+Joe Thornber <ejt@redhat.com>
Heinz Mauelshagen dcf7329
+.br
Heinz Mauelshagen dcf7329
+Heinz Mauelshagen <HeinzM@RedHat.com>