1
0
mirror of git://sourceware.org/git/lvm2.git synced 2025-01-03 05:18:29 +03:00

man: better formatting for lvm dumpconfig man page

This commit is contained in:
Peter Rajnoha 2014-03-27 14:18:41 +01:00
parent 801d43445d
commit 6d314466f3

View File

@ -6,7 +6,7 @@ lvm-dumpconfig \- dump LVM configuration
.RB [ \-f | \-\-file ]
.IR filename ]
.RB [ \-\-type
.IR {current|default|diff|missing|new|profilable}
.RI { current | default | diff | missing | new | profilable }
.RB [ \-\-atversion
.IR version ]
.RB [ \-\-ignoreadvanced ]
@ -21,11 +21,12 @@ lvm-dumpconfig \- dump LVM configuration
lvm dumpconfig produces formatted output with LVM configuration tree.
.SH OPTIONS
.IP "\fB\-f, \-\-file\fP \fI filename"
.TP
.BR \-f ", " \-\-file " \fIfilename"
Dump configuration to a file named 'filename'.
.IP "\fB\-\-type\fP \fI {current|default|diff|missing|new|profilable}"
.TP
.IR \fB\-\-type " {" current | default | diff | missing | new | profilable }
Select the type of configuration to dump. The configuration settings dumped
have either default values or currently used values assigned based on the
type selected (if no type is selected, \fB\-\-type current\fP is used
@ -56,7 +57,8 @@ Dump all profilable configuration settings with default values assigned.
See \fBlvm.conf\fP(5) for more info about \fBprofile config\fP method.
.RE
.IP "\fB\-\-atversion\fP version"
.TP
.BI \-\-atversion " version"
Specify an LVM version in x.y.z format where x is the major version,
the y is the minor version and z is the patchlevel (e.g. 2.2.106).
When configuration is dumped, the configuration settings recognized
@ -65,30 +67,36 @@ to dump a configuration that certain LVM version understands and
which does not contain any newer settings for which LVM would
issue a warning message when checking the configuration.
.IP "\fB\-\-ignoreadvanced\fP"
.TP
.B \-\-ignoreadvanced
Ignore advanced configuration settings on dump.
.IP "\fB\-\-ignoreunsupported\fP"
.TP
.B \-\-ignoreunsupported
Ignore unsupported configuration settings on dump. These settings are
either used for debugging purposes only or their support is not yet
complete and they are not meant to be used in production.
.IP "\fB\-\-mergedconfig\fP"
.TP
.B \-\-mergedconfig
When the dumpconfig command is run with the \fB\-\-config\fP option
(a common option that is recognized by all LVM tools, see also
\fBlvm\fP(8)), merge this configuration with current configuration
used (see \fB\-\-type current\fP above). Otherwise, only the
configuration specified within \fB\-\-config\fP option is dumped.
.IP "\fB\-\-validate\fP"
.TP
.B \-\-validate
Validate current configuration used and exit with appropriate
return code. The validation is done even if \fBconfig/checks\fP
\fBlvm.conf\fP(5) option is disabled.
.IP "\fB\-\-withcomments\fP"
.TP
.B \-\-withcomments
Also dump comments for each configuration node.
.IP "\fB\-\-withversions\fP"
.TP
.B \-\-withversions
Also dump a comment containing the version of introduction for
each configuration node.