1
0
mirror of git://sourceware.org/git/lvm2.git synced 2024-12-21 13:34:40 +03:00

man: updates

Continuing with lvconvert style updates.

Minimize usage of '\:' as zero-width break space, since html renderers
do not handle this groff sign well (some of them seems to even render
':' there).
But since we do not want see badly rendered man pages itself, prefer
the 'man visual' appearence over html page generation (man2html should
be actually fixed).

Start to use 'user input option' with Capitals more consistently.
This commit is contained in:
Zdenek Kabelac 2016-03-03 20:27:09 +01:00
parent 86a23b2145
commit 386208e593
4 changed files with 61 additions and 62 deletions

View File

@ -1,5 +1,6 @@
Version 2.02.146 - Version 2.02.146 -
================================= =================================
More man page cleanups in lvconvert.
Fix makefile vpath in /udev when generating udev rules files. Fix makefile vpath in /udev when generating udev rules files.
Another attempt to improve VG name parsing for lvconvert (2.02.144). Another attempt to improve VG name parsing for lvconvert (2.02.144).
Use new cache status info and skip flushing for failed cache. Use new cache status info and skip flushing for failed cache.

View File

@ -33,7 +33,7 @@ lvconvert \(em convert a logical volume from linear to mirror or snapshot
.RB [ \-y | \-\-yes ] .RB [ \-y | \-\-yes ]
.RB [ \-\-version ] .RB [ \-\-version ]
.IR LogicalVolume .IR LogicalVolume
.RI [ PhysicalVolume [ Path ]\:[ \fB: \fIPE \fR[ \fB\- PE ]]...] .RI \%[ PhysicalVolume [ Path ][ \fB: \fIPE \fR[ \fB\- PE ]]...]
.sp .sp
.B lvconvert .B lvconvert
.BR \-\-merge .BR \-\-merge
@ -90,7 +90,7 @@ lvconvert \(em convert a logical volume from linear to mirror or snapshot
.IR MirrorLogicalVolume .IR MirrorLogicalVolume
.RB [ \-\-commandprofile .RB [ \-\-commandprofile
.IR ProfileName ] .IR ProfileName ]
.RI [ SplittablePhysicalVolume [ Path ]\:[ \fB: \fIPE \fR[ \fB\- PE ]]...] .RI \%[ SplittablePhysicalVolume [ Path ][ \fB: \fIPE \fR[ \fB\- PE ]]...]
.sp .sp
.B lvconvert .B lvconvert
.BR \-\-splitsnapshot .BR \-\-splitsnapshot
@ -156,7 +156,7 @@ lvconvert \(em convert a logical volume from linear to mirror or snapshot
.RB [ \-v | \-\-verbose ] .RB [ \-v | \-\-verbose ]
.RB [ \-\-version ] .RB [ \-\-version ]
.IR LogicalVolume .IR LogicalVolume
.RI [ PhysicalVolume [ Path ]\:[ \fB: \fIPE \fR[ \fB\- PE ]]...] .RI \%[ PhysicalVolume [ Path ][ \fB: \fIPE \fR[ \fB\- PE ]]...]
.sp .sp
.B lvconvert .B lvconvert
.BR \-\-type .BR \-\-type
@ -179,7 +179,7 @@ lvconvert \(em convert a logical volume from linear to mirror or snapshot
.RB [ \-\-stripes .RB [ \-\-stripes
.IR Stripes .IR Stripes
.RB [ \-I | \-\-stripesize .RB [ \-I | \-\-stripesize
.IR StripeSize ]]] .IR StripeSize ]]
.RB [ \-\-poolmetadataspare .RB [ \-\-poolmetadataspare
.RB { y | n }] .RB { y | n }]
.RB [ \-Z | \-\-zero .RB [ \-Z | \-\-zero
@ -189,8 +189,8 @@ lvconvert \(em convert a logical volume from linear to mirror or snapshot
.RB [ \-h | \-? | \-\-help ] .RB [ \-h | \-? | \-\-help ]
.RB [ \-v | \-\-verbose ] .RB [ \-v | \-\-verbose ]
.RB [ \-\-version ] .RB [ \-\-version ]
.RI [[ ExternalOrigin | ThinPool ] LogicalVolume ] .RI [[ ExternalOrigin | ThinPool ] LogicalVolume
.RI [ PhysicalVolume [ Path ]\:[ \fB: \fIPE \fR[ \fB\- PE ]]...] .RI \%[ PhysicalVolume [ Path ][ \fB: \fIPE \fR[ \fB\- PE ]]...]]
.ad b .ad b
.sp .sp
. .
@ -257,14 +257,14 @@ version available in newer kernels.
. .
.HP .HP
.BR \-\-cachepool .BR \-\-cachepool
.IR CachePoolLV .IR CachePoolLogicalVolume { Name | Path }
.br .br
This argument is necessary when converting a logical volume to a cache LV. This argument is necessary when converting a logical volume to a cache LV.
For more information on cache pool LVs and cache LVs, see \fBlvmcache\fP(7). For more information on cache pool LVs and cache LVs, see \fBlvmcache\fP(7).
. .
.HP .HP
.BR \-\-cachesettings .BR \-\-cachesettings
.IR Key \fB= Value .IB Key = Value
.br .br
Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets
the cache tunable settings. In most use-cases, default values should be adequate. the cache tunable settings. In most use-cases, default values should be adequate.
@ -337,21 +337,6 @@ be specified on the commandline or a @tag may be used to specify
multiple snapshots be merged to their respective origin. multiple snapshots be merged to their respective origin.
. .
.HP .HP
.BR \-m ,
.BR \-\-mirrors
.IR Mirrors
.br
Specifies the degree of the mirror you wish to create.
For example, "\fB\-m 1\fP" would convert the original logical
volume to a mirror volume with 2-sides; that is, a
linear volume plus one copy. There are two implementations of mirroring
which correspond to the "\fIraid1\fP" and "\fImirror\fP" segment types. The default
mirroring segment type is "\fIraid1\fP". If the legacy "\fImirror\fP" segment type
is desired, the \fB\-\-type\fP argument must be used to explicitly
select the desired type. The \fB\-\-mirrorlog\fP and \fB\-\-corelog\fP
options below are only relevant to the legacy "\fImirror\fP" segment type.
.
.HP
.BR \-\-mirrorlog .BR \-\-mirrorlog
.RB { disk | core | mirrored } .RB { disk | core | mirrored }
.br .br
@ -365,6 +350,21 @@ time the device is activated - perhaps, for example, after every reboot.
Using \fBmirrored\fP will create a persistent log that is itself mirrored. Using \fBmirrored\fP will create a persistent log that is itself mirrored.
. .
.HP .HP
.BR \-m ,
.BR \-\-mirrors
.IR Mirrors
.br
Specifies the degree of the mirror you wish to create.
For example, "\fB\-m 1\fP" would convert the original logical
volume to a mirror volume with 2-sides; that is, a
linear volume plus one copy. There are two implementations of mirroring
which correspond to the \fBraid1\fP and \fBmirror\fP segment types. The default
mirroring segment type is \fBraid1\fP. If the legacy \fBmirror\fP" segment type
is desired, the \fB\-\-type\fP argument must be used to explicitly
select the desired type. The \fB\-\-mirrorlog\fP and \fB\-\-corelog\fP
options below are only relevant to the legacy \fBmirror\fP segment type.
.
.HP
.BR \-n , .BR \-n ,
.BR \-\-name .BR \-\-name
.IR Name .IR Name
@ -402,7 +402,7 @@ as it is being used as the external origin.
. .
.HP .HP
.BR \-\-poolmetadata .BR \-\-poolmetadata
.IR PoolMetadataLogicalVolume .IR PoolMetadataLogicalVolume { Name | Path }
.br .br
Specifies cache or thin pool metadata logical volume. Specifies cache or thin pool metadata logical volume.
The size should be in between 2MiB and 16GiB. The size should be in between 2MiB and 16GiB.
@ -500,15 +500,6 @@ This option is only available to RAID segment types
etc). etc).
. .
.HP .HP
.BR \-\-splitmirrors
.IR Images
.br
The number of redundant \fIImages\fP of a mirror to be split off and used
to form a new logical volume. A name must be supplied for the
newly-split-off logical volume using the \fB\-\-name\fP argument, unless
the \fB\-\-trackchanges\fP argument is given.
.
.HP
.BR \-s , .BR \-s ,
.BR \-\-snapshot , .BR \-\-snapshot ,
.BR \-\-type\ snapshot .BR \-\-type\ snapshot
@ -536,6 +527,15 @@ See also the option \fB\-\-uncache\fP for uncaching and removing
cache pool with one command. cache pool with one command.
. .
.HP .HP
.BR \-\-splitmirrors
.IR Images
.br
The number of redundant \fIImages\fP of a mirror to be split off and used
to form a new logical volume. A name must be supplied for the
newly-split-off logical volume using the \fB\-\-name\fP argument, unless
the \fB\-\-trackchanges\fP argument is given.
.
.HP
.BR \-\-splitsnapshot .BR \-\-splitsnapshot
.br .br
Separates \fISnapshotLogicalVolume\fP from its origin. Separates \fISnapshotLogicalVolume\fP from its origin.
@ -567,8 +567,7 @@ power of 2 but must not exceed the physical extent size.
.HP .HP
.BR \-T , .BR \-T ,
.BR \-\-thin , .BR \-\-thin ,
.BR \-\-type .BR \-\-type\ thin
.BR thin
.br .br
Converts the logical volume into a thin logical volume of the thin pool Converts the logical volume into a thin logical volume of the thin pool
specified with \fB\-\-thinpool\fP. The original logical volume specified with \fB\-\-thinpool\fP. The original logical volume
@ -580,7 +579,7 @@ external origin volume for unprovisioned areas of any thin logical volume.
. .
.HP .HP
.BR \-\-thinpool .BR \-\-thinpool
.IR ThinPoolLogicalVolume .IR ThinPoolLogicalVolume { Name | Path }
.br .br
Specifies or converts logical volume into a thin pool's data volume. Specifies or converts logical volume into a thin pool's data volume.
Content of converted volume is lost. Content of converted volume is lost.

View File

@ -31,11 +31,11 @@ lvcreate \- create a logical volume in an existing volume group
.RB [ \-\-cachemode .RB [ \-\-cachemode
.RB { passthrough | writeback | writethrough }] .RB { passthrough | writeback | writethrough }]
.RB [ \-\-cachepolicy .RB [ \-\-cachepolicy
.IR policy ] .IR Policy ]
.RB \%[ \-\-cachepool .RB \%[ \-\-cachepool
.IR CachePoolLogicalVolume ] .IR CachePoolLogicalVolume ]
.RB [ \-\-cachesettings .RB [ \-\-cachesettings
.IR key \fB= value ] .IR Key \fB= Value ]
.RB [ \-c | \-\-chunksize .RB [ \-c | \-\-chunksize
.IR ChunkSize ] .IR ChunkSize ]
.RB [ \-\-commandprofile .RB [ \-\-commandprofile
@ -60,9 +60,9 @@ lvcreate \- create a logical volume in an existing volume group
.RB [ \-K | \-\-ignoreactivationskip ] .RB [ \-K | \-\-ignoreactivationskip ]
.RB [ \-\-ignoremonitoring ] .RB [ \-\-ignoremonitoring ]
.RB [ \-\-minor .RB [ \-\-minor
.IR minor .IR Minor
.RB [ \-j | \-\-major .RB [ \-j | \-\-major
.IR major ]] .IR Major ]]
.RB [ \-\-metadataprofile .RB [ \-\-metadataprofile
.IR Profile\%Name ] .IR Profile\%Name ]
.RB [ \-m | \-\-mirrors .RB [ \-m | \-\-mirrors
@ -109,10 +109,10 @@ lvcreate \- create a logical volume in an existing volume group
.RB { y | n }] .RB { y | n }]
.RB [ \-Z | \-\-zero .RB [ \-Z | \-\-zero
.RB { y | n }] .RB { y | n }]
.RI [ VolumeGroup \c .RI [ VolumeGroup
.RB [ / \c .RI |
.RI { ExternalOrigin | Origin | Pool } LogicalVolumeName .RI \%{ ExternalOrigin | Origin | Pool } LogicalVolume
.RI [ PhysicalVolumePath [ \fB: \fIPE \fR[ \fB\- PE ]]...]] .RI \%[ PhysicalVolumePath [ \fB: \fIPE \fR[ \fB\- PE ]]...]]
.LP .LP
.B lvcreate .B lvcreate
.RB [ \-l | \-\-extents .RB [ \-l | \-\-extents
@ -132,7 +132,7 @@ lvcreate \- create a logical volume in an existing volume group
.RB \%[ \-\-monitor .RB \%[ \-\-monitor
.RB { y | n }] .RB { y | n }]
.RB [ \-n | \-\-name .RB [ \-n | \-\-name
.IR SnapshotLogicalVolume ] .IR SnapshotLogicalVolumeName ]
.BR \-s | \-\-snapshot | \-H | \-\-cache .BR \-s | \-\-snapshot | \-H | \-\-cache
.RI \%{[ VolumeGroup \fB/\fP] OriginalLogicalVolume .RI \%{[ VolumeGroup \fB/\fP] OriginalLogicalVolume
.RB \%[ \-V | \-\-virtualsize .RB \%[ \-V | \-\-virtualsize
@ -223,7 +223,7 @@ cache pool LV.
. .
.HP .HP
.BR \-\-cachepolicy .BR \-\-cachepolicy
.IR policy .IR Policy
.br .br
Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets
the cache policy. \fBmq\fP is the basic policy name. \fBsmq\fP is more advanced the cache policy. \fBmq\fP is the basic policy name. \fBsmq\fP is more advanced
@ -238,7 +238,7 @@ is to append name to Volume group name argument.
. .
.HP .HP
.BR \-\-cachesettings .BR \-\-cachesettings
.IB key = value .IB Key = Value
.br .br
Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets Only applicable to cached LVs; see also \fBlvmcache(7)\fP. Sets
the cache tunable settings. In most use-cases, default values should be adequate. the cache tunable settings. In most use-cases, default values should be adequate.
@ -336,7 +336,7 @@ to be allocated (including extents used by any mirrors, for example).
. .
.HP .HP
.BR \-j | \-\-major .BR \-j | \-\-major
.IR major .IR Major
.br .br
Sets the major number. Sets the major number.
Major numbers are not supported with pool volumes. Major numbers are not supported with pool volumes.
@ -356,7 +356,7 @@ See \fBlvm.conf\fP(5) for more information about \fBmetadata profiles\fP.
. .
.HP .HP
.BR \-\-minor .BR \-\-minor
.IR minor .IR Minor
.br .br
Sets the minor number. Sets the minor number.
Minor numbers are not supported with pool volumes. Minor numbers are not supported with pool volumes.

View File

@ -6,15 +6,14 @@ lvmconfig, lvm dumpconfig, lvm config \(em Display LVM configuration
.ad l .ad l
.B lvmconfig .B lvmconfig
.RB [ \-f | \-\-file .RB [ \-f | \-\-file
.IR filename ] .IR Filename ]
.RB [ \-\-type .RB [ \-\-type
.RB { current |\: default |\: diff |\: full | list |\: missing \c .RB { current | default | diff | full |\: list | missing | new \c
.RB |\: new |\: profilable |\: profilable-command \c .RB | profilable | profilable-command | profilable-metadata }]
.RB |\: profilable-metadata }]
.RB [ \-\-atversion .RB [ \-\-atversion
.IR version ] .IR Version ]
.RB [ \-\-sinceversion .RB [ \-\-sinceversion
.IR version ] .IR Version ]
.RB [ \-\-ignoreadvanced ] .RB [ \-\-ignoreadvanced ]
.RB [ \-\-ignoreunsupported ] .RB [ \-\-ignoreunsupported ]
.RB [ \-\-ignorelocal ] .RB [ \-\-ignorelocal ]
@ -45,7 +44,7 @@ The command was added in release 2.02.119 and has an identical longer form
.SH OPTIONS .SH OPTIONS
.TP .TP
.BR \-f ", " \-\-file " \fIfilename" .BR \-f ", " \-\-file " \fIFilename"
Send output to a file named 'filename'. Send output to a file named 'filename'.
.TP .TP
@ -54,7 +53,7 @@ List configuration settings with summarizing comment. This is the same as using
\fBlvmconfig --type list --withsummary\fP. \fBlvmconfig --type list --withsummary\fP.
.TP .TP
.BR \-\-type " {" current | default | diff | full | missing | new | profilable | profilable-command | profilable-metadata } .BR \-\-type " {" current | default | diff | full | missing | new | profilable |\: profilable-command | profilable-metadata }
Select the type of configuration to display. The configuration settings Select the type of configuration to display. The configuration settings
displayed have either default values or currently-used values assigned based on displayed 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 the type selected. If no type is selected, \fB\-\-type current\fP is used
@ -106,7 +105,7 @@ by \fB\-\-type profilable\fP.
.RE .RE
.TP .TP
.BI \-\-atversion " version" .BI \-\-atversion " Version"
Specify an LVM version in x.y.z format where x is the major 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). the y is the minor version and z is the patchlevel (e.g. 2.2.106).
When configuration is displayed, the configuration settings recognized When configuration is displayed, the configuration settings recognized
@ -116,7 +115,7 @@ which does not contain any newer settings for which LVM would
issue a warning message when checking the configuration. issue a warning message when checking the configuration.
.TP .TP
.BI \-\-sinceversion " version" .BI \-\-sinceversion " Version"
Specify an LVM version in x.y.z format where x is the major 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). the y is the minor version and z is the patchlevel (e.g. 2.2.106).
This option is currently applicable only with \fB\-\-type new\fP This option is currently applicable only with \fB\-\-type new\fP
@ -140,13 +139,13 @@ Ignore local section.
.TP .TP
.BI \-\-config " ConfigurationString" .BI \-\-config " ConfigurationString"
Use \fBConfigurationString\fP to override existing configuration. Use \fIConfigurationString\fP to override existing configuration.
This configuration is then applied for the lvmconfig command itself. This configuration is then applied for the lvmconfig command itself.
See also \fBlvm.conf\fP(5) for more info about \fBconfig cascade\fP. See also \fBlvm.conf\fP(5) for more info about \fBconfig cascade\fP.
.TP .TP
.BI \-\-commandprofile " ProfileName" .BI \-\-commandprofile " ProfileName"
Use \fBProfileName\fP to override existing configuration. Use \fIProfileName\fP to override existing configuration.
This configuration is then applied for the lvmconfig command itself. This configuration is then applied for the lvmconfig command itself.
See also \fB\-\-mergedconfig\fP option and \fBlvm.conf\fP(5) for See also \fB\-\-mergedconfig\fP option and \fBlvm.conf\fP(5) for
more info about \fBconfig cascade\fP. more info about \fBconfig cascade\fP.
@ -158,7 +157,7 @@ applied for the lvmconfig command itself.
.TP .TP
.BI \-\-metadataprofile " ProfileName" .BI \-\-metadataprofile " ProfileName"
Use \fBProfileName\fP to override existing configuration. Use \fIProfileName\fP to override existing configuration.
The configuration defined in metadata profile has no effect for The configuration defined in metadata profile has no effect for
the lvmconfig command itself. lvmconfig displays the configuration only. the lvmconfig command itself. lvmconfig displays the configuration only.
See also \fB\-\-mergedconfig\fP option and \fBlvm.conf\fP(5) for more See also \fB\-\-mergedconfig\fP option and \fBlvm.conf\fP(5) for more