[man pages] fix some formatting issues with the new man pages.
This commit is contained in:
parent
dd8848f088
commit
5814fea96a
@ -255,13 +255,7 @@ TOOLS:=\
|
||||
era_check \
|
||||
era_dump \
|
||||
era_invalidate \
|
||||
era_restore \
|
||||
ifeq ("@DEVTOOLS", "yes")
|
||||
thin_show_duplicates \
|
||||
thin_ll_dump \
|
||||
thin_generate_metadata \
|
||||
thin_scan
|
||||
endif
|
||||
era_restore
|
||||
|
||||
MANPAGES:=$(patsubst %,man8/%.8,$(TOOLS))
|
||||
|
||||
|
@ -11,9 +11,9 @@ DESCRIPTION
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-q, --quiet Suppress output messages, return only exit code.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Output version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Output version information and exit.
|
||||
-q, --quiet Suppress output messages, return only exit code.
|
||||
--super-block-only Only check the superblock.
|
||||
--skip-hints Skip checking of the policy hint values metadata.
|
||||
--skip-discards Skip checking of the discard bits in the metadata.
|
||||
|
@ -7,17 +7,17 @@ SYNOPSIS
|
||||
DESCRIPTION
|
||||
cache_dump dumps binary cache metadata created by the device-mapper cache
|
||||
target on a device or file to standard output for analysis or postprocessing
|
||||
in XML format. XML formatted metadata can be fed into cache_restore in order
|
||||
in XML format. XML formatted metadata can be fed into cache_restore in order
|
||||
to put it back onto a metadata device (to process by the device-mapper
|
||||
target), or file.
|
||||
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-r, --repair Repair the metadata whilst dumping it.
|
||||
-o {xml file> Specify an output file for the xml, rather than printing to stdout.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-r, --repair Repair the metadata whilst dumping it.
|
||||
-o {xml file} Specify an output file for the xml, rather than printing to stdout.
|
||||
|
||||
EXAMPLES
|
||||
Dumps the cache metadata on logical volume /dev/vg/metadata to standard
|
||||
@ -26,7 +26,7 @@ EXAMPLES
|
||||
$ cache_dump /dev/vg/metadata
|
||||
|
||||
Dumps the cache metadata on logical volume /dev/vg/metadata whilst repairing
|
||||
it to standard output in XML format: .sp
|
||||
it to standard output in XML format:
|
||||
|
||||
$ cache_dump --repair /dev/vg/metadata
|
||||
|
||||
|
@ -21,6 +21,7 @@ OPTIONS
|
||||
|
||||
EXAMPLE
|
||||
$ cache_metadata_size --nr-blocks 10240
|
||||
|
||||
$ cache_metadata_size --block-size 128 --device-size 1024000
|
||||
|
||||
SEE ALSO
|
||||
|
@ -7,14 +7,14 @@ SYNOPSIS
|
||||
DESCRIPTION
|
||||
cache_repair reads binary cache metadata created by the respective
|
||||
device-mapper target from one device or file, repairs it and writes it to
|
||||
another device or file. If written to a metadata device, the metadata can
|
||||
another device or file. If written to a metadata device, the metadata can
|
||||
be processed by the device-mapper target.
|
||||
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-i, --input {device|file} Input file or device containing binary metadata.
|
||||
-o, --output {device|file} Output file or device for repaired binary metadata.
|
||||
|
||||
|
@ -14,9 +14,9 @@ DESCRIPTION
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Don't print any output. Check the exit code to test for success.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Don't print any output. Check the exit code to test for success.
|
||||
-i, --input {xml file} Input xml.
|
||||
-o, --output {device|file} Output file or device for restored binary metadata.
|
||||
|
||||
@ -30,7 +30,7 @@ DEBUGGING OPTIONS
|
||||
--omit-clean-shutdown Don't set the clean shutdown flag.
|
||||
|
||||
EXAMPLE
|
||||
Restores the XML formatted cache metadata on file .B metadata to logical
|
||||
Restores the XML formatted cache metadata on file metadata to logical
|
||||
volume /dev/vg/metadata for further processing by the respective
|
||||
device-mapper target:
|
||||
|
||||
|
@ -6,20 +6,20 @@ SYNOPSIS
|
||||
|
||||
DESCRIPTION
|
||||
cache_writeback is an offline tool that writes back dirty data to the data
|
||||
device (origin). Intended for use in recovery scenarios when the SSD is
|
||||
device (origin). Intended for use in recovery scenarios when the SSD is
|
||||
giving IO errors.
|
||||
|
||||
This tool cannot be run on a live cache.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
--metadata-device {device|file} Location of cache metadata.
|
||||
--origin-device {device|file} Slow device being cached.
|
||||
--fast-device {device|file} Fast device containing the data that needs to be written back.
|
||||
--no-metadata-update Do not update the metadata to clear the dirty flags.
|
||||
|
||||
You may want to use this flag if you're decommissioning the cache.
|
||||
You may want to use this flag if you're decommissioning the cache.
|
||||
|
||||
--buffer-size-meg {size} Specify the size for the metadata cache.
|
||||
|
||||
|
@ -11,9 +11,9 @@ DESCRIPTION
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Suppress output messages, return only exit code.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Suppress output messages, return only exit code.
|
||||
--super-block-only Only check the superblock is present.
|
||||
|
||||
EXAMPLE
|
||||
|
@ -7,17 +7,17 @@ SYNOPSIS
|
||||
DESCRIPTION
|
||||
era_dump dumps binary era metadata created by the device-mapper era target on
|
||||
a device or file to standard output for analysis or postprocessing in
|
||||
XML format. XML formated metadata can be fed into era_restore (see
|
||||
XML format. XML formated metadata can be fed into era_restore (see
|
||||
era_restore(8)) in order to put it back onto a metadata device (to process by
|
||||
the device-mapper target) or file.
|
||||
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
--repair Repair the metadata whilst dumping it.
|
||||
--logical Fold any unprocessed write sets into the final era array.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
--repair Repair the metadata whilst dumping it.
|
||||
--logical 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.
|
||||
|
@ -12,8 +12,8 @@ DESCRIPTION
|
||||
used.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-o {output file} Write output to a file rather than stdout.
|
||||
--metadata-snapshot Use the metadata snapshot rather than the current superblock.
|
||||
--written-since Blocks written since the given era will be listed.
|
||||
|
@ -6,17 +6,17 @@ SYNOPSIS
|
||||
|
||||
DESCRIPTION
|
||||
era_restore restores era metadata created by the respective device-mapper
|
||||
target dumped into an XML formatted (see .BR era_dump(8)) file, which
|
||||
target dumped into an XML formatted (see era_dump(8)) file, which
|
||||
optionally can be preprocessed before the restore to another device or
|
||||
file. If restored to a metadata device, the metadata can be processed by
|
||||
file. If restored to a metadata device, the metadata can be processed by
|
||||
the device-mapper target.
|
||||
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Don't print any output. Check the exit code to test for success.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Don't print any output. Check the exit code to test for success.
|
||||
-i, --input {xml file} Specify input file containing xml metadata.
|
||||
-o, --output {device|file} Output device or file for restored binary metadata.
|
||||
|
||||
|
@ -17,8 +17,8 @@ DESCRIPTION
|
||||
option is used.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-f, --format {xml|human_readable|custom} Choose output format.
|
||||
|
||||
Custom formats are supported via shared library plugins. They should be
|
||||
@ -26,7 +26,7 @@ OPTIONS
|
||||
|
||||
$ thin_dump --format custom=mylib.so /dev/sda
|
||||
|
||||
-r, --repair Repair the metadata whilst dumping it.
|
||||
-r, --repair Repair the metadata whilst dumping it.
|
||||
-m, --metadata-snap {block nr} Dump metadata snapshot.
|
||||
|
||||
If block is not provided, access the default metadata snapshot created by
|
||||
@ -62,7 +62,7 @@ DIAGNOSTICS
|
||||
thin_dump returns an exit code of 0 for success or 1 for error.
|
||||
|
||||
SEE ALSO
|
||||
thin_check(8) .B thin_repair(8) .B thin_restore(8) .B thin_rmap(8) .B thin_metadata_size(8)
|
||||
thin_check(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)
|
||||
|
||||
AUTHOR
|
||||
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>
|
||||
|
@ -5,16 +5,16 @@ SYNOPSIS
|
||||
thin_ls [options] {device|file}
|
||||
|
||||
DESCRIPTION
|
||||
thin_ls displays infomation about thin volumes in a pool. Pass the metadata
|
||||
thin_ls displays infomation about thin volumes in a pool. Pass the metadata
|
||||
device on the command line, not the pool device.
|
||||
|
||||
This tool cannot be run on live metadata unless the --metadata-snap
|
||||
option is used.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-o, --format Give a comma separated list of fields to be output.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-o, --format Give a comma separated list of fields to be output.
|
||||
|
||||
Valid fields are:
|
||||
DEV, MAPPED_BLOCKS, EXCLUSIVE_BLOCKS, SHARED_BLOCKS, MAPPED_SECTORS,
|
||||
@ -22,7 +22,7 @@ OPTIONS
|
||||
SHARED_BYTES, MAPPED, EXCLUSIVE, SHARED, TRANSACTION, CREATE_TIME,
|
||||
SNAP_TIME
|
||||
|
||||
--no-headers Don't output headers.
|
||||
--no-headers Don't output headers.
|
||||
-m, --metadata-snap Use metadata snapshot.
|
||||
|
||||
If you want to get information out of a live pool then you will need to
|
||||
|
@ -8,36 +8,36 @@ DESCRIPTION
|
||||
thin_metadata_size calculates the size of the thin provisioning metadata
|
||||
based on the block size of the thin provisioned devices, the size of the thin
|
||||
provisioning pool and the maximum number of all thin provisioned devices and
|
||||
snapshots. Because thin provisioning pools are holding widely variable
|
||||
snapshots. Because thin provisioning pools are holding widely variable
|
||||
contents, this tool is needed to provide sensible initial default size.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-b, --block-size {BLOCKSIZE[bskKmMgGtTpPeEzZyY]} Set block size.
|
||||
|
||||
Block size of thin provisioned devices in units of bytes, sectors,
|
||||
kibibytes, kilobytes, ... respectively. Default is in sectors without a
|
||||
block size unit specifier. Size/number option arguments can be followed by
|
||||
kibibytes, kilobytes, ... respectively. Default is in sectors without a
|
||||
block size unit specifier. Size/number option arguments can be followed by
|
||||
unit specifiers in short one character and long form (eg. -b1m or
|
||||
-b1mebibytes).
|
||||
|
||||
-s, --pool-size {POOLSIZE[bskKmMgGtTpPeEzZyY]} Set pool size.
|
||||
|
||||
Thin provisioning pool size in units of bytes, sectors, kibibytes,
|
||||
kilobytes, ... respectively. Default is in sectors without a pool size
|
||||
kilobytes, ... respectively. Default is in sectors without a pool size
|
||||
unit specifier.
|
||||
|
||||
-m, --max-thins {count[bskKmMgGtTpPeEzZyY]} Set max thins.
|
||||
|
||||
Maximum sum of all thin provisioned devices and snapshots. Unit identifier
|
||||
Maximum sum of all thin provisioned devices and snapshots. Unit identifier
|
||||
supported to allow for convenient entry of large quantities, eg. 1000000 =
|
||||
1M. Default is absolute quantity without a number unit specifier.
|
||||
1M. Default is absolute quantity without a number unit specifier.
|
||||
|
||||
-u, --unit {bskKmMgGtTpPeEzZyY}
|
||||
|
||||
Output unit specifier in units of bytes, sectors, kibibytes, kilobytes, ...
|
||||
respectively. Default is in sectors without an output unit specifier.
|
||||
respectively. Default is in sectors without an output unit specifier.
|
||||
|
||||
-n, --numeric-only {short|long} Limit output to just the size number.
|
||||
|
||||
|
@ -7,14 +7,14 @@ SYNOPSIS
|
||||
DESCRIPTION
|
||||
thin_repair reads binary thin provisioning metadata created by the respective
|
||||
device-mapper target from one device or file, repairs it and writes it
|
||||
to different device or file. If written to a metadata device, the metadata
|
||||
to different device or file. If written to a metadata device, the metadata
|
||||
can be processed by the device-mapper target.
|
||||
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-i, --input {device|file} Input file or device with binary data.
|
||||
-o, --output {device|file} Output file or device for binary data.
|
||||
|
||||
|
@ -8,15 +8,15 @@ DESCRIPTION
|
||||
thin_restore restores thin provisioning metadata created by the respective
|
||||
device-mapper target dumped into an XML formatted (see thin_dump(8)) file,
|
||||
which optionally can be preprocessed before the restore to another device or
|
||||
file. If restored to a metadata device, the metadata can be processed by the
|
||||
file. If restored to a metadata device, the metadata can be processed by the
|
||||
device-mapper target.
|
||||
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Suppress output messages, return only exit code.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-q, --quiet Suppress output messages, return only exit code.
|
||||
-i, --input {xml file} Input file containing XML metadata.
|
||||
-o, --output {device|file} Output file or device for restored binary metadata.
|
||||
|
||||
|
@ -10,8 +10,8 @@ DESCRIPTION
|
||||
This tool cannot be run on live metadata.
|
||||
|
||||
OPTIONS
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
-h, --help Print help and exit.
|
||||
-V, --version Print version information and exit.
|
||||
--pool-inactive Indicates you are aware the pool should be inactive.
|
||||
|
||||
Suppresses a warning message and prompt.
|
||||
|
Loading…
Reference in New Issue
Block a user