lvm2-commits April 2021

lvm2-commits@lists.fedorahosted.org

2 participants
103 discussions

main - config: improve description for event_activation

by David Teigland

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=a616abba03a35ec3064... Commit: a616abba03a35ec3064360ac8cab9ebb2203d645 Parent: 5eac292925ca96bee9a1f50355ca0e8b0ef4a9a6 Author: David Teigland <teigland(a)redhat.com> AuthorDate: Mon Apr 19 13:29:17 2021 -0500 Committer: David Teigland <teigland(a)redhat.com> CommitterDate: Mon Apr 19 13:29:17 2021 -0500 config: improve description for event_activation --- lib/config/config_settings.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/lib/config/config_settings.h b/lib/config/config_settings.h index 3946a7129..d3a42a153 100644 --- a/lib/config/config_settings.h +++ b/lib/config/config_settings.h @@ -1117,13 +1117,14 @@ cfg(global_lvdisplay_shows_full_device_path_CFG, "lvdisplay_shows_full_device_pa cfg(global_event_activation_CFG, "event_activation", global_CFG_SECTION, CFG_DEFAULT_COMMENTED, CFG_TYPE_BOOL, 1, vsn(2, 3, 1), 0, 0, NULL, "Activate LVs based on system-generated device events.\n" - "When a device appears on the system, a system-generated event runs\n" - "the pvscan command to activate LVs if the new PV completes the VG.\n" - "When event_activation is disabled, the system will generally run\n" - "a direct activation command to activate LVs in complete VGs.\n" - "Activation commands that are run by the system, either from events\n" - "or at fixed points during startup, use autoactivation (-aay). See\n" - "the --setautoactivation option or the auto_activation_volume_list\n" + "When a PV appears on the system, a system-generated uevent triggers\n" + "the lvm2-pvscan service which runs the pvscan --cache -aay command.\n" + "If the new PV completes a VG, pvscan autoactivates LVs in the VG.\n" + "When event_activation is disabled, the lvm2-activation services are\n" + "generated and run at fixed points during system startup. These\n" + "services run vgchange -aay to autoactivate LVs in VGs that happen\n" + "to be present at that point in time.\n" + "See the --setautoactivation option or the auto_activation_volume_list\n" "setting to configure autoactivation for specific VGs or LVs.\n") cfg(global_use_lvmetad_CFG, "use_lvmetad", global_CFG_SECTION, 0, CFG_TYPE_BOOL, 0, vsn(2, 2, 93), 0, vsn(2, 3, 0), NULL,

3 years

1
0
0 / 0

main - make: generate

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=5eac292925ca96bee9a... Commit: 5eac292925ca96bee9a1f50355ca0e8b0ef4a9a6 Parent: d1f8978ac5adbe7274faa62011dbb30a95719191 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Thu Apr 15 20:11:52 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:54:37 2021 +0200 make: generate --- man/lvchange.8_pregen | 664 +++++--------- man/lvconvert.8_pregen | 1449 +++++++++++-------------------- man/lvcreate.8_pregen | 1945 +++++++++++------------------------------- man/lvdisplay.8_pregen | 358 +++----- man/lvextend.8_pregen | 454 +++------- man/lvm-fullreport.8_pregen | 334 +++----- man/lvm-lvpoll.8_pregen | 266 ++---- man/lvmconfig.8_pregen | 317 ++----- man/lvmdevices.8_pregen | 351 +++----- man/lvmdiskscan.8_pregen | 220 ++--- man/lvreduce.8_pregen | 263 ++---- man/lvremove.8_pregen | 277 ++---- man/lvrename.8_pregen | 250 ++---- man/lvresize.8_pregen | 407 +++------ man/lvs.8_pregen | 438 +++------- man/lvscan.8_pregen | 234 ++--- man/pvchange.8_pregen | 272 ++---- man/pvck.8_pregen | 389 +++------ man/pvcreate.8_pregen | 329 ++----- man/pvdisplay.8_pregen | 346 +++----- man/pvmove.8_pregen | 367 ++------ man/pvremove.8_pregen | 228 ++--- man/pvresize.8_pregen | 236 ++--- man/pvs.8_pregen | 353 +++----- man/pvscan.8_pregen | 303 ++----- man/vgcfgbackup.8_pregen | 247 ++---- man/vgcfgrestore.8_pregen | 308 ++----- man/vgchange.8_pregen | 610 ++++--------- man/vgck.8_pregen | 236 ++--- man/vgconvert.8_pregen | 250 ++---- man/vgcreate.8_pregen | 349 ++------ man/vgdisplay.8_pregen | 341 +++----- man/vgexport.8_pregen | 250 ++---- man/vgextend.8_pregen | 288 ++----- man/vgimport.8_pregen | 249 ++---- man/vgimportclone.8_pregen | 237 ++--- man/vgimportdevices.8_pregen | 250 ++---- man/vgmerge.8_pregen | 228 ++--- man/vgmknodes.8_pregen | 241 ++---- man/vgreduce.8_pregen | 306 ++----- man/vgremove.8_pregen | 248 ++---- man/vgrename.8_pregen | 247 ++---- man/vgs.8_pregen | 355 +++----- man/vgscan.8_pregen | 229 ++--- man/vgsplit.8_pregen | 277 ++---- 45 files changed, 4733 insertions(+), 12063 deletions(-) diff --git a/man/lvchange.8_pregen b/man/lvchange.8_pregen index 93c7311b5..3cfa7330d 100644 --- a/man/lvchange.8_pregen +++ b/man/lvchange.8_pregen @@ -1,8 +1,11 @@ .TH LVCHANGE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvchange - Change the attributes of logical volume(s) +. +lvchange \(em Change the attributes of logical volume(s) . .SH SYNOPSIS +. \fBlvchange\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -10,250 +13,136 @@ lvchange - Change the attributes of logical volume(s) .P .ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP -.ad b .br -.ad l \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP -.ad b .br -.ad l \fB--addtag\fP \fITag\fP -.ad b .br -.ad l - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.ad b .br -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP -.ad b .br -.ad l \fB--cachepolicy\fP \fIString\fP -.ad b .br -.ad l \fB--cachesettings\fP \fIString\fP -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--compression\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-C\fP|\fB--contiguous\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--deduplication\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--deltag\fP \fITag\fP -.ad b .br -.ad l \fB--detachprofile\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--errorwhenfull\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-f\fP|\fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB-K\fP|\fB--ignoreactivationskip\fP -.ad b .br -.ad l \fB--ignorelockingfailure\fP -.ad b .br -.ad l \fB--ignoremonitoring\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB-j\fP|\fB--major\fP \fINumber\fP -.ad b .br -.ad l - \fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] -.ad b + \fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad l \fB--metadataprofile\fP \fIString\fP -.ad b .br -.ad l \fB--minor\fP \fINumber\fP -.ad b .br -.ad l - \fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] -.ad b + \fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad l \fB--monitor\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--noudevsync\fP -.ad b .br -.ad l \fB-P\fP|\fB--partial\fP -.ad b .br -.ad l \fB-p\fP|\fB--permission\fP \fBrw\fP|\fBr\fP -.ad b .br -.ad l \fB-M\fP|\fB--persistent\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--poll\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP -.ad b .br -.ad l \fB--readonly\fP -.ad b .br -.ad l \fB--rebuild\fP \fIPV\fP -.ad b .br -.ad l \fB--refresh\fP -.ad b .br -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP -.ad b .br -.ad l \fB--resync\fP -.ad b .br -.ad l \fB-S\fP|\fB--select\fP \fIString\fP -.ad b .br -.ad l \fB-k\fP|\fB--setactivationskip\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l - \fB--[raid]syncaction\fP \fBcheck\fP|\fBrepair\fP -.ad b + \fB--\fP[\fBraid\fP]\fBsyncaction\fP \fBcheck\fP|\fBrepair\fP .br -.ad l \fB--sysinit\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l - \fB--[raid]writebehind\fP \fINumber\fP -.ad b + \fB--\fP[\fBraid\fP]\fBwritebehind\fP \fINumber\fP .br -.ad l - \fB--[raid]writemostly\fP \fIPV\fP[\fB:t\fP|\fBn\fP|\fBy\fP] -.ad b + \fB--\fP[\fBraid\fP]\fBwritemostly\fP \fIPV\fP[\fB:t\fP|\fBn\fP|\fBy\fP] .br -.ad l \fB-y\fP|\fB--yes\fP -.ad b .br -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .ad b +. .SH DESCRIPTION +. lvchange changes LV attributes in the VG, changes LV activation in the kernel, and includes other utilities for LV maintenance. +. .SH USAGE +. Change a general LV attribute. .br For options listed in parentheses, any one is @@ -279,9 +168,9 @@ required, after which the others are optional. .br \fB--deltag\fP \fITag\fP .br - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy .br \fB--compression\fP \fBy\fP|\fBn\fP @@ -306,13 +195,13 @@ required, after which the others are optional. .br \fB--cachesettings\fP \fIString\fP .br - \fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] + \fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] .br - \fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] + \fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] .br - \fB--[raid]writebehind\fP \fINumber\fP + \fB--\fP[\fBraid\fP]\fBwritebehind\fP \fINumber\fP .br - \fB--[raid]writemostly\fP \fIPV\fP[\fB:t\fP|\fBn\fP|\fBy\fP] ) + \fB--\fP[\fBraid\fP]\fBwritemostly\fP \fIPV\fP[\fB:t\fP|\fBn\fP|\fBy\fP] ) .RE .RS 4 \fIVG\fP|\fILV\fP|\fITag\fP|\fISelect\fP ... @@ -321,60 +210,72 @@ required, after which the others are optional. .RS 4 .ad l [ \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Resyncronize a mirror or raid LV. .br Use to reset 'R' attribute on a not initially synchronized LV. .br .P -\fBlvchange\fP \fB--resync\fP \fIVG\fP|\fILV\fP\fI_mirror_raid\fP|\fITag\fP|\fISelect\fP ... +\fBlvchange\fP \fB--resync\fP \fIVG\fP|\fILV1\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 .ad l [ \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: mirror raid +.RE +.P +\(em +.P Resynchronize or check a raid LV. .br .P -\fBlvchange\fP \fB--syncaction\fP \fBcheck\fP|\fBrepair\fP \fIVG\fP|\fILV\fP\fI_raid\fP|\fITag\fP|\fISelect\fP ... +\fBlvchange\fP \fB--syncaction\fP \fBcheck\fP|\fBrepair\fP \fIVG\fP|\fILV1\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Reconstruct data on specific PVs of a raid LV. .br .P -\fBlvchange\fP \fB--rebuild\fP \fIPV\fP \fIVG\fP|\fILV\fP\fI_raid\fP|\fITag\fP|\fISelect\fP ... +\fBlvchange\fP \fB--rebuild\fP \fIPV\fP \fIVG\fP|\fILV1\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Activate or deactivate an LV. .br .P @@ -383,41 +284,27 @@ Activate or deactivate an LV. .RS 4 .ad l [ \fB-P\fP|\fB--partial\fP ] -.ad b .br -.ad l [ \fB-K\fP|\fB--ignoreactivationskip\fP ] -.ad b .br -.ad l [ \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--sysinit\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Reactivate an LV using the latest metadata. .br .P @@ -426,36 +313,32 @@ Reactivate an LV using the latest metadata. .RS 4 .ad l [ \fB-P\fP|\fB--partial\fP ] -.ad b .br -.ad l [ \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Start or stop monitoring an LV from dmeventd. .br .P \fBlvchange\fP \fB--monitor\fP \fBy\fP|\fBn\fP \fIVG\fP|\fILV\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Start or stop processing an LV conversion. .br .P @@ -464,13 +347,13 @@ Start or stop processing an LV conversion. .RS 4 .ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Make the minor device number persistent for an LV. .br .P @@ -479,126 +362,81 @@ Make the minor device number persistent for an LV. .RS 4 .ad l [ \fB-j\fP|\fB--major\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP .br -.ad b Change the active state of LVs. An active LV can be used through a block device, allowing data on the LV to be accessed. @@ -616,18 +454,17 @@ activation commands. By default, LVs are autoactivated. An autoactivation property can be set on a VG or LV to disable autoactivation, see --setautoactivation y|n in vgchange, lvchange, vgcreate, and lvcreate. Display the property with vgs or lvs "-o autoactivation". -The lvm.conf auto_activation_volume_list includes names of VGs or LVs +The \fBlvm.conf\fP(5) auto_activation_volume_list includes names of VGs or LVs that should be autoactivated, and anything not listed is not autoactivated. When auto_activation_volume_list is undefined (the default), it has no effect. If auto_activation_volume_list is defined and empty, no LVs are autoactivated. Items included by auto_activation_volume_list will not be autoactivated if the autoactivation property has been disabled. See \fBlvmlockd\fP(8) for more information about activation options \fBey\fP and \fBsy\fP for shared VGs. +. .HP -.ad l \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP .br -.ad b Determines if LV activation is allowed when PVs are missing, e.g. because of a device failure. \fBcomplete\fP only allows LVs with no missing PVs to be activated, @@ -636,23 +473,23 @@ and is the most restrictive mode. (This does not include the "mirror" type, see "raid1" instead.) \fBpartial\fP allows any LV with missing PVs to be activated, and should only be used for recovery or repair. -For default, see lvm.conf/activation_mode. +For default, see \fBlvm.conf\fP(5) activation_mode. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--addtag\fP \fITag\fP .br -.ad b Adds a tag to a PV, VG or LV. This option can be repeated to add multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -669,18 +506,16 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP .br -.ad b Specifies when writes to a cache LV should be considered complete. \fBwriteback\fP considers a write complete as soon as it is stored in the cache pool. @@ -692,18 +527,16 @@ cache pool LV. With \fBpassthrough\fP, all reads are served from the origin LV (all reads miss the cache) and all writes are forwarded to the origin LV; additionally, write hits cause cache block invalidates. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachepolicy\fP \fIString\fP .br -.ad b Specifies the cache policy for a cache LV. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachesettings\fP \fIString\fP .br -.ad b Specifies tunable values for a cache LV in "Key = Value" form. Repeat this option to specify multiple values. (The default values should usually be adequate.) @@ -711,90 +544,79 @@ The special string value \fBdefault\fP switches settings back to their default kernel values and removes them from the list of settings stored in LVM metadata. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--compression\fP \fBy\fP|\fBn\fP .br -.ad b Controls whether compression is enabled or disable for VDO volume. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-C\fP|\fB--contiguous\fP \fBy\fP|\fBn\fP .br -.ad b Sets or resets the contiguous allocation policy for LVs. Default is no contiguous allocation based on a next free principle. It is only possible to change a non-contiguous allocation policy to contiguous if all of the allocated physical extents in the LV are already contiguous. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--deduplication\fP \fBy\fP|\fBn\fP .br -.ad b Controls whether deduplication is enabled or disable for VDO volume. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--deltag\fP \fITag\fP .br -.ad b Deletes a tag from a PV, VG or LV. This option can be repeated to delete multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP -.ad l \fB--detachprofile\fP .br -.ad b Detaches a metadata profile from a VG or LV. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP .br -.ad b Specifies how the device-mapper thin pool layer in the kernel should handle discards. \fBignore\fP causes the thin pool to ignore discards. @@ -803,18 +625,16 @@ allow reuse of unneeded extents in the thin pool. \fBpassdown\fP causes the thin pool to process discards itself (like nopassdown) and pass the discards to the underlying device. See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--errorwhenfull\fP \fBy\fP|\fBn\fP .br -.ad b Specifies thin pool behavior when data space is exhausted. When yes, device-mapper will immediately return an error when a thin pool is full and an I/O request requires space. @@ -823,140 +643,121 @@ period of time to allow the thin pool to be extended. Errors are returned if no space is available after the timeout. (Also see dm-thin-pool kernel module option no_space_timeout.) See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-K\fP|\fB--ignoreactivationskip\fP .br -.ad b Ignore the "activation skip" LV flag during activation to allow LVs with the flag set to be activated. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--ignoremonitoring\fP .br -.ad b Do not interact with dmeventd unless --monitor is specified. Do not use this if dmeventd is already monitoring a device. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-j\fP|\fB--major\fP \fINumber\fP .br -.ad b Sets the major number of an LV block device. +. .HP -.ad l -\fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] +\fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad b Sets the maximum recovery rate for a RAID LV. The rate value is an amount of data per second for each device in the array. Setting the rate to 0 means it will be unbounded. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--metadataprofile\fP \fIString\fP .br -.ad b The metadata profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--minor\fP \fINumber\fP .br -.ad b Sets the minor number of an LV block device. +. .HP -.ad l -\fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] +\fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad b Sets the minimum recovery rate for a RAID LV. The rate value is an amount of data per second for each device in the array. Setting the rate to 0 means it will be unbounded. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--monitor\fP \fBy\fP|\fBn\fP .br -.ad b Start (yes) or stop (no) monitoring an LV with dmeventd. dmeventd monitors kernel events for an LV, and performs automated maintenance for the LV in reponse to specific events. See \fBdmeventd\fP(8) for more information. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB-P\fP|\fB--partial\fP .br -.ad b Commands will do their best to activate LVs with missing PV extents. Missing extents may be replaced with error or zero segments -according to the lvm.conf missing_stripe_filler setting. +according to the missing_stripe_filler setting. Metadata may not be changed with this option. +. .HP -.ad l \fB-p\fP|\fB--permission\fP \fBrw\fP|\fBr\fP .br -.ad b Set access permission to read only \fBr\fP or read and write \fBrw\fP. +. .HP -.ad l \fB-M\fP|\fB--persistent\fP \fBy\fP|\fBn\fP .br -.ad b When yes, makes the specified minor number persistent. +. .HP -.ad l \fB--poll\fP \fBy\fP|\fBn\fP .br -.ad b When yes, start the background transformation of an LV. An incomplete transformation, e.g. pvmove or lvconvert interrupted by reboot or crash, can be restarted from the last checkpoint with --poll y. @@ -964,76 +765,68 @@ When no, background transformation of an LV will not occur, and the transformation will not complete. It may not be appropriate to immediately poll an LV after activation, in which case --poll n can be used to defer polling until a later --poll y command. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP .br -.ad b Sets read ahead sector count of an LV. \fBauto\fP is the default which allows the kernel to choose a suitable value automatically. \fBnone\fP is equivalent to zero. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--rebuild\fP \fIPV\fP .br -.ad b Selects a PV to rebuild in a raid LV. Multiple PVs can be rebuilt by repeating this option. Use this option in place of --resync or --syncaction repair when the PVs with corrupted data are known, and their data should be reconstructed rather than reconstructing default (rotating) data. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--refresh\fP .br -.ad b If the LV is active, reload its metadata. This is not necessary in normal operation, but may be useful if something has gone wrong, or if some form of manual LV sharing is being used. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--resync\fP .br -.ad b Initiates mirror synchronization. Synchronization generally happens automatically, but this option forces it to run. Also see --rebuild to synchronize a specific PV. @@ -1041,11 +834,10 @@ During synchronization, data is read from the primary mirror device and copied to the others. This can take considerable time, during which the LV is without a complete redundant copy of the data. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -1054,22 +846,20 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-k\fP|\fB--setactivationskip\fP \fBy\fP|\fBn\fP .br -.ad b Persistently sets (yes) or clears (no) the "activation skip" flag on an LV. An LV with this flag set is not activated unless the --ignoreactivationskip option is used by the activation command. This flag is set by default on new thin snapshot LVs. The flag is not applied to deactivation. The current value of the flag is indicated in the lvs lv_attr bits. +. .HP -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP .br -.ad b Set the autoactivation property on a VG or LV. Display the property with vgs or lvs "-o autoactivation". When the autoactivation property is disabled, the VG or LV @@ -1079,23 +869,21 @@ If autoactivation is disabled on a VG, no LVs will be autoactivated in that VG, and the LV autoactivation property has no effect. If autoactivation is enabled on a VG, autoactivation can be disabled for individual LVs. +. .HP -.ad l -\fB--[raid]syncaction\fP \fBcheck\fP|\fBrepair\fP +\fB--\fP[\fBraid\fP]\fBsyncaction\fP \fBcheck\fP|\fBrepair\fP .br -.ad b Initiate different types of RAID synchronization. This causes the RAID LV to read all data and parity blocks in the array and check for discrepancies (mismatches between mirrors or incorrect parity values). \fBcheck\fP will count but not correct discrepancies. \fBrepair\fP will correct discrepancies. -See lvs for reporting discrepancies found or repaired. +See \fBlvs\fP(8) for reporting discrepancies found or repaired. +. .HP -.ad l \fB--sysinit\fP .br -.ad b Indicates that vgchange/lvchange is being invoked from early system initialisation scripts (e.g. rc.sysinit or an initrd), before writable filesystems are available. As such, some functionality needs to be disabled and this option @@ -1103,45 +891,40 @@ acts as a shortcut which selects an appropriate set of options. Currently, this is equivalent to using --ignorelockingfailure, --ignoremonitoring, --poll n, and setting env var LVM_SUPPRESS_LOCKING_FAILURE_MESSAGES. vgchange/lvchange skip autoactivation, and defer to pvscan autoactivation. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l -\fB--[raid]writebehind\fP \fINumber\fP +\fB--\fP[\fBraid\fP]\fBwritebehind\fP \fINumber\fP .br -.ad b The maximum number of outstanding writes that are allowed to devices in a RAID1 LV that is marked write-mostly. Once this value is exceeded, writes become synchronous (i.e. all writes to the constituent devices must complete before the array signals the write has completed). Setting the value to zero clears the preference and allows the system to choose the value arbitrarily. +. .HP -.ad l -\fB--[raid]writemostly\fP \fIPV\fP[\fB:t\fP|\fBn\fP|\fBy\fP] +\fB--\fP[\fBraid\fP]\fBwritemostly\fP \fIPV\fP[\fB:t\fP|\fBn\fP|\fBy\fP] .br -.ad b Mark a device in a RAID1 LV as write-mostly. All reads to these drives will be avoided unless absolutely necessary. This keeps the number of I/Os to the drive to a minimum. The default behavior is to @@ -1150,133 +933,70 @@ It is also possible to remove the write-mostly flag by adding the suffix \fB:n\fP at the end of the PV name, or to toggle the value with the suffix \fB:t\fP. Repeat this option to change the attribute on multiple PVs. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .HP -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .br -.ad b Set zeroing mode for thin pool. Note: already provisioned blocks from pool in non-zero mode are not cleared in unwritten parts when setting --zero y. +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -LV followed by _<type> indicates that an LV of the -given type is required. (raid represents raid<N> type) -.HP -\fITag\fP -.br +LV1 indicates the LV must have a specific type, where the +accepted LV types are listed. (raid represents raid<N> type). +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES -Change LV permission to read-only: -.sp -.B lvchange -pr vg00/lvol1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvconvert.8_pregen b/man/lvconvert.8_pregen index 03e6d62dd..a921438b6 100644 --- a/man/lvconvert.8_pregen +++ b/man/lvconvert.8_pregen @@ -1,8 +1,11 @@ .TH LVCONVERT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvconvert - Change logical volume layout +. +lvconvert \(em Change logical volume layout . .SH SYNOPSIS +. \fBlvconvert\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -11,334 +14,196 @@ lvconvert - Change logical volume layout .br .P .ad l - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.ad b .br -.ad l \fB-b\fP|\fB--background\fP -.ad b .br -.ad l \fB-H\fP|\fB--cache\fP -.ad b .br -.ad l \fB--cachedevice\fP \fIPV\fP -.ad b .br -.ad l \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP -.ad b .br -.ad l \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP -.ad b .br -.ad l \fB--cachepolicy\fP \fIString\fP -.ad b .br -.ad l \fB--cachepool\fP \fILV\fP -.ad b .br -.ad l \fB--cachesettings\fP \fIString\fP -.ad b .br -.ad l \fB--cachesize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--cachevol\fP \fILV\fP -.ad b .br -.ad l \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--compression\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--deduplication\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--errorwhenfull\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-f\fP|\fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB-i\fP|\fB--interval\fP \fINumber\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB--merge\fP -.ad b .br -.ad l \fB--mergemirrors\fP -.ad b .br -.ad l \fB--mergesnapshot\fP -.ad b .br -.ad l \fB--mergethin\fP -.ad b .br -.ad l \fB--metadataprofile\fP \fIString\fP -.ad b .br -.ad l \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP -.ad b .br -.ad l \fB-m\fP|\fB--mirrors\fP [\fB+\fP|\fB-\fP]\fINumber\fP -.ad b .br -.ad l \fB-n\fP|\fB--name\fP \fIString\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--noudevsync\fP -.ad b .br -.ad l \fB--originname\fP \fILV\fP -.ad b .br -.ad l \fB--poolmetadata\fP \fILV\fP -.ad b .br -.ad l \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--raidintegrity\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--raidintegrityblocksize\fP \fINumber\fP -.ad b .br -.ad l \fB--raidintegritymode\fP \fIString\fP -.ad b .br -.ad l \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP -.ad b .br -.ad l \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--repair\fP -.ad b .br -.ad l \fB--replace\fP \fIPV\fP -.ad b .br -.ad l \fB-s\fP|\fB--snapshot\fP -.ad b .br -.ad l \fB--splitcache\fP -.ad b .br -.ad l \fB--splitmirrors\fP \fINumber\fP -.ad b .br -.ad l \fB--splitsnapshot\fP -.ad b .br -.ad l \fB--startpoll\fP -.ad b .br -.ad l \fB--stripes\fP \fINumber\fP -.ad b .br -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] -.ad b .br -.ad l \fB--swapmetadata\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-T\fP|\fB--thin\fP -.ad b .br -.ad l \fB--thinpool\fP \fILV\fP -.ad b .br -.ad l \fB--trackchanges\fP -.ad b .br -.ad l - \fB--type\fP + \fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.ad b .br -.ad l \fB--uncache\fP -.ad b .br -.ad l \fB--usepolicies\fP -.ad b .br -.ad l \fB--vdopool\fP \fILV\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP -.ad b .br -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .ad b +. .SH DESCRIPTION +. lvconvert changes the LV type and includes utilities for LV data maintenance. The LV type controls data layout and redundancy. The LV type is also called the segment type or segtype. - +.P To display the current LV type, run the command: - +.P .B lvs -o name,segtype .I LV - +.P In some cases, an LV is a single device mapper (dm) layer above physical devices. In other cases, hidden LVs (dm devices) are layered between the visible LV and physical devices. LVs in the middle layers are called sub LVs. A command run on a visible LV sometimes operates on a sub LV rather than the specified LV. In other cases, a sub LV must be specified directly on the command line. - +.P Sub LVs can be displayed with the command: - +.P .B lvs -a - +.P The .B linear type is equivalent to the .B striped type when one stripe exists. In that case, the types can sometimes be used interchangably. - +.P In most cases, the .B mirror type is deprecated and the .B raid1 type should be used. They are both implementations of mirroring. - +.P Striped raid types are \fBraid0/raid0_meta\fP, \fBraid5\fP (an alias for raid5_ls), \fBraid6\fP (an alias for raid6_zr) and \fBraid10\fP (an alias for raid10_near). - +.P As opposed to mirroring, raid5 and raid6 stripe data and calculate parity blocks. The parity blocks can be used for data block recovery in case devices fail. A maximum number of one device in a raid5 LV may fail, and @@ -347,45 +212,49 @@ data blocks for performance reasons, thus avoiding contention on a single device. Specific arrangements of parity and data blocks (layouts) can be used to optimize I/O performance, or to convert between raid levels. See \fBlvmraid\fP(7) for more information. - +.P Layouts of raid5 rotating parity blocks can be: left-asymmetric (raid5_la), left-symmetric (raid5_ls with alias raid5), right-asymmetric (raid5_ra), right-symmetric (raid5_rs) and raid5_n, which doesn't rotate parity blocks. Layouts of raid6 are: zero-restart (raid6_zr with alias raid6), next-restart (raid6_nr), and next-continue (raid6_nc). - +.P Layouts including _n allow for conversion between raid levels (raid5_n to raid6 or raid5_n to striped/raid0/raid0_meta). Additionally, special raid6 layouts for raid level conversions between raid5 and raid6 are: raid6_ls_6, raid6_rs_6, raid6_la_6 and raid6_ra_6. Those correspond to their raid5 counterparts (e.g. raid5_rs can be directly converted to raid6_rs_6 and vice-versa). - +.P raid10 (an alias for raid10_near) is currently limited to one data copy and even number of sub LVs. This is a mirror group layout, thus a single sub LV may fail per mirror group without data loss. - +.P Striped raid types support converting the layout, their stripesize and their number of stripes. - +.P The striped raid types combined with raid1 allow for conversion from -linear -> striped/raid0/raid0_meta and vice-versa by e.g. linear <-> raid1 -<-> raid5_n (then adding stripes) <-> striped/raid0/raid0_meta. +linear \[->] striped/raid0/raid0_meta and vice-versa by e.g. linear \[<>] raid1 +\[<>] raid5_n (then adding stripes) \[<>] striped/raid0/raid0_meta. +. .SH USAGE +. Convert LV to linear. .br .P \fBlvconvert\fP \fB--type\fP \fBlinear\fP \fILV\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Convert LV to striped. .br .P @@ -394,28 +263,22 @@ Convert LV to striped. .RS 4 .ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--stripes\fP \fINumber\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Convert LV to type mirror (also see type raid1), .br .P @@ -424,36 +287,26 @@ Convert LV to type mirror (also see type raid1), .RS 4 .ad l [ \fB-m\fP|\fB--mirrors\fP [\fB+\fP|\fB-\fP]\fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Convert LV to raid or change raid layout .br (a specific raid level must be used, e.g. raid1). @@ -464,32 +317,24 @@ Convert LV to raid or change raid layout .RS 4 .ad l [ \fB-m\fP|\fB--mirrors\fP [\fB+\fP|\fB-\fP]\fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--stripes\fP \fINumber\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Convert LV to raid1 or mirror, or change number of mirror images. .br .P @@ -498,535 +343,491 @@ Convert LV to raid1 or mirror, or change number of mirror images. .RS 4 .ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Convert raid LV to change number of stripe images. .br .P -\fBlvconvert\fP \fB--stripes\fP \fINumber\fP \fILV\fP\fI_raid\fP +\fBlvconvert\fP \fB--stripes\fP \fINumber\fP \fILV1\fP .br .RS 4 .ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Convert raid LV to change the stripe size. .br .P -\fBlvconvert\fP \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] \fILV\fP\fI_raid\fP +\fBlvconvert\fP \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] \fILV1\fP .br .RS 4 .ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Split images from a raid1 or mirror LV and use them to create a new LV. .br .P -\fBlvconvert\fP \fB--splitmirrors\fP \fINumber\fP \fB-n\fP|\fB--name\fP \fILV\fP\fI_new\fP \fILV\fP\fI_cache_mirror_raid1\fP +\fBlvconvert\fP \fB--splitmirrors\fP \fINumber\fP \fB-n\fP|\fB--name\fP \fILV\fP\fI_new\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: cache mirror raid1 +.RE +.P +\(em +.P Split images from a raid1 LV and track changes to origin for later merge. .br .P -\fBlvconvert\fP \fB--splitmirrors\fP \fINumber\fP \fB--trackchanges\fP \fILV\fP\fI_cache_raid1\fP +\fBlvconvert\fP \fB--splitmirrors\fP \fINumber\fP \fB--trackchanges\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: cache raid1 +.RE +.P +\(em +.P Merge LV images that were split from a raid1 LV. .br .P -\fBlvconvert\fP \fB--mergemirrors\fP \fIVG\fP|\fILV\fP\fI_linear_raid\fP|\fITag\fP ... +\fBlvconvert\fP \fB--mergemirrors\fP \fIVG\fP|\fILV1\fP|\fITag\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear raid +.RE +.P +\(em +.P Convert LV to a thin LV, using the original LV as an external origin. .br .P -\fBlvconvert\fP \fB--type\fP \fBthin\fP \fB--thinpool\fP \fILV\fP \fILV\fP\fI_linear_striped_thin_cache_raid_error_zero\fP +\fBlvconvert\fP \fB--type\fP \fBthin\fP \fB--thinpool\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--originname\fP \fILV\fP\fI_new\fP ] -.ad b .br -.ad l [ \fB--poolmetadata\fP \fILV\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thin cache raid error zero +.RE +.P +\(em +.P Attach a cache pool to an LV, converts the LV to type cache. .br .P -\fBlvconvert\fP \fB--type\fP \fBcache\fP \fB--cachepool\fP \fILV\fP \fILV\fP\fI_linear_striped_thinpool_vdo_vdopool_vdopooldata_raid\fP +\fBlvconvert\fP \fB--type\fP \fBcache\fP \fB--cachepool\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-H\fP|\fB--cache\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--poolmetadata\fP \fILV\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thinpool vdo vdopool vdopooldata raid +.RE +.P +\(em +.P Attach a writecache to an LV, converts the LV to type writecache. .br .P -\fBlvconvert\fP \fB--type\fP \fBwritecache\fP \fB--cachevol\fP \fILV\fP \fILV\fP\fI_linear_striped_raid\fP +\fBlvconvert\fP \fB--type\fP \fBwritecache\fP \fB--cachevol\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped raid +.RE +.P +\(em +.P Attach a cache to an LV, converts the LV to type cache. .br .P -\fBlvconvert\fP \fB--type\fP \fBcache\fP \fB--cachevol\fP \fILV\fP \fILV\fP\fI_linear_striped_thinpool_raid\fP +\fBlvconvert\fP \fB--type\fP \fBcache\fP \fB--cachevol\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-H\fP|\fB--cache\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thinpool raid +.RE +.P +\(em +.P Add a writecache to an LV, using a specified cache device. .br .P -\fBlvconvert\fP \fB--type\fP \fBwritecache\fP \fB--cachedevice\fP \fIPV\fP \fILV\fP\fI_linear_striped_raid\fP +\fBlvconvert\fP \fB--type\fP \fBwritecache\fP \fB--cachedevice\fP \fIPV\fP \fILV1\fP .br .RS 4 .ad l [ \fB--cachesize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped raid +.RE +.P +\(em +.P Add a cache to an LV, using a specified cache device. .br .P -\fBlvconvert\fP \fB--type\fP \fBcache\fP \fB--cachedevice\fP \fIPV\fP \fILV\fP\fI_linear_striped_thinpool_raid\fP +\fBlvconvert\fP \fB--type\fP \fBcache\fP \fB--cachedevice\fP \fIPV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachesize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thinpool raid +.RE +.P +\(em +.P Convert LV to type thin-pool. .br .P -\fBlvconvert\fP \fB--type\fP \fBthin-pool\fP \fILV\fP\fI_linear_striped_cache_raid_error_zero\fP +\fBlvconvert\fP \fB--type\fP \fBthin-pool\fP \fILV1\fP .br .RS 4 .ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--poolmetadata\fP \fILV\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: linear striped cache raid error zero +.RE +.P +\(em +.P Convert LV to type cache-pool. .br .P -\fBlvconvert\fP \fB--type\fP \fBcache-pool\fP \fILV\fP\fI_linear_striped_raid\fP +\fBlvconvert\fP \fB--type\fP \fBcache-pool\fP \fILV1\fP .br .RS 4 .ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--poolmetadata\fP \fILV\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: linear striped raid +.RE +.P +\(em +.P Convert LV to type vdopool. .br .P -\fBlvconvert\fP \fB--type\fP \fBvdo-pool\fP \fILV\fP\fI_linear_striped_cache_raid\fP +\fBlvconvert\fP \fB--type\fP \fBvdo-pool\fP \fILV1\fP .br .RS 4 .ad l [ \fB-n\fP|\fB--name\fP \fILV\fP\fI_new\fP ] -.ad b .br -.ad l [ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--compression\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--deduplication\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b +.RE +.P +.RS 4 +LV1 types: linear striped cache raid .RE -.br -- - +.P +\(em +.P Detach a cache from an LV. .br .P -\fBlvconvert\fP \fB--splitcache\fP \fILV\fP\fI_thinpool_cache_cachepool_vdopool_writecache\fP +\fBlvconvert\fP \fB--splitcache\fP \fILV1\fP .br .RS 4 .ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thinpool cache cachepool vdopool writecache +.RE +.P +\(em +.P Merge thin LV into its origin LV. .br .P -\fBlvconvert\fP \fB--mergethin\fP \fILV\fP\fI_thin\fP ... +\fBlvconvert\fP \fB--mergethin\fP \fILV1\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thin +.RE +.P +\(em +.P Merge COW snapshot LV into its origin. .br .P -\fBlvconvert\fP \fB--mergesnapshot\fP \fILV\fP\fI_snapshot\fP ... +\fBlvconvert\fP \fB--mergesnapshot\fP \fILV1\fP ... .br .RS 4 .ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: snapshot +.RE +.P +\(em +.P Combine a former COW snapshot (second arg) with a former .br origin LV (first arg) to reverse a splitsnapshot command. .br .P -\fBlvconvert\fP \fB--type\fP \fBsnapshot\fP \fILV\fP \fILV\fP\fI_linear_striped\fP +\fBlvconvert\fP \fB--type\fP \fBsnapshot\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-s\fP|\fB--snapshot\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped +.RE +.P +\(em +.P Replace failed PVs in a raid or mirror LV. .br Repair a thin pool. @@ -1034,176 +835,157 @@ Repair a thin pool. Repair a cache pool. .br .P -\fBlvconvert\fP \fB--repair\fP \fILV\fP\fI_thinpool_cache_cachepool_mirror_raid\fP +\fBlvconvert\fP \fB--repair\fP \fILV1\fP .br .RS 4 .ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--usepolicies\fP ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: thinpool cache cachepool mirror raid +.RE +.P +\(em +.P Replace specific PV(s) in a raid LV with another PV. .br .P -\fBlvconvert\fP \fB--replace\fP \fIPV\fP \fILV\fP\fI_raid\fP +\fBlvconvert\fP \fB--replace\fP \fIPV\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Poll LV to continue conversion. .br .P -\fBlvconvert\fP \fB--startpoll\fP \fILV\fP\fI_mirror_raid\fP +\fBlvconvert\fP \fB--startpoll\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: mirror raid +.RE +.P +\(em +.P Add or remove data integrity checksums to raid images. .br .P -\fBlvconvert\fP \fB--raidintegrity\fP \fBy\fP|\fBn\fP \fILV\fP\fI_raid\fP +\fBlvconvert\fP \fB--raidintegrity\fP \fBy\fP|\fBn\fP \fILV1\fP .br .RS 4 .ad l [ \fB--raidintegritymode\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--raidintegrityblocksize\fP \fINumber\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-b\fP|\fB--background\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -1220,39 +1002,34 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-b\fP|\fB--background\fP .br -.ad b If the operation requires polling, this option causes the command to return before the operation is complete, and polling is done in the background. +. .HP -.ad l \fB-H\fP|\fB--cache\fP .br -.ad b Specifies the command is handling a cache LV or cache pool. See --type cache and --type cache-pool. See \fBlvmcache\fP(7) for more information about LVM caching. +. .HP -.ad l \fB--cachedevice\fP \fIPV\fP .br -.ad b The name of a device to use for a cache. +. .HP -.ad l \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP .br -.ad b Specifies the cache metadata format used by cache target. +. .HP -.ad l \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP .br -.ad b Specifies when writes to a cache LV should be considered complete. \fBwriteback\fP considers a write complete as soon as it is stored in the cache pool. @@ -1264,24 +1041,21 @@ cache pool LV. With \fBpassthrough\fP, all reads are served from the origin LV (all reads miss the cache) and all writes are forwarded to the origin LV; additionally, write hits cause cache block invalidates. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachepolicy\fP \fIString\fP .br -.ad b Specifies the cache policy for a cache LV. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachepool\fP \fILV\fP .br -.ad b The name of a cache pool. +. .HP -.ad l \fB--cachesettings\fP \fIString\fP .br -.ad b Specifies tunable values for a cache LV in "Key = Value" form. Repeat this option to specify multiple values. (The default values should usually be adequate.) @@ -1289,23 +1063,20 @@ The special string value \fBdefault\fP switches settings back to their default kernel values and removes them from the list of settings stored in LVM metadata. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachesize\fP \fISize\fP[m|UNIT] .br -.ad b The size of cache to use. +. .HP -.ad l \fB--cachevol\fP \fILV\fP .br -.ad b The name of a cache volume. +. .HP -.ad l \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] .br -.ad b The size of chunks in a snapshot, cache pool or thin pool. For snapshots, the value must be a power of 2 between 4KiB and 512KiB and the default value is 4. @@ -1316,66 +1087,58 @@ and the default value starts with 64 and scales up to fit the pool metadata size within 128MiB, if the pool metadata size is not specified. The value must be a multiple of 64KiB. See \fBlvmthin\fP(7) and \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--compression\fP \fBy\fP|\fBn\fP .br -.ad b Controls whether compression is enabled or disable for VDO volume. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--deduplication\fP \fBy\fP|\fBn\fP .br -.ad b Controls whether deduplication is enabled or disable for VDO volume. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP .br -.ad b Specifies how the device-mapper thin pool layer in the kernel should handle discards. \fBignore\fP causes the thin pool to ignore discards. @@ -1384,18 +1147,16 @@ allow reuse of unneeded extents in the thin pool. \fBpassdown\fP causes the thin pool to process discards itself (like nopassdown) and pass the discards to the underlying device. See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--errorwhenfull\fP \fBy\fP|\fBn\fP .br -.ad b Specifies thin pool behavior when data space is exhausted. When yes, device-mapper will immediately return an error when a thin pool is full and an I/O request requires space. @@ -1404,57 +1165,49 @@ period of time to allow the thin pool to be extended. Errors are returned if no space is available after the timeout. (Also see dm-thin-pool kernel module option no_space_timeout.) See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-i\fP|\fB--interval\fP \fINumber\fP .br -.ad b Report progress at regular intervals. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--merge\fP .br -.ad b An alias for --mergethin, --mergemirrors, or --mergesnapshot, depending on the type of LV. +. .HP -.ad l \fB--mergemirrors\fP .br -.ad b Merge LV images that were split from a raid1 LV. See --splitmirrors with --trackchanges. +. .HP -.ad l \fB--mergesnapshot\fP .br -.ad b Merge COW snapshot LV into its origin. When merging a snapshot, if both the origin and snapshot LVs are not open, the merge will start immediately. Otherwise, the merge will start the @@ -1467,27 +1220,24 @@ reads or writes to the origin appear as being directed to the snapshot being merged. When the merge finishes, the merged snapshot is removed. Multiple snapshots may be specified on the command line or a @tag may be used to specify multiple snapshots be merged to their respective origin. +. .HP -.ad l \fB--mergethin\fP .br -.ad b Merge thin LV into its origin LV. The origin thin LV takes the content of the thin snapshot, and the thin snapshot LV is removed. See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB--metadataprofile\fP \fIString\fP .br -.ad b The metadata profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP .br -.ad b Specifies the type of mirror log for LVs with the "mirror" type (does not apply to the "raid1" type.) \fBdisk\fP is a persistent log and requires a small amount of @@ -1497,11 +1247,10 @@ In this case, the mirror must be synchronized (by copying LV data from the first device to others) each time the LV is activated, e.g. after reboot. \fBmirrored\fP is a persistent log that is itself mirrored, but should be avoided. Instead, use the raid1 type for log redundancy. +. .HP -.ad l \fB-m\fP|\fB--mirrors\fP [\fB+\fP|\fB-\fP]\fINumber\fP .br -.ad b Specifies the number of mirror images in addition to the original LV image, e.g. --mirrors 1 means there are two images of the data, the original and one mirror image. @@ -1511,100 +1260,88 @@ There are two mirroring implementations: "raid1" and "mirror". These are the names of the corresponding LV types, or "segment types". Use the --type option to specify which to use (raid1 is default, and mirror is legacy) -Use lvm.conf global/mirror_segtype_default and +Use \fBlvm.conf\fP(5) \fBglobal/mirror_segtype_default\fP and global/raid10_segtype_default to configure the default types. The plus prefix \fB+\fP can be used, in which case the number is added to the current number of images, or the minus prefix \fB-\fP can be used, in which case the number is subtracted from the current number of images. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB-n\fP|\fB--name\fP \fIString\fP .br -.ad b Specifies the name of a new LV. When unspecified, a default name of "lvol#" is generated, where # is a number generated by LVM. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--originname\fP \fILV\fP .br -.ad b Specifies the name to use for the external origin LV when converting an LV to a thin LV. The LV being converted becomes a read-only external origin with this name. +. .HP -.ad l \fB--poolmetadata\fP \fILV\fP .br -.ad b The name of a an LV to use for storing pool metadata. +. .HP -.ad l \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] .br -.ad b Specifies the size of the new pool metadata LV. +. .HP -.ad l \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP .br -.ad b Enable or disable the automatic creation and management of a spare pool metadata LV in the VG. A spare metadata LV is reserved space that can be used when repairing a pool. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--raidintegrity\fP \fBy\fP|\fBn\fP .br -.ad b Enable or disable data integrity checksums for raid images. +. .HP -.ad l \fB--raidintegrityblocksize\fP \fINumber\fP .br -.ad b The block size to use for dm-integrity on raid images. The integrity block size should usually match the device logical block size, or the file system block size. It may be less than the file system block size, but not less than the device logical block size. Possible values: 512, 1024, 2048, 4096. +. .HP -.ad l \fB--raidintegritymode\fP \fIString\fP .br -.ad b Use a journal (default) or bitmap for keeping integrity checksums consistent in case of a crash. The bitmap areas are recalculated after a crash, so corruption in those areas would not be detected. A journal does not have this problem. @@ -1612,135 +1349,119 @@ The journal mode doubles writes to storage, but can improve performance for scattered writes packed into a single journal write. bitmap mode can in theory achieve full write throughput of the device, but would not benefit from the potential scattered write optimization. +. .HP -.ad l \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP .br -.ad b Sets read ahead sector count of an LV. \fBauto\fP is the default which allows the kernel to choose a suitable value automatically. \fBnone\fP is equivalent to zero. +. .HP -.ad l \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] .br -.ad b Size of each raid or mirror synchronization region. -lvm.conf activation/raid_region_size can be used to +\fBlvm.conf\fP(5) \fBactivation/raid_region_size\fP can be used to configure a default. +. .HP -.ad l \fB--repair\fP .br -.ad b Replace failed PVs in a raid or mirror LV, or run a repair utility on a thin pool. See \fBlvmraid\fP(7) and \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB--replace\fP \fIPV\fP .br -.ad b Replace a specific PV in a raid LV with another PV. The new PV to use can be optionally specified after the LV. Multiple PVs can be replaced by repeating this option. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB-s\fP|\fB--snapshot\fP .br -.ad b Combine a former COW snapshot LV with a former origin LV to reverse a previous --splitsnapshot command. +. .HP -.ad l \fB--splitcache\fP .br -.ad b Separates a cache pool from a cache LV, and keeps the unused cache pool LV. Before the separation, the cache is flushed. Also see --uncache. +. .HP -.ad l \fB--splitmirrors\fP \fINumber\fP .br -.ad b Splits the specified number of images from a raid1 or mirror LV and uses them to create a new LV. If --trackchanges is also specified, changes to the raid1 LV are tracked while the split LV remains detached. If --name is specified, then the images are permanently split from the original LV and changes are not tracked. +. .HP -.ad l \fB--splitsnapshot\fP .br -.ad b Separates a COW snapshot from its origin LV. The LV that is split off contains the chunks that differ from the origin LV along with metadata describing them. This LV can be wiped and then destroyed with lvremove. +. .HP -.ad l \fB--startpoll\fP .br -.ad b Start polling an LV to continue processing a conversion. +. .HP -.ad l \fB--stripes\fP \fINumber\fP .br -.ad b Specifies the number of stripes in a striped LV. This is the number of PVs (devices) that a striped LV is spread across. Data that appears sequential in the LV is spread across multiple devices in units of the stripe size (see --stripesize). This does not apply to existing allocated space, only newly allocated space can be striped. +. .HP -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] .br -.ad b The amount of data that is written to one device before moving to the next in a striped LV. +. .HP -.ad l \fB--swapmetadata\fP .br -.ad b Extracts the metadata LV from a pool and replaces it with another specified LV. The extracted LV is preserved and given the name of the LV that replaced it. Use for repair only. When the metadata LV is swapped out of the pool, it can be activated directly and used with thin provisioning tools: \fBcache_dump\fP(8), \fBcache_repair\fP(8), \fBcache_restore\fP(8), \fBthin_dump\fP(8), \fBthin_repair\fP(8), \fBthin_restore\fP(8). +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-T\fP|\fB--thin\fP .br -.ad b Specifies the command is handling a thin LV or thin pool. See --type thin, --type thin-pool, and --virtualsize. See \fBlvmthin\fP(7) for more information about LVM thin provisioning. +. .HP -.ad l \fB--thinpool\fP \fILV\fP .br -.ad b The name of a thin pool LV. +. .HP -.ad l \fB--trackchanges\fP .br -.ad b Can be used with --splitmirrors on a raid1 LV. This causes changes to the original raid1 LV to be tracked while the split images remain detached. This is a temporary state that allows the read-only @@ -1749,14 +1470,15 @@ Only the regions with changed data are resynchronized during merge. While a raid1 LV is tracking changes, operations on it are limited to merging the split image (see --mergemirrors) or permanently splitting the image (see --splitmirrors with --name. +. .HP .ad l -\fB--type\fP +\fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.br .ad b +.br The LV type, also known as "segment type" or "segtype". See usage descriptions for the specific ways to use these types. For more information about redundancy and performance (\fBraid\fP<N>, \fBmirror\fP, \fBstriped\fP, \fBlinear\fP) see \fBlvmraid\fP(7). @@ -1768,50 +1490,44 @@ Several commands omit an explicit type option because the type is inferred from other options or shortcuts (e.g. --stripes, --mirrors, --snapshot, --virtualsize, --thin, --cache, --vdo). Use inferred types with care because it can lead to unexpected results. +. .HP -.ad l \fB--uncache\fP .br -.ad b Separates a cache pool from a cache LV, and deletes the unused cache pool LV. Before the separation, the cache is flushed. Also see --splitcache. +. .HP -.ad l \fB--usepolicies\fP .br -.ad b -Perform an operation according to the policy configured in lvm.conf +Perform an operation according to the policy configured in \fBlvm.conf\fP(5) or a profile. +. .HP -.ad l \fB--vdopool\fP \fILV\fP .br -.ad b The name of a VDO pool LV. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] .br -.ad b The virtual size of a new thin LV. See \fBlvmthin\fP(7) for more information about LVM thin provisioning. Using virtual size (-V) and actual size (-L) together creates a sparse LV. -lvm.conf global/sparse_segtype_default determines the +\fBlvm.conf\fP(5) \fBglobal/sparse_segtype_default\fP determines the default segment type used to create a sparse LV. Anything written to a sparse LV will be returned when reading from it. Reading from other areas of the LV will return blocks of zeros. @@ -1819,38 +1535,35 @@ When using a snapshot to create a sparse LV, a hidden virtual device is created using the zero target, and the LV has the suffix _vorigin. Snapshots are less efficient than thin provisioning when creating large sparse LVs (GiB). +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .HP -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .br -.ad b For snapshots, this controls zeroing of the first 4KiB of data in the snapshot. If the LV is read-only, the snapshot will not be zeroed. For thin pools, this controls zeroing of provisioned blocks. Provisioning of large zeroed chunks negatively impacts performance. +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -LV followed by _<type> indicates that an LV of the -given type is required. (raid represents raid<N> type) -.HP -\fIPV\fP -.br +LV1 indicates the LV must have a specific type, where the +accepted LV types are listed. (raid represents raid<N> type). +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -1858,278 +1571,261 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. +. .SH ADVANCED USAGE +. Alternate command forms, advanced command usage, and listing of all valid syntax for completeness. .P Change the region size of an LV. .br .P -\fBlvconvert\fP \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] \fILV\fP\fI_raid\fP +\fBlvconvert\fP \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: raid +.RE +.P +\(em +.P Change the type of mirror log used by a mirror LV. .br .P -\fBlvconvert\fP \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP \fILV\fP\fI_mirror\fP +\fBlvconvert\fP \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: mirror +.RE +.P +\(em +.P Convert LV to a thin LV, using the original LV as an external origin .br (infers --type thin). .br .P -\fBlvconvert\fP \fB-T\fP|\fB--thin\fP \fB--thinpool\fP \fILV\fP \fILV\fP\fI_linear_striped_thin_cache_raid_error_zero\fP +\fBlvconvert\fP \fB-T\fP|\fB--thin\fP \fB--thinpool\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--type\fP \fBthin\fP ] -.ad b .br -.ad l [ \fB--originname\fP \fILV\fP\fI_new\fP ] -.ad b .br -.ad l [ \fB--poolmetadata\fP \fILV\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thin cache raid error zero +.RE +.P +\(em +.P Attach a cache pool to an LV (infers --type cache). .br .P -\fBlvconvert\fP \fB-H\fP|\fB--cache\fP \fB--cachepool\fP \fILV\fP \fILV\fP\fI_linear_striped_thinpool_vdo_vdopool_vdopooldata_raid\fP +\fBlvconvert\fP \fB-H\fP|\fB--cache\fP \fB--cachepool\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--type\fP \fBcache\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--poolmetadata\fP \fILV\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thinpool vdo vdopool vdopooldata raid +.RE +.P +\(em +.P Attach a cache to an LV, converts the LV to type cache. .br .P -\fBlvconvert\fP \fB-H\fP|\fB--cache\fP \fB--cachevol\fP \fILV\fP \fILV\fP\fI_linear_striped_thinpool_raid\fP +\fBlvconvert\fP \fB-H\fP|\fB--cache\fP \fB--cachevol\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped thinpool raid +.RE +.P +\(em +.P Convert LV to type vdopool. .br .P -\fBlvconvert\fP \fB--vdopool\fP \fILV\fP\fI_linear_striped_cache_raid\fP +\fBlvconvert\fP \fB--vdopool\fP \fILV\fP .br .RS 4 .ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--name\fP \fILV\fP\fI_new\fP ] -.ad b .br -.ad l [ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--type\fP \fBvdo-pool\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--compression\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--deduplication\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Detach and delete a cache from an LV. .br .P -\fBlvconvert\fP \fB--uncache\fP \fILV\fP\fI_thinpool_cache_vdopool_writecache\fP +\fBlvconvert\fP \fB--uncache\fP \fILV1\fP .br .RS 4 .ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thinpool cache vdopool writecache +.RE +.P +\(em +.P Swap metadata LV in a thin pool or cache pool (for repair only). .br .P -\fBlvconvert\fP \fB--swapmetadata\fP \fB--poolmetadata\fP \fILV\fP \fILV\fP\fI_thinpool_cachepool\fP +\fBlvconvert\fP \fB--swapmetadata\fP \fB--poolmetadata\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thinpool cachepool +.RE +.P +\(em +.P Merge LV that was split from a mirror (variant, use --mergemirrors). .br Merge thin LV into its origin LV (variant, use --mergethin). @@ -2137,245 +1833,80 @@ Merge thin LV into its origin LV (variant, use --mergethin). Merge COW snapshot LV into its origin (variant, use --mergesnapshot). .br .P -\fBlvconvert\fP \fB--merge\fP \fIVG\fP|\fILV\fP\fI_linear_striped_snapshot_thin_raid\fP|\fITag\fP ... +\fBlvconvert\fP \fB--merge\fP \fIVG\fP|\fILV1\fP|\fITag\fP ... .br .RS 4 .ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped snapshot thin raid +.RE +.P +\(em +.P Separate a COW snapshot from its origin LV. .br .P -\fBlvconvert\fP \fB--splitsnapshot\fP \fILV\fP\fI_snapshot\fP +\fBlvconvert\fP \fB--splitsnapshot\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: snapshot +.RE +.P +\(em +.P Combine a former COW snapshot (second arg) with a former .br origin LV (first arg) to reverse a splitsnapshot command. .br .P -\fBlvconvert\fP \fB-s\fP|\fB--snapshot\fP \fILV\fP \fILV\fP\fI_linear_striped\fP +\fBlvconvert\fP \fB-s\fP|\fB--snapshot\fP \fILV\fP \fILV1\fP .br .RS 4 .ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--type\fP \fBsnapshot\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: linear striped +.RE +.P +\(em +.P Poll LV to continue conversion (also see --startpoll) .br or waits till conversion/mirror syncing is finished .br .P -\fBlvconvert\fP \fILV\fP\fI_mirror_raid\fP +\fBlvconvert\fP \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - -.SH NOTES -This previous command syntax would perform two different operations: -.br -\fBlvconvert --thinpool\fP \fILV1\fP \fB--poolmetadata\fP \fILV2\fP -.br -If LV1 was not a thin pool, the command would convert LV1 to -a thin pool, optionally using a specified LV for metadata. -But, if LV1 was already a thin pool, the command would swap -the current metadata LV with LV2 (for repair purposes.) - -In the same way, this previous command syntax would perform two different -operations: -.br -\fBlvconvert --cachepool\fP \fILV1\fP \fB--poolmetadata\fP \fILV2\fP -.br -If LV1 was not a cache pool, the command would convert LV1 to -a cache pool, optionally using a specified LV for metadata. -But, if LV1 was already a cache pool, the command would swap -the current metadata LV with LV2 (for repair purposes.) -.SH EXAMPLES -Convert a linear LV to a two-way mirror LV. -.br -.B lvconvert --type mirror --mirrors 1 vg/lvol1 - -Convert a linear LV to a two-way RAID1 LV. -.br -.B lvconvert --type raid1 --mirrors 1 vg/lvol1 - -Convert a mirror LV to use an in-memory log. -.br -.B lvconvert --mirrorlog core vg/lvol1 - -Convert a mirror LV to use a disk log. -.br -.B lvconvert --mirrorlog disk vg/lvol1 - -Convert a mirror or raid1 LV to a linear LV. -.br -.B lvconvert --type linear vg/lvol1 - -Convert a mirror LV to a raid1 LV with the same number of images. -.br -.B lvconvert --type raid1 vg/lvol1 - -Convert a linear LV to a two-way mirror LV, allocating new extents from specific -PV ranges. -.br -.B lvconvert --mirrors 1 vg/lvol1 /dev/sda:0-15 /dev/sdb:0-15 - -Convert a mirror LV to a linear LV, freeing physical extents from a specific PV. -.br -.B lvconvert --type linear vg/lvol1 /dev/sda - -Split one image from a mirror or raid1 LV, making it a new LV. -.br -.B lvconvert --splitmirrors 1 --name lv_split vg/lvol1 - -Split one image from a raid1 LV, and track changes made to the raid1 LV -while the split image remains detached. -.br -.B lvconvert --splitmirrors 1 --trackchanges vg/lvol1 - -Merge an image (that was previously created with --splitmirrors and ---trackchanges) back into the original raid1 LV. -.br -.B lvconvert --mergemirrors vg/lvol1_rimage_1 - -Replace PV /dev/sdb1 with PV /dev/sdf1 in a raid1/4/5/6/10 LV. -.br -.B lvconvert --replace /dev/sdb1 vg/lvol1 /dev/sdf1 - -Replace 3 PVs /dev/sd[b-d]1 with PVs /dev/sd[f-h]1 in a raid1 LV. -.br -.B lvconvert --replace /dev/sdb1 --replace /dev/sdc1 --replace /dev/sdd1 -.RS -.B vg/lvol1 /dev/sd[fgh]1 -.RE - -Replace the maximum of 2 PVs /dev/sd[bc]1 with PVs /dev/sd[gh]1 in a raid6 LV. -.br -.B lvconvert --replace /dev/sdb1 --replace /dev/sdc1 vg/lvol1 /dev/sd[gh]1 - -Convert an LV into a thin LV in the specified thin pool. The existing LV -is used as an external read-only origin for the new thin LV. -.br -.B lvconvert --type thin --thinpool vg/tpool1 vg/lvol1 - -Convert an LV into a thin LV in the specified thin pool. The existing LV -is used as an external read-only origin for the new thin LV, and is -renamed "external". -.br -.B lvconvert --type thin --thinpool vg/tpool1 -.RS -.B --originname external vg/lvol1 -.RE - -Convert an LV to a cache pool LV using another specified LV for cache pool -metadata. -.br -.B lvconvert --type cache-pool --poolmetadata vg/poolmeta1 vg/lvol1 - -Convert an LV to a cache LV using the specified cache pool and chunk size. -.br -.B lvconvert --type cache --cachepool vg/cpool1 -c 128 vg/lvol1 - -Detach and keep the cache pool from a cache LV. -.br -.B lvconvert --splitcache vg/lvol1 - -Detach and remove the cache pool from a cache LV. -.br -.B lvconvert --uncache vg/lvol1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) +.P +.RS 4 +LV1 types: mirror raid +.RE +.P +\(em +.P diff --git a/man/lvcreate.8_pregen b/man/lvcreate.8_pregen index 140344fa8..c73d1bafc 100644 --- a/man/lvcreate.8_pregen +++ b/man/lvcreate.8_pregen @@ -1,8 +1,11 @@ .TH LVCREATE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvcreate - Create a logical volume +. +lvcreate \(em Create a logical volume . .SH SYNOPSIS +. \fBlvcreate\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -12,349 +15,209 @@ lvcreate - Create a logical volume .P .ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP -.ad b .br -.ad l \fB--addtag\fP \fITag\fP -.ad b .br -.ad l - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.ad b .br -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-H\fP|\fB--cache\fP -.ad b .br -.ad l \fB--cachedevice\fP \fIPV\fP -.ad b .br -.ad l \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP -.ad b .br -.ad l \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP -.ad b .br -.ad l \fB--cachepolicy\fP \fIString\fP -.ad b .br -.ad l \fB--cachepool\fP \fILV\fP -.ad b .br -.ad l \fB--cachesettings\fP \fIString\fP -.ad b .br -.ad l \fB--cachesize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--cachevol\fP \fILV\fP -.ad b .br -.ad l \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--compression\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-C\fP|\fB--contiguous\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--deduplication\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--errorwhenfull\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB-K\fP|\fB--ignoreactivationskip\fP -.ad b .br -.ad l \fB--ignoremonitoring\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB-j\fP|\fB--major\fP \fINumber\fP -.ad b .br -.ad l - \fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] -.ad b + \fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad l \fB--metadataprofile\fP \fIString\fP -.ad b .br -.ad l \fB--minor\fP \fINumber\fP -.ad b .br -.ad l - \fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] -.ad b + \fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad l \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP -.ad b .br -.ad l \fB-m\fP|\fB--mirrors\fP \fINumber\fP -.ad b .br -.ad l \fB--monitor\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-n\fP|\fB--name\fP \fIString\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--nosync\fP -.ad b .br -.ad l \fB--noudevsync\fP -.ad b .br -.ad l \fB-p\fP|\fB--permission\fP \fBrw\fP|\fBr\fP -.ad b .br -.ad l \fB-M\fP|\fB--persistent\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--raidintegrity\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--raidintegrityblocksize\fP \fINumber\fP -.ad b .br -.ad l \fB--raidintegritymode\fP \fIString\fP -.ad b .br -.ad l \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP -.ad b .br -.ad l \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP -.ad b .br -.ad l \fB-k\fP|\fB--setactivationskip\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB-s\fP|\fB--snapshot\fP -.ad b .br -.ad l \fB-i\fP|\fB--stripes\fP \fINumber\fP -.ad b .br -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-T\fP|\fB--thin\fP -.ad b .br -.ad l \fB--thinpool\fP \fILV\fP -.ad b .br -.ad l - \fB--type\fP + \fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.ad b .br -.ad l \fB--vdo\fP -.ad b .br -.ad l \fB--vdopool\fP \fILV\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB-W\fP|\fB--wipesignatures\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP -.ad b .br -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .ad b +. .SH DESCRIPTION +. lvcreate creates a new LV in a VG. For standard LVs, this requires allocating logical extents from the VG's free physical extents. If there is not enough free space, the VG can be extended with other PVs (\fBvgextend\fP(8)), or existing LVs can be reduced or removed -(\fBlvremove\fP(8), \fBlvreduce\fP(8).) - +(\fBlvremove\fP(8), \fBlvreduce\fP(8)). +.P To control which PVs a new LV will use, specify one or more PVs as position args at the end of the command line. lvcreate will allocate physical extents only from the specified PVs. - +.P lvcreate can also create snapshots of existing LVs, e.g. for backup purposes. The data in a new snapshot LV represents the content of the original LV from the time the snapshot was created. - +.P RAID LVs can be created by specifying an LV type when creating the LV (see \fBlvmraid\fP(7)). Different RAID levels require different numbers of unique PVs be available in the VG for allocation. - +.P Thin pools (for thin provisioning) and cache pools (for caching) are represented by special LVs with types thin-pool and cache-pool (see \fBlvmthin\fP(7) and \fBlvmcache\fP(7)). The pool LVs are not usable as standard block devices, but the LV names act as references to the pools. - +.P Thin LVs are thinly provisioned from a thin pool, and are created with a virtual size rather than a physical size. A cache LV is the combination of a standard LV with a cache pool, used to cache active portions of the LV to improve performance. - +.P VDO LVs are also provisioned volumes from a VDO pool, and are created with a virtual size rather than a physical size (see \fBlvmvdo\fP(7)). - +.P .SS Usage notes In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See descriptions in the options section. - +.P In the usage section below, \fB--name\fP is omitted from the required options, even though it is typically used. When the name is not specified, a new LV name is generated with the "lvol" prefix and a unique numeric suffix. - +.P In the usage section below, when creating a pool and the name is omitted the new LV pool name is generated with the "vpool" for vdo-pools for prefix and a unique numeric suffix. - +.P Pool name can be specified together with \fIVG\fP name i.e.: vg00/mythinpool. +. .SH USAGE +. Create a linear LV. .br .P @@ -363,20 +226,18 @@ Create a linear LV. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB--type\fP \fBlinear\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a striped LV (infers --type striped). .br .P @@ -385,20 +246,20 @@ Create a striped LV (infers --type striped). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b +.br +[ \fB--type\fP \fBstriped\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a raid1 or mirror LV (infers --type raid1|mirror). .br .P @@ -407,32 +268,28 @@ Create a raid1 or mirror LV (infers --type raid1|mirror). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l +[ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] +.br +[ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] +.br [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP ] -.ad b .br -.ad l -[ \fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a raid LV (a specific raid level must be used, e.g. raid1). .br .P @@ -441,52 +298,34 @@ Create a raid LV (a specific raid level must be used, e.g. raid1). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-m\fP|\fB--mirrors\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-m\fP|\fB--mirrors\fP \fINumber\fP ] +.br [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l -[ \fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--raidintegrity\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--raidintegritymode\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--raidintegrityblocksize\fP \fINumber\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a raid10 LV. .br .P @@ -498,32 +337,24 @@ Create a raid10 LV. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l -[ \fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a COW snapshot LV of an origin LV. .br .P @@ -532,32 +363,24 @@ Create a COW snapshot LV of an origin LV. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--type\fP \fBsnapshot\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin pool. .br .P @@ -566,48 +389,34 @@ Create a thin pool. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--thinpool\fP \fILV\fP\fI_new\fP ] -.ad b +[ \fB-T\fP|\fB--thin\fP ] .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB--thinpool\fP \fILV\fP\fI_new\fP ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a cache pool. .br .P @@ -616,135 +425,89 @@ Create a cache pool. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-H\fP|\fB--cache\fP ] -.ad b +[ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] .br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-H\fP|\fB--cache\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV in a thin pool (infers --type thin). .br .P -\fBlvcreate\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fB--thinpool\fP \fILV\fP\fI_thinpool\fP \fIVG\fP +\fBlvcreate\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fB--thinpool\fP \fILV\fP \fIVG\fP .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b .br -.ad l [ \fB--type\fP \fBthin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Create a thin LV that is a snapshot of an existing thin LV .br (infers --type thin). .br .P -\fBlvcreate\fP \fB-s\fP|\fB--snapshot\fP \fILV\fP\fI_thin\fP +\fBlvcreate\fP \fB-s\fP|\fB--snapshot\fP \fILV1\fP .br .RS 4 .ad l [ \fB--type\fP \fBthin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thin +.RE +.P +\(em +.P Create a thin LV that is a snapshot of an external origin LV. .br .P -\fBlvcreate\fP \fB--type\fP \fBthin\fP \fB--thinpool\fP \fILV\fP\fI_thinpool\fP \fILV\fP +\fBlvcreate\fP \fB--type\fP \fBthin\fP \fB--thinpool\fP \fILV\fP \fILV\fP .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b -.br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Create a LV that returns VDO when used. .br .P @@ -753,99 +516,30 @@ Create a LV that returns VDO when used. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] -.ad b -.br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] +.br [ \fB--vdo\fP ] -.ad b .br -.ad l [ \fB--vdopool\fP \fILV\fP\fI_new\fP ] -.ad b .br -.ad l [ \fB--compression\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--deduplication\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] -.RE -.br -.RS 4 -[ \fIPV\fP ... ] -.RE -- - -Create a thin LV, first creating a thin pool for it, -.br -where the new thin pool is named by the --thinpool arg. -.br -.P -\fBlvcreate\fP \fB--type\fP \fBthin\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] -.RS 5 - \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] \fB--thinpool\fP \fILV\fP\fI_new\fP -.RE -.br -.RS 4 -.ad l -[ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l -[ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b -.br -.ad l -[ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b -.br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b -.br -[ COMMON_OPTIONS ] .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach the specified cachepool .br which converts the new LV to type cache. @@ -853,62 +547,42 @@ which converts the new LV to type cache. .P \fBlvcreate\fP \fB--type\fP \fBcache\fP \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] .RS 5 - \fB--cachepool\fP \fILV\fP\fI_cachepool\fP \fIVG\fP + \fB--cachepool\fP \fILV\fP \fIVG\fP .RE .br .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-H\fP|\fB--cache\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-H\fP|\fB--cache\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach the specified cachevol .br which converts the new LV to type cache. @@ -922,44 +596,30 @@ which converts the new LV to type cache. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] +.br [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach a cachevol created from .br the specified cache device, which converts the @@ -975,48 +635,32 @@ new LV to type cache. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] +.br +[ \fB--cachesize\fP \fISize\fP[m|UNIT] ] +.br [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b -.br -.ad l -[ \fB--cachesize\fP \fISize\fP[m|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach the specified cachevol .br which converts the new LV to type writecache. @@ -1030,28 +674,22 @@ which converts the new LV to type writecache. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach a cachevol created from .br the specified cache device, which converts the @@ -1067,201 +705,122 @@ new LV to type writecache. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--cachesize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP ] -.ad b .br -.ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-C\fP|\fB--contiguous\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-K\fP|\fB--ignoreactivationskip\fP ] -.ad b .br -.ad l [ \fB-j\fP|\fB--major\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--name\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-p\fP|\fB--permission\fP \fBrw\fP|\fBr\fP ] -.ad b .br -.ad l [ \fB-M\fP|\fB--persistent\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ] -.ad b .br -.ad l [ \fB-k\fP|\fB--setactivationskip\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-W\fP|\fB--wipesignatures\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--addtag\fP \fITag\fP ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--minor\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--nosync\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--setautoactivation\fP \fBy\fP|\fBn\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP .br -.ad b Controls the active state of the new LV. \fBy\fP makes the LV active, or available. New LVs are made active by default. @@ -1271,24 +830,24 @@ For example, COW snapshots of an active origin LV can only be created in the active state (this does not apply to thin snapshots). The --zero option normally requires the LV to be active. If autoactivation \fBay\fP is used, the LV is only activated -if it matches an item in lvm.conf activation/auto_activation_volume_list. +if it matches an item in \fBlvm.conf\fP(5) \fBactivation/auto_activation_volume_list\fP. \fBay\fP implies --zero n and --wipesignatures n. See \fBlvmlockd\fP(8) for more information about activation options for shared VGs. +. .HP -.ad l \fB--addtag\fP \fITag\fP .br -.ad b Adds a tag to a PV, VG or LV. This option can be repeated to add multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -1305,38 +864,33 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB-H\fP|\fB--cache\fP .br -.ad b Specifies the command is handling a cache LV or cache pool. See --type cache and --type cache-pool. See \fBlvmcache\fP(7) for more information about LVM caching. +. .HP -.ad l \fB--cachedevice\fP \fIPV\fP .br -.ad b The name of a device to use for a cache. +. .HP -.ad l \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP .br -.ad b Specifies the cache metadata format used by cache target. +. .HP -.ad l \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP .br -.ad b Specifies when writes to a cache LV should be considered complete. \fBwriteback\fP considers a write complete as soon as it is stored in the cache pool. @@ -1348,24 +902,21 @@ cache pool LV. With \fBpassthrough\fP, all reads are served from the origin LV (all reads miss the cache) and all writes are forwarded to the origin LV; additionally, write hits cause cache block invalidates. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachepolicy\fP \fIString\fP .br -.ad b Specifies the cache policy for a cache LV. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachepool\fP \fILV\fP .br -.ad b The name of a cache pool. +. .HP -.ad l \fB--cachesettings\fP \fIString\fP .br -.ad b Specifies tunable values for a cache LV in "Key = Value" form. Repeat this option to specify multiple values. (The default values should usually be adequate.) @@ -1373,23 +924,20 @@ The special string value \fBdefault\fP switches settings back to their default kernel values and removes them from the list of settings stored in LVM metadata. See \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--cachesize\fP \fISize\fP[m|UNIT] .br -.ad b The size of cache to use. +. .HP -.ad l \fB--cachevol\fP \fILV\fP .br -.ad b The name of a cache volume. +. .HP -.ad l \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] .br -.ad b The size of chunks in a snapshot, cache pool or thin pool. For snapshots, the value must be a power of 2 between 4KiB and 512KiB and the default value is 4. @@ -1400,76 +948,67 @@ and the default value starts with 64 and scales up to fit the pool metadata size within 128MiB, if the pool metadata size is not specified. The value must be a multiple of 64KiB. See \fBlvmthin\fP(7) and \fBlvmcache\fP(7) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--compression\fP \fBy\fP|\fBn\fP .br -.ad b Controls whether compression is enabled or disable for VDO volume. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-C\fP|\fB--contiguous\fP \fBy\fP|\fBn\fP .br -.ad b Sets or resets the contiguous allocation policy for LVs. Default is no contiguous allocation based on a next free principle. It is only possible to change a non-contiguous allocation policy to contiguous if all of the allocated physical extents in the LV are already contiguous. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--deduplication\fP \fBy\fP|\fBn\fP .br -.ad b Controls whether deduplication is enabled or disable for VDO volume. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP .br -.ad b Specifies how the device-mapper thin pool layer in the kernel should handle discards. \fBignore\fP causes the thin pool to ignore discards. @@ -1478,18 +1017,16 @@ allow reuse of unneeded extents in the thin pool. \fBpassdown\fP causes the thin pool to process discards itself (like nopassdown) and pass the discards to the underlying device. See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--errorwhenfull\fP \fBy\fP|\fBn\fP .br -.ad b Specifies thin pool behavior when data space is exhausted. When yes, device-mapper will immediately return an error when a thin pool is full and an I/O request requires space. @@ -1498,11 +1035,10 @@ period of time to allow the thin pool to be extended. Errors are returned if no space is available after the timeout. (Also see dm-thin-pool kernel module option no_space_timeout.) See \fBlvmthin\fP(7) for more information. +. .HP -.ad l \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] .br -.ad b Specifies the size of the new LV in logical extents. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -1518,81 +1054,70 @@ the whole origin). When expressed as a percentage, the size defines an upper limit for the number of logical extents in the new LV. The precise number of logical extents in the new LV is not determined until the command has completed. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-K\fP|\fB--ignoreactivationskip\fP .br -.ad b Ignore the "activation skip" LV flag during activation to allow LVs with the flag set to be activated. +. .HP -.ad l \fB--ignoremonitoring\fP .br -.ad b Do not interact with dmeventd unless --monitor is specified. Do not use this if dmeventd is already monitoring a device. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-j\fP|\fB--major\fP \fINumber\fP .br -.ad b Sets the major number of an LV block device. +. .HP -.ad l -\fB--[raid]maxrecoveryrate\fP \fISize\fP[k|UNIT] +\fB--\fP[\fBraid\fP]\fBmaxrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad b Sets the maximum recovery rate for a RAID LV. The rate value is an amount of data per second for each device in the array. Setting the rate to 0 means it will be unbounded. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--metadataprofile\fP \fIString\fP .br -.ad b The metadata profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--minor\fP \fINumber\fP .br -.ad b Sets the minor number of an LV block device. +. .HP -.ad l -\fB--[raid]minrecoveryrate\fP \fISize\fP[k|UNIT] +\fB--\fP[\fBraid\fP]\fBminrecoveryrate\fP \fISize\fP[k|UNIT] .br -.ad b Sets the minimum recovery rate for a RAID LV. The rate value is an amount of data per second for each device in the array. Setting the rate to 0 means it will be unbounded. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP .br -.ad b Specifies the type of mirror log for LVs with the "mirror" type (does not apply to the "raid1" type.) \fBdisk\fP is a persistent log and requires a small amount of @@ -1602,11 +1127,10 @@ In this case, the mirror must be synchronized (by copying LV data from the first device to others) each time the LV is activated, e.g. after reboot. \fBmirrored\fP is a persistent log that is itself mirrored, but should be avoided. Instead, use the raid1 type for log redundancy. +. .HP -.ad l \fB-m\fP|\fB--mirrors\fP \fINumber\fP .br -.ad b Specifies the number of mirror images in addition to the original LV image, e.g. --mirrors 1 means there are two images of the data, the original and one mirror image. @@ -1616,38 +1140,34 @@ There are two mirroring implementations: "raid1" and "mirror". These are the names of the corresponding LV types, or "segment types". Use the --type option to specify which to use (raid1 is default, and mirror is legacy) -Use lvm.conf global/mirror_segtype_default and +Use \fBlvm.conf\fP(5) \fBglobal/mirror_segtype_default\fP and global/raid10_segtype_default to configure the default types. See the --nosync option for avoiding initial image synchronization. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--monitor\fP \fBy\fP|\fBn\fP .br -.ad b Start (yes) or stop (no) monitoring an LV with dmeventd. dmeventd monitors kernel events for an LV, and performs automated maintenance for the LV in reponse to specific events. See \fBdmeventd\fP(8) for more information. +. .HP -.ad l \fB-n\fP|\fB--name\fP \fIString\fP .br -.ad b Specifies the name of a new LV. When unspecified, a default name of "lvol#" is generated, where # is a number generated by LVM. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosync\fP .br -.ad b Causes the creation of mirror, raid1, raid4, raid5 and raid10 to skip the initial synchronization. In case of mirror, raid1 and raid10, any data written afterwards will be mirrored, but the original contents will not be @@ -1660,77 +1180,67 @@ This option is not valid for raid6, because raid6 relies on proper parity to reconstruct proper user date in case of device failures. raid0 and raid0_meta do not provide any data copies or parity support and thus do not support initial synchronization. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB-p\fP|\fB--permission\fP \fBrw\fP|\fBr\fP .br -.ad b Set access permission to read only \fBr\fP or read and write \fBrw\fP. +. .HP -.ad l \fB-M\fP|\fB--persistent\fP \fBy\fP|\fBn\fP .br -.ad b When yes, makes the specified minor number persistent. +. .HP -.ad l \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] .br -.ad b Specifies the size of the new pool metadata LV. +. .HP -.ad l \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP .br -.ad b Enable or disable the automatic creation and management of a spare pool metadata LV in the VG. A spare metadata LV is reserved space that can be used when repairing a pool. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--raidintegrity\fP \fBy\fP|\fBn\fP .br -.ad b Enable or disable data integrity checksums for raid images. +. .HP -.ad l \fB--raidintegrityblocksize\fP \fINumber\fP .br -.ad b The block size to use for dm-integrity on raid images. The integrity block size should usually match the device logical block size, or the file system block size. It may be less than the file system block size, but not less than the device logical block size. Possible values: 512, 1024, 2048, 4096. +. .HP -.ad l \fB--raidintegritymode\fP \fIString\fP .br -.ad b Use a journal (default) or bitmap for keeping integrity checksums consistent in case of a crash. The bitmap areas are recalculated after a crash, so corruption in those areas would not be detected. A journal does not have this problem. @@ -1738,50 +1248,45 @@ The journal mode doubles writes to storage, but can improve performance for scattered writes packed into a single journal write. bitmap mode can in theory achieve full write throughput of the device, but would not benefit from the potential scattered write optimization. +. .HP -.ad l \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP .br -.ad b Sets read ahead sector count of an LV. \fBauto\fP is the default which allows the kernel to choose a suitable value automatically. \fBnone\fP is equivalent to zero. +. .HP -.ad l \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] .br -.ad b Size of each raid or mirror synchronization region. -lvm.conf activation/raid_region_size can be used to +\fBlvm.conf\fP(5) \fBactivation/raid_region_size\fP can be used to configure a default. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-k\fP|\fB--setactivationskip\fP \fBy\fP|\fBn\fP .br -.ad b Persistently sets (yes) or clears (no) the "activation skip" flag on an LV. An LV with this flag set is not activated unless the --ignoreactivationskip option is used by the activation command. This flag is set by default on new thin snapshot LVs. The flag is not applied to deactivation. The current value of the flag is indicated in the lvs lv_attr bits. +. .HP -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP .br -.ad b Set the autoactivation property on a VG or LV. Display the property with vgs or lvs "-o autoactivation". When the autoactivation property is disabled, the VG or LV @@ -1791,20 +1296,18 @@ If autoactivation is disabled on a VG, no LVs will be autoactivated in that VG, and the LV autoactivation property has no effect. If autoactivation is enabled on a VG, autoactivation can be disabled for individual LVs. +. .HP -.ad l \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] .br -.ad b Specifies the size of the new LV. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be greater when redundant data is needed for RAID levels. +. .HP -.ad l \fB-s\fP|\fB--snapshot\fP .br -.ad b Create a snapshot. Snapshots provide a "frozen image" of an origin LV. The snapshot LV can be used, e.g. for backups, while the origin LV continues to be used. @@ -1830,11 +1333,10 @@ A small amount of the COW snapshot LV size is used to track COW block locations, so the full size is not available for COW data blocks. Use lvs to check how much space is used, and see --monitor to to automatically extend the size to avoid running out of space. +. .HP -.ad l \fB-i\fP|\fB--stripes\fP \fINumber\fP .br -.ad b Specifies the number of stripes in a striped LV. This is the number of PVs (devices) that a striped LV is spread across. Data that appears sequential in the LV is spread across multiple devices in units of @@ -1846,46 +1348,43 @@ the RAID type (raid0: 64, raid10: 32, raid4/5: 63, raid6: 62), and when unspecified, the default depends on the RAID type (raid0: 2, raid10: 2, raid4/5: 3, raid6: 5.) To stripe a new raid LV across all PVs by default, -see lvm.conf allocation/raid_stripe_all_devices. +see \fBlvm.conf\fP(5) \fBallocation/raid_stripe_all_devices\fP. +. .HP -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] .br -.ad b The amount of data that is written to one device before moving to the next in a striped LV. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-T\fP|\fB--thin\fP .br -.ad b Specifies the command is handling a thin LV or thin pool. See --type thin, --type thin-pool, and --virtualsize. See \fBlvmthin\fP(7) for more information about LVM thin provisioning. +. .HP -.ad l \fB--thinpool\fP \fILV\fP .br -.ad b The name of a thin pool LV. +. .HP .ad l -\fB--type\fP +\fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.br .ad b +.br The LV type, also known as "segment type" or "segtype". See usage descriptions for the specific ways to use these types. For more information about redundancy and performance (\fBraid\fP<N>, \fBmirror\fP, \fBstriped\fP, \fBlinear\fP) see \fBlvmraid\fP(7). @@ -1897,44 +1396,39 @@ Several commands omit an explicit type option because the type is inferred from other options or shortcuts (e.g. --stripes, --mirrors, --snapshot, --virtualsize, --thin, --cache, --vdo). Use inferred types with care because it can lead to unexpected results. +. .HP -.ad l \fB--vdo\fP .br -.ad b Specifies the command is handling VDO LV. See --type vdo. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB--vdopool\fP \fILV\fP .br -.ad b The name of a VDO pool LV. See \fBlvmvdo\fP(7) for more information about VDO usage. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] .br -.ad b The virtual size of a new thin LV. See \fBlvmthin\fP(7) for more information about LVM thin provisioning. Using virtual size (-V) and actual size (-L) together creates a sparse LV. -lvm.conf global/sparse_segtype_default determines the +\fBlvm.conf\fP(5) \fBglobal/sparse_segtype_default\fP determines the default segment type used to create a sparse LV. Anything written to a sparse LV will be returned when reading from it. Reading from other areas of the LV will return blocks of zeros. @@ -1942,61 +1436,57 @@ When using a snapshot to create a sparse LV, a hidden virtual device is created using the zero target, and the LV has the suffix _vorigin. Snapshots are less efficient than thin provisioning when creating large sparse LVs (GiB). +. .HP -.ad l \fB-W\fP|\fB--wipesignatures\fP \fBy\fP|\fBn\fP .br -.ad b Controls detection and subsequent wiping of signatures on new LVs. There is a prompt for each signature detected to confirm its wiping (unless --yes is used to override confirmations.) When not specified, signatures are wiped whenever zeroing is done (see --zero). This behaviour can be configured with -lvm.conf allocation/wipe_signatures_when_zeroing_new_lvs. -If blkid wiping is used (lvm.conf allocation/use_blkid_wiping) +\fBlvm.conf\fP(5) \fBallocation/wipe_signatures_when_zeroing_new_lvs\fP. +If blkid wiping is used (\fBlvm.conf\fP(5) \fBallocation/use_blkid_wiping\fP) and LVM is compiled with blkid wiping support, then the blkid(8) library is used to detect the signatures (use blkid -k to list the signatures that are recognized). Otherwise, native LVM code is used to detect signatures (only MD RAID, swap and LUKS signatures are detected in this case.) The LV is not wiped if the read only flag is set. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .HP -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .br -.ad b Controls zeroing of the first 4KiB of data in the new LV. Default is \fBy\fP. Snapshot COW volumes are always zeroed. For thin pools, this controls zeroing of provisioned blocks. LV is not zeroed if the read only flag is set. Warning: trying to mount an unzeroed LV can cause the system to hang. +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. For lvcreate, the required VG positional arg may be omitted when the VG name is included in another option, e.g. --name VG/LV. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -LV followed by _<type> indicates that an LV of the -given type is required. (raid represents raid<N> type) -.HP -\fIPV\fP -.br +LV1 indicates the LV must have a specific type, where the +accepted LV types are listed. (raid represents raid<N> type). +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -2004,26 +1494,42 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. +. .SH ADVANCED USAGE +. Alternate command forms, advanced command usage, and listing of all valid syntax for completeness. .P Create an LV that returns errors when used. @@ -2034,13 +1540,13 @@ Create an LV that returns errors when used. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Create an LV that returns zeros when read. .br .P @@ -2049,13 +1555,13 @@ Create an LV that returns zeros when read. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Create a linear LV. .br .P @@ -2064,16 +1570,16 @@ Create a linear LV. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a striped LV (also see lvcreate --stripes). .br .P @@ -2082,24 +1588,20 @@ Create a striped LV (also see lvcreate --stripes). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a mirror LV (also see --type raid1). .br .P @@ -2108,36 +1610,26 @@ Create a mirror LV (also see --type raid1). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-m\fP|\fB--mirrors\fP \fINumber\fP ] -.ad b -.br -.ad l -[ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] -.ad b -.br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-m\fP|\fB--mirrors\fP \fINumber\fP ] +.br +[ \fB-R\fP|\fB--regionsize\fP \fISize\fP[m|UNIT] ] +.br [ \fB--mirrorlog\fP \fBcore\fP|\fBdisk\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a COW snapshot LV of an origin LV .br (also see --snapshot). @@ -2148,32 +1640,24 @@ Create a COW snapshot LV of an origin LV .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-s\fP|\fB--snapshot\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a sparse COW snapshot LV of a virtual origin LV .br (also see --snapshot). @@ -2187,53 +1671,20 @@ Create a sparse COW snapshot LV of a virtual origin LV .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-s\fP|\fB--snapshot\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] -.RE -.br -.RS 4 -[ \fIPV\fP ... ] -.RE -- - -Create a sparse COW snapshot LV of a virtual origin LV. -.br -.P -\fBlvcreate\fP \fB-s\fP|\fB--snapshot\fP \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] -.RS 5 - \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fIVG\fP -.RE -.br -.RS 4 -.ad l -[ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l -[ \fB--type\fP \fBsnapshot\fP ] .ad b -.br -[ COMMON_OPTIONS ] .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin pool (infers --type thin-pool). .br .P @@ -2242,48 +1693,32 @@ Create a thin pool (infers --type thin-pool). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l -[ \fB--type\fP \fBthin-pool\fP ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB--type\fP \fBthin-pool\fP ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin pool named by the --thinpool arg .br (infers --type thin-pool). @@ -2294,52 +1729,34 @@ Create a thin pool named by the --thinpool arg .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--type\fP \fBthin-pool\fP ] -.ad b +[ \fB-T\fP|\fB--thin\fP ] .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB--type\fP \fBthin-pool\fP ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a cache pool named by the --cachepool arg .br (variant, uses --cachepool in place of --name). @@ -2353,111 +1770,75 @@ Create a cache pool named by the --cachepool arg .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l -[ \fB-H\fP|\fB--cache\fP ] -.ad b +[ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] .br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b +[ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-H\fP|\fB--cache\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV in a thin pool. .br .P \fBlvcreate\fP \fB--type\fP \fBthin\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] .RS 5 - \fB--thinpool\fP \fILV\fP\fI_thinpool\fP \fIVG\fP + \fB--thinpool\fP \fILV\fP \fIVG\fP .RE .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b -.br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b -.br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Create a thin LV in a thin pool named in the first arg .br (variant, also see --thinpool for naming pool). .br .P -\fBlvcreate\fP \fB--type\fP \fBthin\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fILV\fP\fI_thinpool\fP +\fBlvcreate\fP \fB--type\fP \fBthin\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fILV1\fP .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thinpool +.RE +.P +\(em +.P Create a thin LV in the thin pool named in the first arg .br (variant, infers --type thin, also see --thinpool for @@ -2465,103 +1846,81 @@ Create a thin LV in the thin pool named in the first arg naming pool.) .br .P -\fBlvcreate\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fILV\fP\fI_thinpool\fP +\fBlvcreate\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fILV1\fP .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b .br -.ad l [ \fB--type\fP \fBthin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thinpool +.RE +.P +\(em +.P Create a thin LV that is a snapshot of an existing thin LV. .br .P -\fBlvcreate\fP \fB--type\fP \fBthin\fP \fILV\fP\fI_thin\fP +\fBlvcreate\fP \fB--type\fP \fBthin\fP \fILV1\fP .br .RS 4 .ad l [ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thin +.RE +.P +\(em +.P Create a thin LV that is a snapshot of an existing thin LV .br (infers --type thin). .br .P -\fBlvcreate\fP \fB-T\fP|\fB--thin\fP \fILV\fP\fI_thin\fP +\fBlvcreate\fP \fB-T\fP|\fB--thin\fP \fILV1\fP .br .RS 4 .ad l [ \fB--type\fP \fBthin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +.RS 4 +LV1 types: thin +.RE +.P +\(em +.P Create a thin LV that is a snapshot of an external origin LV .br (infers --type thin). .br .P -\fBlvcreate\fP \fB-s\fP|\fB--snapshot\fP \fB--thinpool\fP \fILV\fP\fI_thinpool\fP \fILV\fP +\fBlvcreate\fP \fB-s\fP|\fB--snapshot\fP \fB--thinpool\fP \fILV\fP \fILV\fP .br .RS 4 .ad l [ \fB--type\fP \fBthin\fP ] -.ad b -.br -.ad l -[ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b -.br -.ad l -[ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Create a VDO LV with VDO pool. .br .P @@ -2570,40 +1929,30 @@ Create a VDO LV with VDO pool. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--type\fP \fBvdo\fP ] +.br [ \fB--vdopool\fP \fILV\fP\fI_new\fP ] -.ad b .br -.ad l [ \fB--compression\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--deduplication\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a VDO LV with VDO pool. .br .P @@ -2612,101 +1961,69 @@ Create a VDO LV with VDO pool. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] ] +.br [ \fB--vdo\fP ] -.ad b .br -.ad l [ \fB--type\fP \fBvdo\fP ] -.ad b .br -.ad l [ \fB--compression\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--deduplication\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV, first creating a thin pool for it, .br -where the new thin pool is named by the --thinpool arg -.br -(variant, infers --type thin). +where the new thin pool is named by the --thinpool arg. .br .P -\fBlvcreate\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] +\fBlvcreate\fP \fB--type\fP \fBthin\fP \fB-V\fP|\fB--virtualsize\fP \fISize\fP[m|UNIT] .RS 5 - \fB--thinpool\fP \fILV\fP\fI_new\fP + \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] \fB--thinpool\fP \fILV\fP\fI_new\fP \fIVG\fP .RE .br .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-T\fP|\fB--thin\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV, first creating a thin pool for it, .br where the new thin pool is named by the --thinpool arg @@ -2722,48 +2039,34 @@ where the new thin pool is named by the --thinpool arg .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-T\fP|\fB--thin\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] +.br +[ \fB--type\fP \fBthin\fP ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV, first creating a thin pool for it, .br where the new thin pool is named in the first arg, @@ -2781,48 +2084,32 @@ arg is a VG name. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-T\fP|\fB--thin\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-T\fP|\fB--thin\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV, first creating a thin pool for it, .br where the new thin pool is named in the first arg, @@ -2840,44 +2127,32 @@ arg is a VG name (variant, infers --type thin). .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB--type\fP \fBthin\fP ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a thin LV, first creating a thin pool for it .br (infers --type thin). @@ -2896,52 +2171,36 @@ config setting sparse_segtype_default. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-s\fP|\fB--snapshot\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--type\fP \fBsnapshot\fP ] -.ad b +[ \fB-s\fP|\fB--snapshot\fP ] .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-T\fP|\fB--thin\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] +.br +[ \fB--type\fP \fIString\fP ] .br -.ad l [ \fB--discards\fP \fBpassdown\fP|\fBnopassdown\fP|\fBignore\fP ] -.ad b .br -.ad l [ \fB--errorwhenfull\fP \fBy\fP|\fBn\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach the specified cachepool .br which converts the new LV to type cache @@ -2949,57 +2208,39 @@ which converts the new LV to type cache (variant, infers --type cache.) .br .P -\fBlvcreate\fP \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] \fB--cachepool\fP \fILV\fP\fI_cachepool\fP \fIVG\fP +\fBlvcreate\fP \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] \fB--cachepool\fP \fILV\fP \fIVG\fP .br .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-H\fP|\fB--cache\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB-H\fP|\fB--cache\fP ] +.br +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] +.br [ \fB--type\fP \fBcache\fP ] -.ad b .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Create a new LV, then attach the specified cachepool .br which converts the new LV to type cache. @@ -3007,61 +2248,45 @@ which converts the new LV to type cache. (variant, also use --cachepool). .br .P -\fBlvcreate\fP \fB--type\fP \fBcache\fP \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] \fILV\fP\fI_cachepool\fP +\fBlvcreate\fP \fB--type\fP \fBcache\fP \fB-L\fP|\fB--size\fP \fISize\fP[m|UNIT] \fILV1\fP .br .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b -.br -.ad l -[ \fB-H\fP|\fB--cache\fP ] -.ad b -.br -.ad l -[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b +[ \fB-H\fP|\fB--cache\fP ] .br -.ad l -[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b +[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] .br -.ad l [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b +.br +[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] +.br +[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: cachepool +.RE +.P +\(em +.P When the LV arg is a cachepool, then create a new LV and .br attach the cachepool arg to it. @@ -3078,223 +2303,33 @@ and attach it to the LV arg (alternative, use lvconvert.) .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP \fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l +[ \fB--type\fP \fBcache\fP ] +.br [ \fB--cachemode\fP \fBwritethrough\fP|\fBwriteback\fP|\fBpassthrough\fP ] -.ad b .br -.ad l [ \fB--cachepolicy\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachesettings\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--cachemetadataformat\fP \fBauto\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - -.SH EXAMPLES - -Create a striped LV with 3 stripes, a stripe size of 8KiB and a size of 100MiB. -The LV name is chosen by lvcreate. -.br -.B lvcreate -i 3 -I 8 -L 100m vg00 - -Create a raid1 LV with two images, and a useable size of 500 MiB. This -operation requires two devices, one for each mirror image. RAID metadata -(superblock and bitmap) is also included on the two devices. -.br -.B lvcreate --type raid1 -m1 -L 500m -n mylv vg00 - -Create a mirror LV with two images, and a useable size of 500 MiB. -This operation requires three devices: two for mirror images and -one for a disk log. -.br -.B lvcreate --type mirror -m1 -L 500m -n mylv vg00 - -Create a mirror LV with 2 images, and a useable size of 500 MiB. -This operation requires 2 devices because the log is in memory. -.br -.B lvcreate --type mirror -m1 --mirrorlog core -L 500m -n mylv vg00 - -Create a copy-on-write snapshot of an LV: -.br -.B lvcreate --snapshot --size 100m --name mysnap vg00/mylv - -Create a copy-on-write snapshot with a size sufficient -for overwriting 20% of the size of the original LV. -.br -.B lvcreate -s -l 20%ORIGIN -n mysnap vg00/mylv - -Create a sparse LV with 1TiB of virtual space, and actual space just under -100MiB. -.br -.B lvcreate --snapshot --virtualsize 1t --size 100m --name mylv vg00 - -Create a linear LV with a usable size of 64MiB on specific physical extents. -.br -.B lvcreate -L 64m -n mylv vg00 /dev/sda:0-7 /dev/sdb:0-7 - -Create a RAID5 LV with a usable size of 5GiB, 3 stripes, a stripe size of -64KiB, using a total of 4 devices (including one for parity). -.br -.B lvcreate --type raid5 -L 5G -i 3 -I 64 -n mylv vg00 - -Create a RAID5 LV using all of the free space in the VG and spanning all the -PVs in the VG (note that the command will fail if there are more than 8 PVs in -the VG, in which case \fB-i 7\fP must be used to get to the current maximum of -8 devices including parity for RaidLVs). -.br -.B lvcreate --config allocation/raid_stripe_all_devices=1 -.RS -.B --type raid5 -l 100%FREE -n mylv vg00 -.RE - -Create RAID10 LV with a usable size of 5GiB, using 2 stripes, each on -a two-image mirror. (Note that the \fB-i\fP and \fB-m\fP arguments behave -differently: -\fB-i\fP specifies the total number of stripes, -but \fB-m\fP specifies the number of images in addition -to the first image). -.br -.B lvcreate --type raid10 -L 5G -i 2 -m 1 -n mylv vg00 - -Create a 1TiB thin LV mythin, with 256GiB thinpool tpool0 in vg00. -.br -.B lvcreate --T --size 256G --name mythin vg00/tpool0 - -Create a 1TiB thin LV, first creating a new thin pool for it, where -the thin pool has 100MiB of space, uses 2 stripes, has a 64KiB stripe -size, and 256KiB chunk size. -.br -.B lvcreate --type thin --name mylv --thinpool mypool -.RS -.B -V 1t -L 100m -i 2 -I 64 -c 256 vg00 -.RE - -Create a thin snapshot of a thin LV (the size option must not be -used, otherwise a copy-on-write snapshot would be created). -.br -.B lvcreate --snapshot --name mysnap vg00/thinvol - -Create a thin snapshot of the read-only inactive LV named "origin" -which becomes an external origin for the thin snapshot LV. -.br -.B lvcreate --snapshot --name mysnap --thinpool mypool vg00/origin - -Create a cache pool from a fast physical device. The cache pool can -then be used to cache an LV. -.br -.B lvcreate --type cache-pool -L 1G -n my_cpool vg00 /dev/fast1 - -Create a cache LV, first creating a new origin LV on a slow physical device, -then combining the new origin LV with an existing cache pool. -.br -.B lvcreate --type cache --cachepool my_cpool -.RS -.B -L 100G -n mylv vg00 /dev/slow1 -.RE - -Create a VDO LV vdo0 with VDOPoolLV size of 10GiB and name vpool1. -.br -.B lvcreate --vdo --size 10G --name vdo0 vg00/vpool1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) +.P +\(em +.P diff --git a/man/lvdisplay.8_pregen b/man/lvdisplay.8_pregen index be1c8b73e..8ff34bc08 100644 --- a/man/lvdisplay.8_pregen +++ b/man/lvdisplay.8_pregen @@ -1,363 +1,277 @@ .TH LVDISPLAY 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvdisplay - Display information about a logical volume +. +lvdisplay \(em Display information about a logical volume . .SH SYNOPSIS +. \fBlvdisplay\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. lvdisplay shows the attributes of LVs, like size, read/write status, snapshot information, etc. - +.P \fBlvs\fP(8) is a preferred alternative that shows the same information and more, using a more compact and configurable output format. +. .SH USAGE +. \fBlvdisplay\fP .br .RS 4 .ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--colon\fP ] -.ad b .br -.ad l [ \fB-C\fP|\fB--columns\fP ] -.ad b .br -.ad l [ \fB-H\fP|\fB--history\fP ] -.ad b .br -.ad l [ \fB-m\fP|\fB--maps\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--segments\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fILV\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Show information about internal LVs. These are components of normal LVs, such as mirrors, which are not independently accessible, e.g. not mountable. +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB-c\fP|\fB--colon\fP .br -.ad b Generate colon separated output for easier parsing in scripts or programs. Also see \fBvgs\fP(8) which provides considerably more control over the output. +. .HP -.ad l \fB-C\fP|\fB--columns\fP .br -.ad b Display output in columns, the equivalent of \fBvgs\fP(8). Options listed are the same as options given in \fBvgs\fP(8). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-H\fP|\fB--history\fP .br -.ad b Include historical LVs in the output. (This has no effect unless LVs were removed while -lvm.conf metadata/record_lvs_history was enabled. +\fBlvm.conf\fP(5) \fBmetadata/record_lvs_history\fP was enabled. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-m\fP|\fB--maps\fP .br -.ad b Display the mapping of logical extents to PVs and physical extents. To map physical extents to logical extents use: pvs --segments -o+lv_name,seg_start_pe,segtype +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -371,54 +285,48 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--segments\fP .br -.ad b +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -427,175 +335,115 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvextend.8_pregen b/man/lvextend.8_pregen index 83216b972..fc4d55233 100644 --- a/man/lvextend.8_pregen +++ b/man/lvextend.8_pregen @@ -1,8 +1,11 @@ .TH LVEXTEND 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvextend - Add space to a logical volume +. +lvextend \(em Add space to a logical volume . .SH SYNOPSIS +. \fBlvextend\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -11,152 +14,94 @@ lvextend - Add space to a logical volume .br .P .ad l - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.ad b .br -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-l\fP|\fB--extents\fP [\fB+\fP]\fINumber\fP[PERCENT] -.ad b .br -.ad l \fB-f\fP|\fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB-m\fP|\fB--mirrors\fP \fINumber\fP -.ad b .br -.ad l \fB-n\fP|\fB--nofsck\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--nosync\fP -.ad b .br -.ad l \fB--noudevsync\fP -.ad b .br -.ad l \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP -.ad b .br -.ad l \fB-r\fP|\fB--resizefs\fP -.ad b .br -.ad l \fB-L\fP|\fB--size\fP [\fB+\fP]\fISize\fP[m|UNIT] -.ad b .br -.ad l \fB-i\fP|\fB--stripes\fP \fINumber\fP -.ad b .br -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l - \fB--type\fP + \fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.ad b .br -.ad l \fB--usepolicies\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. lvextend extends the size of an LV. This requires allocating logical extents from the VG's free physical extents. If the extension adds a new LV segment, the new segment will use the existing segment type of the LV. - +.P Extending a copy-on-write snapshot LV adds space for COW blocks. - +.P Use \fBlvconvert\fP(8) to change the number of data images in a RAID or mirrored LV. - +.P In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See both descriptions the options section. +. .SH USAGE +. Extend an LV by a specified size. .br .P @@ -165,32 +110,24 @@ Extend an LV by a specified size. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP [\fB+\fP]\fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-r\fP|\fB--resizefs\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Extend an LV by specified PV extents. .br .P @@ -199,185 +136,144 @@ Extend an LV by specified PV extents. .RS 4 .ad l [ \fB-r\fP|\fB--resizefs\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Extend a pool metadata SubLV by a specified size. .br .P -\fBlvextend\fP \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] \fILV\fP\fI_thinpool\fP +\fBlvextend\fP \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] \fILV1\fP .br .RS 4 .ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: thinpool +.RE +.P +\(em +.P Extend an LV according to a predefined policy. .br .P -\fBlvextend\fP \fB--usepolicies\fP \fILV\fP\fI_snapshot_thinpool\fP +\fBlvextend\fP \fB--usepolicies\fP \fILV1\fP .br .RS 4 .ad l [ \fB-r\fP|\fB--resizefs\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: snapshot thinpool +.RE +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-m\fP|\fB--mirrors\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--nofsck\fP ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l [ \fB--nosync\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l -[ \fB--type\fP +[ \fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -394,66 +290,58 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-l\fP|\fB--extents\fP [\fB+\fP]\fINumber\fP[PERCENT] .br -.ad b Specifies the new size of the LV in logical extents. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -472,57 +360,49 @@ extents in the new LV is not determined until the command has completed. When the plus \fB+\fP or minus \fB-\fP prefix is used, the value is not an absolute size, but is relative and added or subtracted from the current size. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-m\fP|\fB--mirrors\fP \fINumber\fP .br -.ad b Not used. +. .HP -.ad l \fB-n\fP|\fB--nofsck\fP .br -.ad b Do not perform fsck before resizing filesystem when filesystem requires it. You may need to use --force to proceed with this option. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosync\fP .br -.ad b Causes the creation of mirror, raid1, raid4, raid5 and raid10 to skip the initial synchronization. In case of mirror, raid1 and raid10, any data written afterwards will be mirrored, but the original contents will not be @@ -535,59 +415,52 @@ This option is not valid for raid6, because raid6 relies on proper parity to reconstruct proper user date in case of device failures. raid0 and raid0_meta do not provide any data copies or parity support and thus do not support initial synchronization. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] .br -.ad b Specifies the new size of the pool metadata LV. The plus prefix \fB+\fP can be used, in which case the value is added to the current size. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-r\fP|\fB--resizefs\fP .br -.ad b Resize underlying filesystem together with the LV using fsadm(8). +. .HP -.ad l \fB-L\fP|\fB--size\fP [\fB+\fP]\fISize\fP[m|UNIT] .br -.ad b Specifies the new size of the LV. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -595,11 +468,10 @@ greater when redundant data is needed for RAID levels. When the plus \fB+\fP or minus \fB-\fP prefix is used, the value is not an absolute size, but is relative and added or subtracted from the current size. +. .HP -.ad l \fB-i\fP|\fB--stripes\fP \fINumber\fP .br -.ad b Specifies the number of stripes in a striped LV. This is the number of PVs (devices) that a striped LV is spread across. Data that appears sequential in the LV is spread across multiple devices in units of @@ -611,32 +483,31 @@ the RAID type (raid0: 64, raid10: 32, raid4/5: 63, raid6: 62), and when unspecified, the default depends on the RAID type (raid0: 2, raid10: 2, raid4/5: 3, raid6: 5.) To stripe a new raid LV across all PVs by default, -see lvm.conf allocation/raid_stripe_all_devices. +see \fBlvm.conf\fP(5) \fBallocation/raid_stripe_all_devices\fP. +. .HP -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] .br -.ad b The amount of data that is written to one device before moving to the next in a striped LV. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP .ad l -\fB--type\fP +\fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.br .ad b +.br The LV type, also known as "segment type" or "segtype". See usage descriptions for the specific ways to use these types. For more information about redundancy and performance (\fBraid\fP<N>, \fBmirror\fP, \fBstriped\fP, \fBlinear\fP) see \fBlvmraid\fP(7). @@ -648,45 +519,41 @@ Several commands omit an explicit type option because the type is inferred from other options or shortcuts (e.g. --stripes, --mirrors, --snapshot, --virtualsize, --thin, --cache, --vdo). Use inferred types with care because it can lead to unexpected results. +. .HP -.ad l \fB--usepolicies\fP .br -.ad b -Perform an operation according to the policy configured in lvm.conf +Perform an operation according to the policy configured in \fBlvm.conf\fP(5) or a profile. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fILV\fP -.br +. +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -LV followed by _<type> indicates that an LV of the -given type is required. (raid represents raid<N> type) -.HP -\fIPV\fP -.br +LV1 indicates the LV must have a specific type, where the +accepted LV types are listed. (raid represents raid<N> type). +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -694,105 +561,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES -Extend the size of an LV by 54MiB, using a specific PV. -.br -.B lvextend -L +54 vg01/lvol10 /dev/sdk3 - -Extend the size of an LV by the amount of free -space on PV /dev/sdk3. This is equivalent to specifying -"-l +100%PVS" on the command line. -.br -.B lvextend vg01/lvol01 /dev/sdk3 - -Extend an LV by 16MiB using specific physical extents. -.br -.B lvextend -L+16m vg01/lvol01 /dev/sda:8-9 /dev/sdb:8-9 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvm-fullreport.8_pregen b/man/lvm-fullreport.8_pregen index 33e2dfaad..399d4ff9a 100644 --- a/man/lvm-fullreport.8_pregen +++ b/man/lvm-fullreport.8_pregen @@ -1,330 +1,251 @@ .TH LVM FULLREPORT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvm fullreport - Display full report +. +lvm fullreport \(em Display full report . .SH SYNOPSIS +. \fBlvm fullreport\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. lvm fullreport produces formatted output about PVs, PV segments, VGs, LVs and LV segments. The information is all gathered together for each VG (under a per-VG lock) so it is consistent. Information gathered from separate calls to \fBvgs\fP, \fBpvs\fP, and \fBlvs\fP can be inconsistent if information changes between commands. +. .SH USAGE +. \fBlvm fullreport\fP .br .RS 4 .ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--nameprefixes\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--rows\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br -.ad l [ \fB--unquoted\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nameprefixes\fP .br -.ad b Add an "LVM2_" prefix plus the field name to the output. Useful with --noheadings to produce a list of field=value pairs that can be used to set environment variables (for example, in udev rules). +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -338,55 +259,49 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--rows\fP .br -.ad b Output columns as rows. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -395,172 +310,113 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB--unquoted\fP .br -.ad b When used with --nameprefixes, output values in the field=value pairs are not quoted. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvm-lvpoll.8_pregen b/man/lvm-lvpoll.8_pregen index 3aff67d19..cf18ebeec 100644 --- a/man/lvm-lvpoll.8_pregen +++ b/man/lvm-lvpoll.8_pregen @@ -1,381 +1,247 @@ .TH LVM LVPOLL 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvm lvpoll - Continue already initiated poll operation on a logical volume +. +lvm lvpoll \(em Continue already initiated poll operation on a logical volume . .SH SYNOPSIS +. \fBlvm lvpoll\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. lvm lvpoll is an internal command used by \fBlvmpolld\fP(8) to monitor and complete \fBlvconvert\fP(8) and \fBpvmove\fP(8) operations. lvpoll itself does not initiate these operations and should not normally need to be run directly. +. .SH USAGE +. \fBlvm lvpoll\fP \fB--polloperation\fP \fBpvmove\fP|\fBconvert\fP|\fBmerge\fP|\fBmerge_thin\fP \fILV\fP ... .br .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--abort\fP ] -.ad b .br -.ad l [ \fB--handlemissingpvs\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--abort\fP .br -.ad b Stop processing a poll operation in lvmpolld. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--handlemissingpvs\fP .br -.ad b Allows a polling operation to continue when PVs are missing, e.g. for repairs due to faulty devices. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-i\fP|\fB--interval\fP \fINumber\fP .br -.ad b Report progress at regular intervals. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--polloperation\fP \fBpvmove\fP|\fBconvert\fP|\fBmerge\fP|\fBmerge_thin\fP .br -.ad b The command to perform from lvmpolld. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fILV\fP -.br +. +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES - -To find the name of the pvmove LV that was created by an original -\fBpvmove /dev/name\fP command, use the command: -.br -\fBlvs -a -S move_pv=/dev/name\fP. -.SH EXAMPLES - -Continue polling a pvmove operation. -.br -.B lvm lvpoll --polloperation pvmove vg00/pvmove0 - -Abort a pvmove operation. -.br -.B lvm lvpoll --polloperation pvmove --abort vg00/pvmove0 - -Continue polling a mirror conversion. -.br -.B lvm lvpoll --polloperation convert vg00/lvmirror - -Continue mirror repair. -.br -.B lvm lvpoll --polloperation convert vg/damaged_mirror --handlemissingpvs - -Continue snapshot merge. -.br -.B lvm lvpoll --polloperation merge vg/snapshot_old - -Continue thin snapshot merge. -.br -.B lvm lvpoll --polloperation merge_thin vg/thin_snapshot -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvmconfig.8_pregen b/man/lvmconfig.8_pregen index 469a6b9e8..6cdb577c1 100644 --- a/man/lvmconfig.8_pregen +++ b/man/lvmconfig.8_pregen @@ -1,187 +1,126 @@ .TH LVMCONFIG 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvmconfig - Display and manipulate configuration information +. +lvmconfig \(em Display and manipulate configuration information . .SH SYNOPSIS +. \fBlvmconfig\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. lvmconfig, lvm config, lvm dumpconfig (for compatibility reasons, to be phased out) produce formatted output from the LVM configuration tree. The sources of the configuration data include \fBlvm.conf\fP(5) and command line settings from --config. +. .SH USAGE +. \fBlvmconfig\fP .br .RS 4 .ad l [ \fB-f\fP|\fB--file\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-l\fP|\fB--list\fP ] -.ad b .br -.ad l [ \fB--atversion\fP \fIString\fP ] -.ad b .br -.ad l -[ \fB--typeconfig\fP +[ \fB--typeconfig\fP \c .nh -\fBcurrent\fP|\:\fBdefault\fP|\:\fBdiff\fP|\:\fBfull\fP|\:\fBlist\fP|\:\fBmissing\fP|\:\fBnew\fP|\:\fBprofilable\fP|\:\fBprofilable-command\fP|\:\fBprofilable-metadata\fP +\%\fBcurrent\fP|\:\fBdefault\fP|\:\fBdiff\fP|\:\fBfull\fP|\:\fBlist\fP|\:\fBmissing\fP|\:\fBnew\fP|\:\fBprofilable\fP|\:\fBprofilable-command\fP|\:\fBprofilable-metadata\fP .hy ] -.ad b .br -.ad l [ \fB--ignoreadvanced\fP ] -.ad b .br -.ad l [ \fB--ignoreunsupported\fP ] -.ad b .br -.ad l [ \fB--ignorelocal\fP ] -.ad b .br -.ad l [ \fB--mergedconfig\fP ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--sinceversion\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--showdeprecated\fP ] -.ad b .br -.ad l [ \fB--showunsupported\fP ] -.ad b .br -.ad l [ \fB--validate\fP ] -.ad b .br -.ad l [ \fB--withsummary\fP ] -.ad b .br -.ad l [ \fB--withcomments\fP ] -.ad b .br -.ad l [ \fB--withgeneralpreamble\fP ] -.ad b .br -.ad l [ \fB--withlocalpreamble\fP ] -.ad b .br -.ad l [ \fB--withspaces\fP ] -.ad b .br -.ad l [ \fB--unconfigured\fP ] -.ad b .br -.ad l [ \fB--withversions\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIString\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--atversion\fP \fIString\fP .br -.ad b 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 displayed, the configuration settings recognized @@ -189,116 +128,101 @@ at this LVM version will be considered only. This can be used to display a configuration that a certain LVM version understands and which does not contain any newer settings for which LVM would issue a warning message when checking the configuration. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--file\fP \fIString\fP .br -.ad b Write output to the named file. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignoreadvanced\fP .br -.ad b Exclude advanced configuration settings from the output. +. .HP -.ad l \fB--ignorelocal\fP .br -.ad b Ignore the local section. The local section should be defined in the lvmlocal.conf file, and should contain config settings specific to the local host which should not be copied to other hosts. +. .HP -.ad l \fB--ignoreunsupported\fP .br -.ad b Exclude unsupported configuration settings from the output. These settings are either used for debugging and development purposes only or their support is not yet complete and they are not meant to be used in production. The \fBcurrent\fP and \fBdiff\fP types include unsupported settings in their output by default, all the other types ignore unsupported settings. +. .HP -.ad l \fB-l\fP|\fB--list\fP .br -.ad b List config settings with summarizing comment. This is the same as using options --typeconfig list --withsummary. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--mergedconfig\fP .br -.ad b When the command is run with --config and/or --commandprofile (or using LVM_COMMAND_PROFILE environment variable), --profile, or --metadataprofile, @@ -306,81 +230,74 @@ merge all the contents of the "config cascade" before displaying it. Without merging, only the configuration at the front of the cascade is displayed. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--metadataprofile\fP \fIString\fP .br -.ad b The metadata profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--showdeprecated\fP .br -.ad b Include deprecated configuration settings in the output. These settings are deprecated after a certain version. If a concrete version is specified with --atversion, deprecated settings are automatically included if the specified version is lower than the version in which the settings were deprecated. The current and diff types include deprecated settings in their output by default, all the other types ignore deprecated settings. +. .HP -.ad l \fB--showunsupported\fP .br -.ad b Include unsupported configuration settings in the output. These settings are either used for debugging or development purposes only, or their support is not yet complete and they are not meant to be used in production. The current and diff types include unsupported settings in their output by default, all the other types ignore unsupported settings. +. .HP -.ad l \fB--sinceversion\fP \fIString\fP .br -.ad b 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). This option is currently applicable only with --typeconfig new to display all configuration settings introduced since given version. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP .ad l -\fB--typeconfig\fP +\fB--typeconfig\fP \c .nh -\fBcurrent\fP|\:\fBdefault\fP|\:\fBdiff\fP|\:\fBfull\fP|\:\fBlist\fP|\:\fBmissing\fP|\:\fBnew\fP|\:\fBprofilable\fP|\:\fBprofilable-command\fP|\:\fBprofilable-metadata\fP +\%\fBcurrent\fP|\:\fBdefault\fP|\:\fBdiff\fP|\:\fBfull\fP|\:\fBlist\fP|\:\fBmissing\fP|\:\fBnew\fP|\:\fBprofilable\fP|\:\fBprofilable-command\fP|\:\fBprofilable-metadata\fP .hy -.br .ad b +.br \fBcurrent\fP prints the config settings that would be applied to an lvm command (assuming the command does not override them on the command line.) This includes: @@ -413,168 +330,104 @@ with their default values. \fBprofilable-command\fP prints settings with their default values that can be set from a command profile. \fBprofilable-metadata\fP prints settings with their default values that can be set from a metadata profile. Also see \fBlvm.conf\fP(5). +. .HP -.ad l \fB--unconfigured\fP .br -.ad b Internal option used for generating config file during build. +. .HP -.ad l \fB--validate\fP .br -.ad b Validate current configuration used and exit with appropriate return code. The validation is done only for the configuration at the front of the "config cascade". To validate the whole merged configuration tree, also use --mergedconfig. -The validation is done even if lvm.conf config/checks is disabled. +The validation is done even if \fBlvm.conf\fP(5) \fBconfig/checks\fP is disabled. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB--withcomments\fP .br -.ad b Display a full comment for each configuration node. For deprecated settings, also display comments about deprecation. +. .HP -.ad l \fB--withgeneralpreamble\fP .br -.ad b Include general config file preamble. +. .HP -.ad l \fB--withlocalpreamble\fP .br -.ad b Include local config file preamble. +. .HP -.ad l \fB--withspaces\fP .br -.ad b Where appropriate, add more spaces in output for better readability. +. .HP -.ad l \fB--withsummary\fP .br -.ad b Display a one line comment for each configuration node. +. .HP -.ad l \fB--withversions\fP .br -.ad b Also display a comment containing the version of introduction for each configuration node. If the setting is deprecated, also display the version since which it is deprecated. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIString\fP -.br +. +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvmdevices.8_pregen b/man/lvmdevices.8_pregen index 6bdb5ff26..267ce965f 100644 --- a/man/lvmdevices.8_pregen +++ b/man/lvmdevices.8_pregen @@ -1,8 +1,11 @@ .TH LVMDEVICES 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvmdevices - Manage the devices file +. +lvmdevices \(em Manage the devices file . .SH SYNOPSIS +. \fBlvmdevices\fP \fIoption_args\fP .br [ \fIoption_args\fP ] @@ -10,108 +13,68 @@ lvmdevices - Manage the devices file .P .ad l \fB--adddev\fP \fIPV\fP -.ad b .br -.ad l \fB--addpvid\fP \fIString\fP -.ad b .br -.ad l \fB--check\fP -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--deldev\fP \fIPV\fP -.ad b .br -.ad l \fB--delpvid\fP \fIString\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB--update\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. The LVM devices file lists devices that lvm can use. The default file is -/etc/lvm/devices/system.devices, and the lvmdevices(8) command is used to +\fI#DEFAULT_SYS_DIR#/devices/system.devices\fP, and the \fBlvmdevices\fP(8) command is used to add or remove device entries. If the file does not exist, or if lvm.conf includes use_devicesfile=0, then lvm will not use a devices file. - +.P To use a device with lvm, add it to the devices file with the command lvmdevices --adddev, and to prevent lvm from seeing or using a device, remove it from the devices file with lvmdevices --deldev. The vgimportdevices(8) command adds all PVs from a VG to the devices file, and updates the VG metadata to include device IDs of the PVs. - +.P Commands adding new devices to the devices file necessarily look outside the existing devices file to find the devices to add. pvcreate, vgcreate, and vgextend also look outside the devices file to create new PVs and add them to the devices file. - +.P LVM records devices in the devices file using hardware-specific IDs, such as the WWID, and attempts to use subsystem-specific IDs for virtual device types (which also aim to be as unique and stable as possible.) @@ -119,436 +82,350 @@ These device IDs are also written in the VG metadata. When no hardware or virtual ID is available, lvm falls back using the unstable device name as the device ID. When devnames are used, lvm performs extra scanning to find devices if their devname changes, e.g. after reboot. - +.P When proper device IDs are used, an lvm command will not look at devices outside the devices file, but when devnames are used as a fallback, lvm will scan devices outside the devices file to locate PVs on renamed devices. A config setting search_for_devnames can be used to control the scanning for renamed devname entries. - +.P Related to the devices file, the new command option --devices <devnames> allows a list of devices to be specified for the command to use, overriding the devices file. The listed devices act as a sort of devices file in terms of limiting which devices lvm will see and use. Devices that are not listed will appear to be missing to the lvm command. - -Multiple devices files can be kept in /etc/lvm/devices, which allows lvm +.P +Multiple devices files can be kept in \fI#DEFAULT_SYS_DIR#/devices\fP, which allows lvm to be used with different sets of devices, e.g. system devices do not need to be exposed to a specific application, and the application can use lvm on its own devices that are not exposed to the system. The option --devicesfile <filename> is used to select the devices file to use with the command. Without the option set, the default system devices file is used. - +.P Setting --devicesfile "" causes lvm to not use a devices file. - +.P With no devices file, lvm will use any device on the system, and applies the filter to limit the full set of system devices. With a devices file, the regex filter is not used, and the filter settings in lvm.conf or the command line are ignored. The vgimportdevices command is one exception which does apply the regex filter when looking for a VG to import. - +.P If a devices file exists, lvm will use it, even if it's empty. An empty devices file means lvm will see no devices. - +.P If the system devices file does not yet exist, the pvcreate or vgcreate commands will create it if they see no existing VGs on the system. lvmdevices --addev and vgimportdevices will always create a new devices file if it does not yet exist. - +.P It is recommended to use lvm commands to make changes to the devices file to ensure proper updates. - +. .SH USAGE +. Print devices in the devices file. .br .P \fBlvmdevices\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Check the devices file and report incorrect values. .br .P \fBlvmdevices\fP \fB--check\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Update the devices file to fix incorrect values. .br .P \fBlvmdevices\fP \fB--update\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Add a device to the devices file. .br .P \fBlvmdevices\fP \fB--adddev\fP \fIPV\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Remove a device from the devices file. .br .P \fBlvmdevices\fP \fB--deldev\fP \fIPV\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Find the device with the given PVID and add it to the devices file. .br .P \fBlvmdevices\fP \fB--addpvid\fP \fIString\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Remove the devices file entry for the given PVID. .br .P \fBlvmdevices\fP \fB--delpvid\fP \fIString\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Common options for command: . .RS 4 +.ad l +.ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--adddev\fP \fIPV\fP .br -.ad b Add a device to the devices file. +. .HP -.ad l \fB--addpvid\fP \fIString\fP .br -.ad b Find a device with the PVID and add the device to the devices file. +. .HP -.ad l \fB--check\fP .br -.ad b Check the content of the devices file. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--deldev\fP \fIPV\fP .br -.ad b Remove a device from the devices file. +. .HP -.ad l \fB--delpvid\fP \fIString\fP .br -.ad b Remove a device with the PVID from the devices file. +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--update\fP .br -.ad b Update the content of the devices file. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIString\fP -.br +. +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvmdiskscan.8_pregen b/man/lvmdiskscan.8_pregen index f6cc0e2e2..5f31e8115 100644 --- a/man/lvmdiskscan.8_pregen +++ b/man/lvmdiskscan.8_pregen @@ -1,325 +1,229 @@ .TH LVMDISKSCAN 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvmdiskscan - List devices that may be used as physical volumes +. +lvmdiskscan \(em List devices that may be used as physical volumes . .SH SYNOPSIS +. \fBlvmdiskscan\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. lvmdiskscan scans all SCSI, (E)IDE disks, multiple devices and a bunch of other block devices in the system looking for LVM PVs. The size reported is the real device size. Define a filter in \fBlvm.conf\fP(5) to restrict the scan to avoid a CD ROM, for example. - +.P This command is deprecated, use \fBpvs\fP instead. - +. .SH USAGE +. \fBlvmdiskscan\fP .br .RS 4 .ad l [ \fB-l\fP|\fB--lvmpartition\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-l\fP|\fB--lvmpartition\fP .br -.ad b Only report PVs. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIString\fP -.br +. +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvreduce.8_pregen b/man/lvreduce.8_pregen index 49c9465d9..13522bb70 100644 --- a/man/lvreduce.8_pregen +++ b/man/lvreduce.8_pregen @@ -1,195 +1,153 @@ .TH LVREDUCE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvreduce - Reduce the size of a logical volume +. +lvreduce \(em Reduce the size of a logical volume . .SH SYNOPSIS +. \fBlvreduce\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. lvreduce reduces the size of an LV. The freed logical extents are returned to the VG to be used by other LVs. A copy-on-write snapshot LV can also be reduced if less space is needed to hold COW blocks. Use \fBlvconvert\fP(8) to change the number of data images in a RAID or mirrored LV. - +.P Be careful when reducing an LV's size, because data in the reduced area is lost. Ensure that any file system on the LV is resized \fBbefore\fP running lvreduce so that the removed extents are not in use by the file system. - +.P Sizes will be rounded if necessary. For example, the LV size must be an exact number of extents, and the size of a striped segment must be a multiple of the number of stripes. - +.P In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See both descriptions the options section. +. .SH USAGE +. \fBlvreduce\fP \fB-L\fP|\fB--size\fP [\fB-\fP]\fISize\fP[m|UNIT] \fILV\fP .br .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP [\fB-\fP]\fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--nofsck\fP ] -.ad b .br -.ad l [ \fB-r\fP|\fB--resizefs\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-l\fP|\fB--extents\fP [\fB-\fP]\fINumber\fP[PERCENT] .br -.ad b Specifies the new size of the LV in logical extents. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -208,91 +166,79 @@ extents in the new LV is not determined until the command has completed. When the plus \fB+\fP or minus \fB-\fP prefix is used, the value is not an absolute size, but is relative and added or subtracted from the current size. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-n\fP|\fB--nofsck\fP .br -.ad b Do not perform fsck before resizing filesystem when filesystem requires it. You may need to use --force to proceed with this option. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-r\fP|\fB--resizefs\fP .br -.ad b Resize underlying filesystem together with the LV using fsadm(8). +. .HP -.ad l \fB-L\fP|\fB--size\fP [\fB-\fP]\fISize\fP[m|UNIT] .br -.ad b Specifies the new size of the LV. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -300,133 +246,70 @@ greater when redundant data is needed for RAID levels. When the plus \fB+\fP or minus \fB-\fP prefix is used, the value is not an absolute size, but is relative and added or subtracted from the current size. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fILV\fP -.br +. +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Reduce the size of an LV by 3 logical extents: -.br -.B lvreduce -l -3 vg00/lvol1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvremove.8_pregen b/man/lvremove.8_pregen index 53ba71e0b..a5ed82666 100644 --- a/man/lvremove.8_pregen +++ b/man/lvremove.8_pregen @@ -1,28 +1,33 @@ .TH LVREMOVE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvremove - Remove logical volume(s) from the system +. +lvremove \(em Remove logical volume(s) from the system . .SH SYNOPSIS +. \fBlvremove\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. lvremove removes one or more LVs. For standard LVs, this returns the logical extents that were used by the LV to the VG for use by other LVs. - +.P Confirmation will be requested before deactivating any active LV prior to removal. LVs cannot be deactivated or removed while they are open (e.g. if they contain a mounted filesystem). Removing an origin LV will also remove all dependent snapshots. - +.P When a single force option is used, LVs are removed without confirmation, and the command will try to deactivate unused LVs. - +.P To remove damaged LVs, two force options may be required (\fB-ff\fP). - +.P \fBHistorical LVs\fP - +.P If the configuration setting \fBmetadata/record_lvs_history\fP is enabled and the LV being removed forms part of the history of at least one LV that is still present, then a simplified representation of the LV will be @@ -34,240 +39,185 @@ some intermediate LVs have been removed. The names of such historical LVs acquire a hyphen as a prefix (e.g. '-lvol1') and cannot be reactivated. Use lvremove a second time, with the hyphen, to remove the record of the former LV completely. +. .SH USAGE +. \fBlvremove\fP \fIVG\fP|\fILV\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--nohistory\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nohistory\fP .br -.ad b Do not record history of LVs being removed. This has no effect unless the configuration setting metadata/record_lvs_history is enabled. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -276,151 +226,82 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES -Remove an active LV without asking for confirmation. -.br -.B lvremove -f vg00/lvol1 - -Remove all LVs the specified VG. -.br -.B lvremove vg00 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvrename.8_pregen b/man/lvrename.8_pregen index 024da1821..5b5975fa3 100644 --- a/man/lvrename.8_pregen +++ b/man/lvrename.8_pregen @@ -1,363 +1,257 @@ .TH LVRENAME 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvrename - Rename a logical volume +. +lvrename \(em Rename a logical volume . .SH SYNOPSIS +. \fBlvrename\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. lvrename renames an existing LV or a historical LV (see \fBlvremove\fP for historical LV information.) +. .SH USAGE +. \fBlvrename\fP \fIVG\fP \fILV\fP \fILV\fP\fI_new\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P \fBlvrename\fP \fILV\fP \fILV\fP\fI_new\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Rename "lvold" to "lvnew": -.br -.B lvrename /dev/vg02/lvold vg02/lvnew - -An alternate syntax to rename "lvold" to "lvnew": -.br -.B lvrename vg02 lvold lvnew -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvresize.8_pregen b/man/lvresize.8_pregen index f3535ce7f..4e27cf4ee 100644 --- a/man/lvresize.8_pregen +++ b/man/lvresize.8_pregen @@ -1,8 +1,11 @@ .TH LVRESIZE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvresize - Resize a logical volume +. +lvresize \(em Resize a logical volume . .SH SYNOPSIS +. \fBlvresize\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -11,138 +14,84 @@ lvresize - Resize a logical volume .br .P .ad l - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.ad b .br -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-l\fP|\fB--extents\fP [\fB+\fP|\fB-\fP]\fINumber\fP[PERCENT] -.ad b .br -.ad l \fB-f\fP|\fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB-n\fP|\fB--nofsck\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--nosync\fP -.ad b .br -.ad l \fB--noudevsync\fP -.ad b .br -.ad l \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP -.ad b .br -.ad l \fB-r\fP|\fB--resizefs\fP -.ad b .br -.ad l \fB-L\fP|\fB--size\fP [\fB+\fP|\fB-\fP]\fISize\fP[m|UNIT] -.ad b .br -.ad l \fB-i\fP|\fB--stripes\fP \fINumber\fP -.ad b .br -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l - \fB--type\fP + \fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. lvresize resizes an LV in the same way as lvextend and lvreduce. See \fBlvextend\fP(8) and \fBlvreduce\fP(8) for more information. - +.P In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See both descriptions the options section. +. .SH USAGE +. Resize an LV by a specified size. .br .P @@ -151,24 +100,20 @@ Resize an LV by a specified size. .RS 4 .ad l [ \fB-l\fP|\fB--extents\fP [\fB+\fP|\fB-\fP]\fINumber\fP[PERCENT] ] -.ad b .br -.ad l [ \fB-r\fP|\fB--resizefs\fP ] -.ad b .br -.ad l [ \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +\(em +.P Resize an LV by specified PV extents. .br .P @@ -177,155 +122,116 @@ Resize an LV by specified PV extents. .RS 4 .ad l [ \fB-r\fP|\fB--resizefs\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Resize a pool metadata SubLV by a specified size. .br .P -\fBlvresize\fP \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] \fILV\fP\fI_thinpool\fP +\fBlvresize\fP \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] \fILV1\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE -- - +.P +.RS 4 +LV1 types: thinpool +.RE +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--nofsck\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--stripes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l [ \fB--nosync\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l -[ \fB--type\fP +[ \fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -342,66 +248,58 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-l\fP|\fB--extents\fP [\fB+\fP|\fB-\fP]\fINumber\fP[PERCENT] .br -.ad b Specifies the new size of the LV in logical extents. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -420,51 +318,44 @@ extents in the new LV is not determined until the command has completed. When the plus \fB+\fP or minus \fB-\fP prefix is used, the value is not an absolute size, but is relative and added or subtracted from the current size. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-n\fP|\fB--nofsck\fP .br -.ad b Do not perform fsck before resizing filesystem when filesystem requires it. You may need to use --force to proceed with this option. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosync\fP .br -.ad b Causes the creation of mirror, raid1, raid4, raid5 and raid10 to skip the initial synchronization. In case of mirror, raid1 and raid10, any data written afterwards will be mirrored, but the original contents will not be @@ -477,59 +368,52 @@ This option is not valid for raid6, because raid6 relies on proper parity to reconstruct proper user date in case of device failures. raid0 and raid0_meta do not provide any data copies or parity support and thus do not support initial synchronization. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--poolmetadatasize\fP [\fB+\fP]\fISize\fP[m|UNIT] .br -.ad b Specifies the new size of the pool metadata LV. The plus prefix \fB+\fP can be used, in which case the value is added to the current size. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-r\fP|\fB--resizefs\fP .br -.ad b Resize underlying filesystem together with the LV using fsadm(8). +. .HP -.ad l \fB-L\fP|\fB--size\fP [\fB+\fP|\fB-\fP]\fISize\fP[m|UNIT] .br -.ad b Specifies the new size of the LV. The --size and --extents options are alternate methods of specifying size. The total number of physical extents used will be @@ -537,11 +421,10 @@ greater when redundant data is needed for RAID levels. When the plus \fB+\fP or minus \fB-\fP prefix is used, the value is not an absolute size, but is relative and added or subtracted from the current size. +. .HP -.ad l \fB-i\fP|\fB--stripes\fP \fINumber\fP .br -.ad b Specifies the number of stripes in a striped LV. This is the number of PVs (devices) that a striped LV is spread across. Data that appears sequential in the LV is spread across multiple devices in units of @@ -553,32 +436,31 @@ the RAID type (raid0: 64, raid10: 32, raid4/5: 63, raid6: 62), and when unspecified, the default depends on the RAID type (raid0: 2, raid10: 2, raid4/5: 3, raid6: 5.) To stripe a new raid LV across all PVs by default, -see lvm.conf allocation/raid_stripe_all_devices. +see \fBlvm.conf\fP(5) \fBallocation/raid_stripe_all_devices\fP. +. .HP -.ad l \fB-I\fP|\fB--stripesize\fP \fISize\fP[k|UNIT] .br -.ad b The amount of data that is written to one device before moving to the next in a striped LV. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP .ad l -\fB--type\fP +\fB--type\fP \c .nh -\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP +\%\fBlinear\fP|\:\fBstriped\fP|\:\fBsnapshot\fP|\:\fBraid\fP|\:\fBmirror\fP|\:\fBthin\fP|\:\fBthin-pool\fP|\:\fBvdo\fP|\:\fBvdo-pool\fP|\:\fBcache\fP|\:\fBcache-pool\fP|\:\fBwritecache\fP .hy -.br .ad b +.br The LV type, also known as "segment type" or "segtype". See usage descriptions for the specific ways to use these types. For more information about redundancy and performance (\fBraid\fP<N>, \fBmirror\fP, \fBstriped\fP, \fBlinear\fP) see \fBlvmraid\fP(7). @@ -590,38 +472,35 @@ Several commands omit an explicit type option because the type is inferred from other options or shortcuts (e.g. --stripes, --mirrors, --snapshot, --virtualsize, --thin, --cache, --vdo). Use inferred types with care because it can lead to unexpected results. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fILV\fP -.br +. +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -LV followed by _<type> indicates that an LV of the -given type is required. (raid represents raid<N> type) -.HP -\fIPV\fP -.br +LV1 indicates the LV must have a specific type, where the +accepted LV types are listed. (raid represents raid<N> type). +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -629,96 +508,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Extend an LV by 16MB using specific physical extents: -.br -.B lvresize -L+16M vg1/lv1 /dev/sda:0-1 /dev/sdb:0-1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvs.8_pregen b/man/lvs.8_pregen index 76ea404c7..d822347a1 100644 --- a/man/lvs.8_pregen +++ b/man/lvs.8_pregen @@ -1,345 +1,261 @@ .TH LVS 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvs - Display information about logical volumes +. +lvs \(em Display information about logical volumes . .SH SYNOPSIS +. \fBlvs\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. lvs produces formatted output about LVs. +. .SH USAGE +. \fBlvs\fP .br .RS 4 .ad l [ \fB-H\fP|\fB--history\fP ] -.ad b .br -.ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--segments\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--nameprefixes\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--rows\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br -.ad l [ \fB--unquoted\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fILV\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Show information about internal LVs. These are components of normal LVs, such as mirrors, which are not independently accessible, e.g. not mountable. +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-H\fP|\fB--history\fP .br -.ad b Include historical LVs in the output. (This has no effect unless LVs were removed while -lvm.conf metadata/record_lvs_history was enabled. +\fBlvm.conf\fP(5) \fBmetadata/record_lvs_history\fP was enabled. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nameprefixes\fP .br -.ad b Add an "LVM2_" prefix plus the field name to the output. Useful with --noheadings to produce a list of field=value pairs that can be used to set environment variables (for example, in udev rules). +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -353,61 +269,54 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--rows\fP .br -.ad b Output columns as rows. +. .HP -.ad l \fB--segments\fP .br -.ad b Use default columns that emphasize segment information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -416,264 +325,121 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB--unquoted\fP .br -.ad b When used with --nameprefixes, output values in the field=value pairs are not quoted. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES -. -The lv_attr bits are: -.IP 1 3 -Volume type: (C)ache, (m)irrored, (M)irrored without initial sync, (o)rigin, -(O)rigin with merging snapshot, (r)aid, (R)aid without initial sync, -(s)napshot, merging (S)napshot, (p)vmove, (v)irtual, -mirror or raid (i)mage, mirror or raid (I)mage out-of-sync, mirror (l)og device, -under (c)onversion, thin (V)olume, (t)hin pool, (T)hin pool data, -v(d)o pool, v(D)o pool data, -raid or pool m(e)tadata or pool metadata spare. -.IP 2 3 -Permissions: (w)riteable, (r)ead-only, (R)ead-only activation of non-read-only -volume -.IP 3 3 -Allocation policy: (a)nywhere, (c)ontiguous, (i)nherited, c(l)ing, (n)ormal -This is capitalised if the volume is currently locked against allocation -changes, for example during -.BR pvmove (8). -.IP 4 3 -fixed (m)inor -.IP 5 3 -State: (a)ctive, (h)istorical, (s)uspended, (I)nvalid snapshot, -invalid (S)uspended snapshot, snapshot (m)erge failed, -suspended snapshot (M)erge failed, mapped (d)evice present without tables, -mapped device present with (i)nactive table, thin-pool (c)heck needed, -suspended thin-pool (C)heck needed, (X) unknown -.IP 6 3 -device (o)pen, (X) unknown -.IP 7 3 -Target type: (C)ache, (m)irror, (r)aid, (s)napshot, (t)hin, (u)nknown, (v)irtual. -This groups logical volumes related to the same kernel target together. So, -for example, mirror images, mirror logs as well as mirrors themselves appear as -(m) if they use the original device-mapper mirror kernel driver; whereas the raid -equivalents using the md raid kernel driver all appear as (r). -Snapshots using the original device-mapper driver appear as (s); whereas -snapshots of thin volumes using the new thin provisioning driver appear as (t). -.IP 8 3 -Newly-allocated data blocks are overwritten with blocks of (z)eroes before use. -.IP 9 3 -Volume Health, where there are currently three groups of attributes identified: -.IP -Common ones for all Logical Volumes: (p)artial, (X) unknown. -.br -(p)artial signifies that one or more of the Physical Volumes this Logical -Volume uses is missing from the system. (X) unknown signifies the status -is unknown. -.IP -Related to RAID Logical Volumes: (r)efresh needed, (m)ismatches exist, (w)ritemostly. -.br -(r)efresh signifies that one or more of the Physical Volumes this RAID Logical -Volume uses had suffered a write error. The write error could be due to a -temporary failure of that Physical Volume or an indication that it is failing. -The device should be refreshed or replaced. (m)ismatches signifies that the -RAID logical volume has portions of the array that are not coherent. -Inconsistencies are detected by initiating a "check" on a RAID logical volume. -(The scrubbing operations, "check" and "repair", can be performed on a RAID -logical volume via the 'lvchange' command.) (w)ritemostly signifies the -devices in a RAID 1 logical volume that have been marked write-mostly. -Re(s)haping signifies a RAID Logical Volume is either undergoing a stripe -addition/removal, a stripe size or RAID algorithm change. -(R)emove after reshape signifies freed striped raid images to be removed. -.IP -Related to Thin pool Logical Volumes: (F)ailed, out of (D)ata space, -(M)etadata read only. -.br -(F)ailed is set if thin pool encounters serious failures and hence no further I/O -is permitted at all. The out of (D)ata space is set if thin pool has run out of -data space. (M)etadata read only signifies that thin pool encounters certain -types of failures but it's still possible to do reads at least, -but no metadata changes are allowed. -.IP -Related to Thin Logical Volumes: (F)ailed. -.br -(F)ailed is set when related thin pool enters Failed state and no further I/O -is permitted at all. -.IP -Related to writecache logical volumes: (E)rror. -.br -(E)rror is set dm-writecache reports an error. -.IP 10 3 -s(k)ip activation: this volume is flagged to be skipped during activation. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/lvscan.8_pregen b/man/lvscan.8_pregen index 264d9607e..40438a7d2 100644 --- a/man/lvscan.8_pregen +++ b/man/lvscan.8_pregen @@ -1,361 +1,257 @@ .TH LVSCAN 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -lvscan - List all logical volumes in all volume groups +. +lvscan \(em List all logical volumes in all volume groups . .SH SYNOPSIS +. \fBlvscan\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. lvscan scans all VGs or all supported LVM block devices in the system for LVs. The output consists of one line for each LV indicating whether or not it is active, a snapshot or origin, the size of the device and its allocation policy. Use \fBlvs\fP(8) or \fBlvdisplay\fP(8) to obtain more comprehensive information about LVs. +. .SH USAGE +. \fBlvscan\fP .br .RS 4 .ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-b\fP|\fB--blockdevice\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Show information about internal LVs. These are components of normal LVs, such as mirrors, which are not independently accessible, e.g. not mountable. +. .HP -.ad l \fB-b\fP|\fB--blockdevice\fP .br -.ad b No longer used. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIString\fP -.br +. +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvchange.8_pregen b/man/pvchange.8_pregen index 33778ee6c..577352d2a 100644 --- a/man/pvchange.8_pregen +++ b/man/pvchange.8_pregen @@ -1,18 +1,25 @@ .TH PVCHANGE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvchange - Change attributes of physical volume(s) +. +pvchange \(em Change attributes of physical volume(s) . .SH SYNOPSIS +. \fBpvchange\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. pvchange changes PV attributes in the VG. - +.P For options listed in parentheses, any one is required, after which the others are optional. +. .SH USAGE +. Change properties of all PVs. .br .P @@ -30,10 +37,11 @@ Change properties of all PVs. .RE .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Change properties of specified PVs. .br .P @@ -56,252 +64,196 @@ Change properties of specified PVs. .RS 4 .ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-u\fP|\fB--uuid\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--addtag\fP \fITag\fP .br -.ad b Adds a tag to a PV, VG or LV. This option can be repeated to add multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Change all visible PVs. +. .HP -.ad l \fB-x\fP|\fB--allocatable\fP \fBy\fP|\fBn\fP .br -.ad b Enable or disable allocation of physical extents on this PV. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--deltag\fP \fITag\fP .br -.ad b Deletes a tag from a PV, VG or LV. This option can be repeated to delete multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--metadataignore\fP \fBy\fP|\fBn\fP .br -.ad b Specifies the metadataignore property of a PV. If yes, metadata areas on the PV are ignored, and lvm will not store metadata in the metadata areas of the PV. If no, lvm will store metadata on the PV. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -310,47 +262,43 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-u\fP|\fB--uuid\fP .br -.ad b Generate new random UUID for specified PVs. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -358,103 +306,41 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Disallow the allocation of physical extents on a PV (e.g. because of -disk errors, or because it will be removed after freeing it). -.br -.B pvchange -x n /dev/sdk1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvck.8_pregen b/man/pvck.8_pregen index 22e6f6eff..6e55916a3 100644 --- a/man/pvck.8_pregen +++ b/man/pvck.8_pregen @@ -1,8 +1,11 @@ .TH PVCK 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvck - Check metadata on physical volumes +. +pvck \(em Check metadata on physical volumes . .SH SYNOPSIS +. \fBpvck\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -10,103 +13,61 @@ pvck - Check metadata on physical volumes .P .ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l - \fB--dump\fP + \fB--dump\fP \c .nh -\fBheaders\fP|\:\fBmetadata\fP|\:\fBmetadata_all\fP|\:\fBmetadata_search\fP +\%\fBheaders\fP|\:\fBmetadata\fP|\:\fBmetadata_all\fP|\:\fBmetadata_search\fP .hy -.ad b .br -.ad l \fB-f\fP|\fB--file\fP \fIString\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB--labelsector\fP \fINumber\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l - \fB--[pv]metadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP -.ad b + \fB--\fP[\fBpv\fP]\fBmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--repair\fP -.ad b .br -.ad l \fB--repairtype\fP \fBpv_header\fP|\fBmetadata\fP|\fBlabel_header\fP -.ad b .br -.ad l \fB--settings\fP \fIString\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. pvck checks and repairs LVM metadata on PVs. - +.P .SS Dump options - +.P .B headers .br Print LVM on-disk headers and structures: label_header, pv_header, @@ -117,7 +78,7 @@ a 512 byte sector at offset 4096 bytes. A second mda_header can optionally exist near the end of the device. The metadata text exists in an area (about 1MiB by default) immediately following the mda_header sector. The metadata text is checked but not printed (see other options). - +.P .B metadata .br Print the current LVM VG metadata text (or save to a file), using headers @@ -125,7 +86,7 @@ to locate the latest copy of metadata. If headers are damaged, metadata may not be found (see metadata_search). Use --settings "mda_num=2" to look in mda2 (the second mda at the end of the device, if used). The metadata text is printed to stdout or saved to a file with --file. - +.P .B metadata_all .br List all versions of VG metadata found in the metadata area, using headers @@ -133,7 +94,7 @@ to locate metadata. Full copies of all metadata are saved to a file with the --file option. If headers are damaged, metadata may not be found (see metadata_search). Use --settings "mda_num=2" as above. Use -v to include descriptions and dates when listing metadata versions. - +.P .B metadata_search .br List all versions of VG metadata found in the metadata area, searching @@ -143,20 +104,20 @@ save one specific version of metadata, use --settings "metadata_offset=<offset>", where the offset is taken from the list of versions found. Use -v to include descriptions and dates when listing metadata versions. - +.P .B metadata_area .br Save the entire text metadata area to a file without processing. - +.P .SS Repair options - +.P .B --repair .br Repair headers and metadata on a PV. This uses a metadata input file that -was extracted by --dump, or a backup file (from /etc/lvm/backup). When +was extracted by --dump, or a backup file (from \fI#DEFAULT_BACKUP_DIR#\fP). When possible, use metadata saved by --dump from another PV in the same VG (or from a second metadata area on the PV). - +.P There are cases where the PV UUID needs to be specified for the PV being repaired. It is specified using --settings "pv_uuid=<UUID>". In particular, if the device name for the PV being repaired does not match @@ -165,52 +126,52 @@ the correct PV UUID. When headers are damaged on more than one PV in a VG, it is important for the user to determine the correct PV UUID and specify it in --settings. Otherwise, the wrong PV UUID could be used if device names have been swapped since the metadata was last written. - +.P If a PV has no metadata areas and the pv_header is damaged, then the repair will not know to create no metadata areas during repair. It will by default repair metadata in mda1. To repair with no metadata areas, use --settings "mda_offset=0 mda_size=0". - +.P There are cases where repair should be run on all PVs in the VG (using the same metadata file): if all PVs in the VG are damaged, if using an old metadata version, or if a backup file is used instead of raw metadata (taken from pvck dump.) - +.P Using --repair is equivalent to running --repairtype pv_header followed by --repairtype metadata. - +.P .B --repairtype pv_header .br Repairs the header sector, containing the pv_header and label_header. - +.P .B --repairtype metadata .br Repairs the mda_header and metadata text. It requires the headers to be correct (having been undamaged or already repaired). - +.P .B --repairtype label_header .br Repairs label_header fields, leaving the pv_header (in the same sector) unchanged. (repairtype pv_header should usually be used instead.) - +.P .SS Settings - +.P The --settings option controls or overrides certain dump or repair behaviors. All offset and size values in settings are in bytes (units are not recognized.) These settings are subject to change. - +.P .B mda_num=1|2 .br Select which metadata area should be used. By default the first metadata area (1) is used. mda1 is always located at offset 4096. mda2, at the end of the device, often does not exist (it's not created by default.) If mda1 is erased, mda2, if it exists, will often still have metadata. - +.P \fBmetadata_offset=\fP\fIbytes\fP .br Select metadata text at this offset. Use with metadata_search to print/save one instance of metadata text. - +.P \fBmda_offset=\fP\fIbytes\fP \fBmda_size=\fP\fIbytes\fP .br Refers to a metadata area (mda) location and size. An mda includes an @@ -218,18 +179,18 @@ mda_header and circular metadata text buffer. Setting this forces metadata_search look for metadata in the given area instead of the standard locations. When set to zero with repair, it indicates no metadata areas should exist. - +.P \fBmda2_offset=\fP\fIbytes\fP \fBmda2_size=\fP\fIbytes\fP .br When repairing a pv_header, this forces a specific offset and size for mda2 that should be recorded in the pv_header. - +.P \fBpv_uuid=\fP\fIuuid\fP .br Specify the PV UUID of the device being repaired. When not specified, repair will attempt to determine the correct PV UUID by matching a device name in the metadata. - +.P \fBdevice_size=\fP\fIbytes\fP .br \fBdata_offset=\fP\fIbytes\fP @@ -239,46 +200,45 @@ be specified directly, in which case these values are not taken from a metadata file (where they usually come from), and the metadata file can be omitted. data_offset is the starting location of the first physical extent (data), which follows the first metadata area. - +. .SH USAGE +. Check for metadata on a device .br .P \fBpvck\fP \fIPV\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Check and print LVM headers and metadata on a device .br .P -\fBpvck\fP \fB--dump\fP +\fBpvck\fP \fB--dump\fP \c .nh -\fBheaders\fP|\:\fBmetadata\fP|\:\fBmetadata_all\fP|\:\fBmetadata_search\fP +\%\fBheaders\fP|\:\fBmetadata\fP|\:\fBmetadata_all\fP|\:\fBmetadata_search\fP .hy \fIPV\fP .br .RS 4 .ad l [ \fB-f\fP|\fB--file\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--settings\fP \fIString\fP ] -.ad b .br -.ad l -[ \fB--[pv]metadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] -.ad b +[ \fB--\fP[\fBpv\fP]\fBmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Repair LVM headers or metadata on a device .br .P @@ -287,17 +247,15 @@ Repair LVM headers or metadata on a device .RS 4 .ad l [ \fB-f\fP|\fB--file\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--settings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Repair LVM headers and metadata on a device .br .P @@ -306,13 +264,13 @@ Repair LVM headers and metadata on a device .RS 4 .ad l [ \fB--settings\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Common options for command: . .RS 4 @@ -320,131 +278,98 @@ Common options for command: [ \fB--labelsector\fP \fINumber\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP .ad l -\fB--dump\fP +\fB--dump\fP \c .nh -\fBheaders\fP|\:\fBmetadata\fP|\:\fBmetadata_all\fP|\:\fBmetadata_search\fP +\%\fBheaders\fP|\:\fBmetadata\fP|\:\fBmetadata_all\fP|\:\fBmetadata_search\fP .hy -.br .ad b +.br Dump headers and metadata from a PV for debugging and repair. Option values include: \fBheaders\fP to print and check LVM headers, \fBmetadata\fP to print or save the current text metadata, @@ -452,58 +377,50 @@ Option values include: \fBheaders\fP to print and check LVM headers, \fBmetadata_search\fP to list or save all versions of metadata, searching standard locations in case of damaged headers, \fBmetadata_area\fP to save an entire text metadata area to a file. +. .HP -.ad l \fB-f\fP|\fB--file\fP \fIString\fP .br -.ad b Metadata file to read or write. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--labelsector\fP \fINumber\fP .br -.ad b By default the PV is labelled with an LVM2 identifier in its second sector (sector 1). This lets you use a different sector near the start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS in the source). Use with care. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l -\fB--[pv]metadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP +\fB--\fP[\fBpv\fP]\fBmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad b The number of metadata areas to set aside on a PV for storing VG metadata. When 2, one copy of the VG metadata is stored at the front of the PV and a second copy is stored at the end. @@ -511,68 +428,61 @@ When 1, one copy of the VG metadata is stored at the front of the PV. When 0, no copies of the VG metadata are stored on the given PV. This may be useful in VGs containing many PVs (this places limitations on the ability to use vgsplit later.) +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--repair\fP .br -.ad b Repair headers and metadata on a PV. +. .HP -.ad l \fB--repairtype\fP \fBpv_header\fP|\fBmetadata\fP|\fBlabel_header\fP .br -.ad b Repair headers and metadata on a PV. See command description. +. .HP -.ad l \fB--settings\fP \fIString\fP .br -.ad b Specifies command specific settings in "Key = Value" form. Combine multiple settings in quotes, or repeat the settings option for each. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -580,99 +490,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -If the partition table is corrupted or lost on /dev/sda, and you suspect -there was an LVM partition at approximately 100 MiB, then this -area of the disk can be scanned using the \fB--labelsector\fP -parameter with a value of 204800 (100 * 1024 * 1024 / 512 = 204800). -.br -.B pvck --labelsector 204800 /dev/sda -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvcreate.8_pregen b/man/pvcreate.8_pregen index f56022b2e..26e5141fe 100644 --- a/man/pvcreate.8_pregen +++ b/man/pvcreate.8_pregen @@ -1,36 +1,41 @@ .TH PVCREATE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvcreate - Initialize physical volume(s) for use by LVM +. +pvcreate \(em Initialize physical volume(s) for use by LVM . .SH SYNOPSIS +. \fBpvcreate\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. pvcreate initializes a Physical Volume (PV) on a device so the device is recognized as belonging to LVM. This allows the PV to be used in a Volume Group (VG). An LVM disk label is written to the device, and LVM metadata areas are initialized. A PV can be placed on a whole device or partition. - +.P Use \fBvgcreate\fP(8) to create a new VG on the PV, or \fBvgextend\fP(8) to add the PV to an existing VG. Use \fBpvremove\fP(8) to remove the LVM disk label from the device. - +.P The force option will create a PV without confirmation. Repeating the force option (\fB-ff\fP) will forcibly create a PV, overriding checks that normally prevent it, e.g. if the PV is already in a VG. - +.P .B Metadata location, size, and alignment - +.P The LVM disk label begins 512 bytes from the start of the device, and is 512 bytes in size. - +.P The LVM metadata area begins at an offset (from the start of the device) equal to the page size of the machine creating the PV (often 4 KiB.) The metadata area contains a 512 byte header and a multi-KiB circular buffer that holds text copies of the VG metadata. - +.P With default settings, the first physical extent (PE), which contains LV data, is 1 MiB from the start of the device. This location is controlled by \fBdefault_data_alignment\fP in lvm.conf, which is set to 1 (MiB) by @@ -39,7 +44,7 @@ can be checked with: .br .B pvs -o pe_start .I PV - +.P The size of the LVM metadata area is the space between the the start of the metadata area and the first PE. When metadata begins at 4 KiB and the first PE is at 1024 KiB, the metadata area size is 1020 KiB. This can be @@ -47,7 +52,7 @@ checked with: .br .B pvs -o mda_size .I PV - +.P The mda_size cannot be increased after pvcreate, so if larger metadata is needed, it must be set during pvcreate. Two copies of the VG metadata must always fit within the metadata area, so the maximum VG metadata size @@ -55,7 +60,7 @@ is around half the mda_size. This can be checked with: .br .B vgs -o mda_free .I VG - +.P A larger metadata area can be set with --metadatasize. The resulting mda_size may be larger than specified due to default_data_alignment placing pe_start on a MiB boundary, and the fact that the metadata area @@ -63,12 +68,12 @@ extends to the first PE. With metadata starting at 4 KiB and default_data_alignment 1 (MiB), setting --metadatasize 2048k results in pe_start of 3 MiB and mda_size of 3068 KiB. Alternatively, --metadatasize 2044k results in pe_start at 2 MiB and mda_size of 2044 KiB. - +.P The alignment of pe_start described above may be automatically overridden based on md device properties or device i/o properties reported in sysfs. These automatic adjustments can be enabled/disabled using lvm.conf settings md_chunk_alignment and data_alignment_offset_detection. - +.P To use a different pe_start alignment, use the --dataalignment option. The --metadatasize option would also typically be used in this case because the metadata area size also determines the location of pe_start. @@ -81,152 +86,96 @@ The pe_start of 2176 KiB is the nearest even multiple of 128 KiB that provides at least 2048 KiB of metadata space. Always check the resulting alignment and metadata size when using these options. - +.P To shift an aligned pe_start value, use the --dataalignmentoffset option. The pe_start alignment is calculated as described above, and then the value specified with --dataalignmentoffset is added to produce the final pe_start value. +. .SH USAGE +. \fBpvcreate\fP \fIPV\fP ... .br .RS 4 .ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP ] -.ad b .br -.ad l [ \fB-u\fP|\fB--uuid\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--dataalignment\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--bootloaderareasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--labelsector\fP \fINumber\fP ] -.ad b .br -.ad l -[ \fB--[pv]metadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] -.ad b +[ \fB--\fP[\fBpv\fP]\fBmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] .br -.ad l [ \fB--metadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--metadataignore\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--norestorefile\fP ] -.ad b .br -.ad l [ \fB--setphysicalvolumesize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--restorefile\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--bootloaderareasize\fP \fISize\fP[m|UNIT] .br -.ad b Reserve space for the bootloader between the LVM metadata area and the first PE. The bootloader area is reserved for bootloaders to embed their own data or metadata; LVM will not use it. @@ -238,154 +187,134 @@ and --dataalignmentoffset. The bootloader area may be larger than requested due to the alignment, but it's never less than the requested size. To see the bootloader area start and size of an existing PV use pvs -o +pv_ba_start,pv_ba_size. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--dataalignment\fP \fISize\fP[k|UNIT] .br -.ad b Align the start of a PV data area with a multiple of this number. To see the location of the first Physical Extent (PE) of an existing PV, use pvs -o +pe_start. In addition, it may be shifted by an alignment offset, see --dataalignmentoffset. Also specify an appropriate PE size when creating a VG. +. .HP -.ad l \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] .br -.ad b Shift the start of the PV data area by this additional offset. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--labelsector\fP \fINumber\fP .br -.ad b By default the PV is labelled with an LVM2 identifier in its second sector (sector 1). This lets you use a different sector near the start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS in the source). Use with care. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--metadataignore\fP \fBy\fP|\fBn\fP .br -.ad b Specifies the metadataignore property of a PV. If yes, metadata areas on the PV are ignored, and lvm will not store metadata in the metadata areas of the PV. If no, lvm will store metadata on the PV. +. .HP -.ad l \fB--metadatasize\fP \fISize\fP[m|UNIT] .br -.ad b The approximate amount of space used for each VG metadata area. The size may be rounded. +. .HP -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP .br -.ad b Specifies the type of on-disk metadata to use. \fBlvm2\fP (or just \fB2\fP) is the current, standard format. \fBlvm1\fP (or just \fB1\fP) is no longer used. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--norestorefile\fP .br -.ad b In conjunction with --uuid, this allows a uuid to be specified without also requiring that a backup of the metadata be provided. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l -\fB--[pv]metadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP +\fB--\fP[\fBpv\fP]\fBmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad b The number of metadata areas to set aside on a PV for storing VG metadata. When 2, one copy of the VG metadata is stored at the front of the PV and a second copy is stored at the end. @@ -393,29 +322,26 @@ When 1, one copy of the VG metadata is stored at the front of the PV. When 0, no copies of the VG metadata are stored on the given PV. This may be useful in VGs containing many PVs (this places limitations on the ability to use vgsplit later.) +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--restorefile\fP \fIString\fP .br -.ad b In conjunction with --uuid, this reads the file (produced by vgcfgbackup), extracts the location and size of the data on the PV, and ensures that the metadata produced by the program is consistent @@ -423,28 +349,25 @@ with the contents of the file, i.e. the physical extents will be in the same place and not be overwritten by new metadata. This provides a mechanism to upgrade the metadata format or to add/remove metadata areas. Use with care. +. .HP -.ad l \fB--setphysicalvolumesize\fP \fISize\fP[m|UNIT] .br -.ad b Overrides the automatically detected size of the PV. Use with care, or prior to reducing the physical size of the device. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-u\fP|\fB--uuid\fP \fIString\fP .br -.ad b Specify a UUID for the device. Without this option, a random UUID is generated. This option is needed before restoring a backup of LVM metadata @@ -453,39 +376,36 @@ onto a replacement device; see \fBvgcfgrestore\fP(8). As such, use of All PVs must have unique UUIDs, and LVM will prevent certain operations if multiple devices are seen with the same UUID. See \fBvgimportclone\fP(8) for more information. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .HP -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .br -.ad b Controls if the first 4 sectors (2048 bytes) of the device are wiped. The default is to wipe these sectors unless either or both of --restorefile or --uuid are specified. +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -493,103 +413,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Initialize a partition and a full device. -.br -.B pvcreate /dev/sdc4 /dev/sde - -If a device is a 4KiB sector drive that compensates for windows -partitioning (sector 7 is the lowest aligned logical block, the 4KiB -sectors start at LBA -1, and consequently sector 63 is aligned on a 4KiB -boundary) manually account for this when initializing for use by LVM. -.br -.B pvcreate --dataalignmentoffset 7s /dev/sdb -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvdisplay.8_pregen b/man/pvdisplay.8_pregen index 9a7e4ed56..ff5d9f50a 100644 --- a/man/pvdisplay.8_pregen +++ b/man/pvdisplay.8_pregen @@ -1,348 +1,265 @@ .TH PVDISPLAY 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvdisplay - Display various attributes of physical volume(s) +. +pvdisplay \(em Display various attributes of physical volume(s) . .SH SYNOPSIS +. \fBpvdisplay\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. pvdisplay shows the attributes of PVs, like size, physical extent size, space used for the VG descriptor area, etc. - +.P \fBpvs\fP(8) is a preferred alternative that shows the same information and more, using a more compact and configurable output format. +. .SH USAGE +. \fBpvdisplay\fP .br .RS 4 .ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--colon\fP ] -.ad b .br -.ad l [ \fB-C\fP|\fB--columns\fP ] -.ad b .br -.ad l [ \fB-m\fP|\fB--maps\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-s\fP|\fB--short\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Show information about devices that have not been initialized by LVM, i.e. they are not PVs. +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB-c\fP|\fB--colon\fP .br -.ad b Generate colon separated output for easier parsing in scripts or programs. Also see \fBvgs\fP(8) which provides considerably more control over the output. +. .HP -.ad l \fB-C\fP|\fB--columns\fP .br -.ad b Display output in columns, the equivalent of \fBvgs\fP(8). Options listed are the same as options given in \fBvgs\fP(8). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-m\fP|\fB--maps\fP .br -.ad b Display the mapping of physical extents to LVs and logical extents. +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -356,49 +273,44 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -407,85 +319,81 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-s\fP|\fB--short\fP .br -.ad b Only display the size of the given PVs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -493,96 +401,40 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvmove.8_pregen b/man/pvmove.8_pregen index 791e2834f..a764ed9ca 100644 --- a/man/pvmove.8_pregen +++ b/man/pvmove.8_pregen @@ -1,31 +1,38 @@ .TH PVMOVE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvmove - Move extents from one physical volume to another +. +pvmove \(em Move extents from one physical volume to another . .SH SYNOPSIS +. \fBpvmove\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. pvmove moves the allocated physical extents (PEs) on a source PV to one or more destination PVs. You can optionally specify a source LV in which case only extents used by that LV will be moved to free (or specified) extents on the destination PV. If no destination PV is specified, the normal allocation rules for the VG are used. - +.P If pvmove is interrupted for any reason (e.g. the machine crashes) then run pvmove again without any PV arguments to restart any operations that were in progress from the last checkpoint. Alternatively, use the abort option at any time to abort the operation. The resulting location of LVs after an abort depends on whether the atomic option was used. - +.P More than one pvmove can run concurrently if they are moving data from different source PVs, but additional pvmoves will ignore any LVs already in the process of being changed, so some data might not get moved. +. .SH USAGE +. Move PV extents. .br .P @@ -34,150 +41,108 @@ Move PV extents. .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--name\fP \fILV\fP ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l [ \fB--atomic\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP ... ] .RE - +.P Continue or abort existing pvmove operations. .br .P \fBpvmove\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB-b\fP|\fB--background\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--interval\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--abort\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--abort\fP .br -.ad b Abort any pvmove operations in progress. If a pvmove was started with the --atomic option, then all LVs will remain on the source PV. Otherwise, segments that have been moved will remain on the destination PV, while unmoved segments will remain on the source PV. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -194,182 +159,160 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB--atomic\fP .br -.ad b Makes a pvmove operation atomic, ensuring that all affected LVs are moved to the destination PV, or none are if the operation is aborted. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB-b\fP|\fB--background\fP .br -.ad b If the operation requires polling, this option causes the command to return before the operation is complete, and polling is done in the background. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-i\fP|\fB--interval\fP \fINumber\fP .br -.ad b Report progress at regular intervals. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-n\fP|\fB--name\fP \fIString\fP .br -.ad b Move only the extents belonging to the named LV. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -377,182 +320,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES -pvmove works as follows: - -1. A temporary 'pvmove' LV is created to store details of all the data -movements required. - -2. Every LV in the VG is searched for contiguous data that need moving -according to the command line arguments. -For each piece of data found, a new segment is added to the end of the -pvmove LV. -This segment takes the form of a temporary mirror to copy the data -from the original location to a newly allocated location. -The original LV is updated to use the new temporary mirror segment -in the pvmove LV instead of accessing the data directly. - -3. The VG metadata is updated on disk. - -4. The first segment of the pvmove LV is activated and starts to mirror -the first part of the data. Only one segment is mirrored at once as this -is usually more efficient. - -5. A daemon repeatedly checks progress at the specified time interval. -When it detects that the first temporary mirror is in sync, it breaks that -mirror so that only the new location for that data gets used and writes a -checkpoint into the VG metadata on disk. Then it activates the mirror for -the next segment of the pvmove LV. - -6. When there are no more segments left to be mirrored, the temporary LV -is removed and the VG metadata is updated so that the LVs reflect the new -data locations. - -Note that this new process cannot support the original LVM1 -type of on-disk metadata. Metadata can be converted using -\fBvgconvert\fP(8). - -If the \fB--atomic\fP option is used, a slightly different approach is -used for the move. Again, a temporary 'pvmove' LV is created to store the -details of all the data movements required. This temporary LV contains -all the segments of the various LVs that need to be moved. However, in -this case, an identical LV is allocated that contains the same number of -segments and a mirror is created to copy the contents from the first -temporary LV to the second. After a complete copy is made, the temporary -LVs are removed, leaving behind the segments on the destination PV. If an -abort is issued during the move, all LVs being moved will remain on the -source PV. - -.SH EXAMPLES - -Move all physical extents that are used by simple LVs on the specified PV to -free physical extents elsewhere in the VG. -.br -.B pvmove /dev/sdb1 - -Use a specific destination PV when moving physical extents. -.br -.B pvmove /dev/sdb1 /dev/sdc1 - -Move extents belonging to a single LV. -.br -.B pvmove -n lvol1 /dev/sdb1 /dev/sdc1 - -Rather than moving the contents of an entire device, it is possible to -move a range of physical extents, for example numbers 1000 to 1999 -inclusive on the specified PV. -.br -.B pvmove /dev/sdb1:1000-1999 - -A range of physical extents to move can be specified as start+length. For -example, starting from PE 1000. (Counting starts from 0, so this refers to the -1001st to the 2000th PE inclusive.) -.br -.B pvmove /dev/sdb1:1000+1000 - -Move a range of physical extents to a specific PV (which must have -sufficient free extents). -.br -.B pvmove /dev/sdb1:1000-1999 /dev/sdc1 - -Move a range of physical extents to specific new extents on a new PV. -.br -.B pvmove /dev/sdb1:1000-1999 /dev/sdc1:0-999 - -If the source and destination are on the same disk, the -\fBanywhere\fP allocation policy is needed. -.br -.B pvmove --alloc anywhere /dev/sdb1:1000-1999 /dev/sdb1:0-999 - -The part of a specific LV present within in a range of physical -extents can also be picked out and moved. -.br -.B pvmove -n lvol1 /dev/sdb1:1000-1999 /dev/sdc1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvremove.8_pregen b/man/pvremove.8_pregen index 3015b70d1..b34f2a042 100644 --- a/man/pvremove.8_pregen +++ b/man/pvremove.8_pregen @@ -1,244 +1,203 @@ .TH PVREMOVE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvremove - Remove LVM label(s) from physical volume(s) +. +pvremove \(em Remove LVM label(s) from physical volume(s) . .SH SYNOPSIS +. \fBpvremove\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. pvremove wipes the label on a device so that LVM will no longer recognise it as a PV. - +.P A PV cannot be removed from a VG while it is used by an active LV. - +.P Repeat the force option (\fB-ff\fP) to forcibly remove a PV belonging to an existing VG. Normally, \fBvgreduce\fP(8) should be used instead. +. .SH USAGE +. \fBpvremove\fP \fIPV\fP ... .br .RS 4 .ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -246,91 +205,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvresize.8_pregen b/man/pvresize.8_pregen index fcc85885b..ea309b311 100644 --- a/man/pvresize.8_pregen +++ b/man/pvresize.8_pregen @@ -1,239 +1,198 @@ .TH PVRESIZE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvresize - Resize physical volume(s) +. +pvresize \(em Resize physical volume(s) . .SH SYNOPSIS +. \fBpvresize\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. pvresize resizes a PV. The PV may already be in a VG and may have active LVs allocated on it. +. .SH USAGE +. \fBpvresize\fP \fIPV\fP ... .br .RS 4 .ad l [ \fB--setphysicalvolumesize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--setphysicalvolumesize\fP \fISize\fP[m|UNIT] .br -.ad b Overrides the automatically detected size of the PV. Use with care, or prior to reducing the physical size of the device. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -241,103 +200,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES -pvresize will refuse to shrink a PV if it has allocated extents beyond the -new end. -.SH EXAMPLES -Expand a PV after enlarging the partition. -.br -.B pvresize /dev/sda1 - -Shrink a PV prior to shrinking the partition (ensure that the PV size is -appropriate for the intended new partition size). -.br -.B pvresize --setphysicalvolumesize 40G /dev/sda1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvs.8_pregen b/man/pvs.8_pregen index f00e0328a..08b5600f5 100644 --- a/man/pvs.8_pregen +++ b/man/pvs.8_pregen @@ -1,332 +1,251 @@ .TH PVS 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvs - Display information about physical volumes +. +pvs \(em Display information about physical volumes . .SH SYNOPSIS +. \fBpvs\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. pvs produces formatted output about PVs. +. .SH USAGE +. \fBpvs\fP .br .RS 4 .ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--segments\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--nameprefixes\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--rows\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br -.ad l [ \fB--unquoted\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIPV\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Show information about devices that have not been initialized by LVM, i.e. they are not PVs. +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nameprefixes\fP .br -.ad b Add an "LVM2_" prefix plus the field name to the output. Useful with --noheadings to produce a list of field=value pairs that can be used to set environment variables (for example, in udev rules). +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -340,63 +259,56 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--rows\fP .br -.ad b Output columns as rows. +. .HP -.ad l \fB--segments\fP .br -.ad b Produces one line of output for each contiguous allocation of space on each PV, showing the start (pvseg_start) and length (pvseg_size) in units of physical extents. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -405,86 +317,82 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB--unquoted\fP .br -.ad b When used with --nameprefixes, output values in the field=value pairs are not quoted. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -492,105 +400,40 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES -. -The pv_attr bits are: -.IP 1 3 -(d)uplicate, (a)llocatable, (u)sed -.IP 2 3 -e(x)ported -.IP 3 3 -(m)issing -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/pvscan.8_pregen b/man/pvscan.8_pregen index 1b0d3d925..8025d6c34 100644 --- a/man/pvscan.8_pregen +++ b/man/pvscan.8_pregen @@ -1,52 +1,57 @@ .TH PVSCAN 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -pvscan - List all physical volumes +. +pvscan \(em List all physical volumes . .SH SYNOPSIS +. \fBpvscan\fP \fIoption_args\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. When called without the --cache option, pvscan lists PVs on the system, like .BR pvs (8) or .BR pvdisplay (8). - +.P When the --cache and -aay options are used, pvscan records which PVs are available on the system, and activates LVs in completed VGs. A VG is complete when pvscan sees that the final PV in the VG has appeared. This is used by event-based system startup (systemd, udev) to activate LVs. - +.P The four main variations of this are: - +.P .B pvscan --cache -.IR device - +.I device +.P If device is present, lvm adds a record that the PV on device is online. If device is not present, lvm removes the online record for the PV. In most cases, the pvscan will only read the named devices. - +.P .B pvscan --cache -aay .IR device ... - +.P This begins by performing the same steps as above. Afterward, if the VG for the specified PV is complete, then pvscan will activate LVs in the VG (the same as vgchange -aay vgname would do.) - +.P .B pvscan --cache - +.P This first clears all existing PV online records, then scans all devices on the system, adding PV online records for any PVs that are found. - +.P .B pvscan --cache -aay - +.P This begins by performing the same steps as pvscan --cache. Afterward, it activates LVs in any complete VGs. - +.P To prevent devices from being scanned by pvscan --cache, add them to .BR lvm.conf (5) @@ -54,23 +59,24 @@ to For more information, see: .br .B lvmconfig --withcomments devices/global_filter - +.P Auto-activation of VGs or LVs can be enabled/disabled using: .br .BR lvm.conf (5) .B activation/auto_activation_volume_list - +.P For more information, see: .br .B lvmconfig --withcomments activation/auto_activation_volume_list - +.P To disable auto-activation, explicitly set this list to an empty list, i.e. auto_activation_volume_list = [ ]. - +.P When this setting is undefined (e.g. commented), then all LVs are auto-activated. - +. .SH USAGE +. Display PV information. .br .P @@ -79,24 +85,17 @@ Display PV information. .RS 4 .ad l [ \fB-e\fP|\fB--exported\fP ] -.ad b .br -.ad l [ \fB-n\fP|\fB--novolumegroup\fP ] -.ad b .br -.ad l [ \fB-s\fP|\fB--short\fP ] -.ad b .br -.ad l [ \fB-u\fP|\fB--uuid\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Autoactivate a VG when all PVs are online. .br .P @@ -105,305 +104,242 @@ Autoactivate a VG when all PVs are online. .RS 4 .ad l [ \fB-a\fP|\fB--activate\fP \fBay\fP ] -.ad b .br -.ad l [ \fB-j\fP|\fB--major\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--minor\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIString\fP|\fIPV\fP ... ] .RE - +.P Common options for command: . .RS 4 .ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP .br -.ad b Auto-activate LVs in a VG when the PVs scanned have completed the VG. (Only \fBay\fP is applicable.) +. .HP -.ad l \fB--cache\fP .br -.ad b Scan one or more devices and record that they are online. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-e\fP|\fB--exported\fP .br -.ad b Only show PVs belonging to exported VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-j\fP|\fB--major\fP \fINumber\fP .br -.ad b The major number of a device. +. .HP -.ad l \fB--minor\fP \fINumber\fP .br -.ad b The minor number of a device. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB-n\fP|\fB--novolumegroup\fP .br -.ad b Only show PVs not belonging to any VG. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-s\fP|\fB--short\fP .br -.ad b Short listing format. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-u\fP|\fB--uuid\fP .br -.ad b Show UUIDs in addition to device names. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -411,91 +347,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgcfgbackup.8_pregen b/man/vgcfgbackup.8_pregen index 1ef11ffb0..ce7102595 100644 --- a/man/vgcfgbackup.8_pregen +++ b/man/vgcfgbackup.8_pregen @@ -1,382 +1,277 @@ .TH VGCFGBACKUP 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgcfgbackup - Backup volume group configuration(s) +. +vgcfgbackup \(em Backup volume group configuration(s) . .SH SYNOPSIS +. \fBvgcfgbackup\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. vgcfgbackup creates back up files containing metadata of VGs. If no VGs are named, back up files are created for all VGs. See \fBvgcfgrestore\fP for information on using the back up files. - +.P In a default installation, each VG is backed up into a separate file bearing the name of the VG in the directory \fI#DEFAULT_BACKUP_DIR#\fP. - +.P To use an alternative back up file, use \fB-f\fP. In this case, when backing up multiple VGs, the file name is treated as a template, with %s replaced by the VG name. - +.P NB. This DOES NOT back up the data content of LVs. - +.P It may also be useful to regularly back up the files in \fI#DEFAULT_SYS_DIR#\fP. +. .SH USAGE +. \fBvgcfgbackup\fP .br .RS 4 .ad l [ \fB-f\fP|\fB--file\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--file\fP \fIString\fP .br -.ad b Write the backup to the named file. When backing up more than one VG, the file name is treated as a template, and %s is replaced by the VG name. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgcfgrestore.8_pregen b/man/vgcfgrestore.8_pregen index 151aa2505..841626728 100644 --- a/man/vgcfgrestore.8_pregen +++ b/man/vgcfgrestore.8_pregen @@ -1,8 +1,11 @@ .TH VGCFGRESTORE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgcfgrestore - Restore volume group configuration +. +vgcfgrestore \(em Restore volume group configuration . .SH SYNOPSIS +. \fBvgcfgrestore\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -12,472 +15,333 @@ vgcfgrestore - Restore volume group configuration .P .ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-f\fP|\fB--file\fP \fIString\fP -.ad b .br -.ad l \fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB-l\fP|\fB--list\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. vgcfgrestore restores the metadata of a VG from a text back up file produced by \fBvgcfgbackup\fP. This writes VG metadata onto the devices specifed in back up file. - +.P A back up file can be specified with \fB--file\fP. If no backup file is specified, the most recent one is used. Use \fB--list\fP for a list of the available back up and archive files of a VG. - +.P WARNING: When a VG contains thin pools, changes to thin metadata cannot be reverted, and data loss may occur if thin metadata has changed. The force option is required to restore in this case. +. .SH USAGE +. Restore VG metadata from last backup. .br .P \fBvgcfgrestore\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Restore VG metadata from specified file. .br .P \fBvgcfgrestore\fP \fB-f\fP|\fB--file\fP \fIString\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P List all VG metadata backups. .br .P \fBvgcfgrestore\fP \fB-l\fP|\fB--list\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P List one VG metadata backup file. .br .P \fBvgcfgrestore\fP \fB-l\fP|\fB--list\fP \fB-f\fP|\fB--file\fP \fIString\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP ] .RE -- - +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP ] -.ad b .br -.ad l [ \fB--force\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--file\fP \fIString\fP .br -.ad b Read metadata backup from the named file. Usually this file was created by vgcfgbackup. +. .HP -.ad l \fB--force\fP ... .br -.ad b Force metadata restore even with thin pool LVs. Use with extreme caution. Most changes to thin metadata cannot be reverted. You may lose data if you restore metadata that does not match the thin pool kernel metadata precisely. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-l\fP|\fB--list\fP .br -.ad b List metadata backup and archive files pertaining to the VG. May be used with --file. Does not restore the VG. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP .br -.ad b Specifies the type of on-disk metadata to use. \fBlvm2\fP (or just \fB2\fP) is the current, standard format. \fBlvm1\fP (or just \fB1\fP) is no longer used. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES - -To replace PVs, \fBvgdisplay --partial --verbose\fP will show the -UUIDs and sizes of any PVs that are no longer present. If a PV in the VG -is lost and you wish to substitute another of the same size, use -\fBpvcreate --restorefile filename --uuid uuid\fP (plus additional -arguments as appropriate) to initialise it with the same UUID as the -missing PV. Repeat for all other missing PVs in the VG. Then use -\fBvgcfgrestore --file filename\fP to restore the VG's metadata. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgchange.8_pregen b/man/vgchange.8_pregen index 025113627..857dabf04 100644 --- a/man/vgchange.8_pregen +++ b/man/vgchange.8_pregen @@ -1,8 +1,11 @@ .TH VGCHANGE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgchange - Change volume group attributes +. +vgchange \(em Change volume group attributes . .SH SYNOPSIS +. \fBvgchange\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -12,206 +15,114 @@ vgchange - Change volume group attributes .P .ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP -.ad b .br -.ad l \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP -.ad b .br -.ad l \fB--addtag\fP \fITag\fP -.ad b .br -.ad l - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.ad b .br -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--deltag\fP \fITag\fP -.ad b .br -.ad l \fB--detachprofile\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-f\fP|\fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB-K\fP|\fB--ignoreactivationskip\fP -.ad b .br -.ad l \fB--ignorelockingfailure\fP -.ad b .br -.ad l \fB--ignoremonitoring\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--lockstart\fP -.ad b .br -.ad l \fB--lockstop\fP -.ad b .br -.ad l \fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP -.ad b .br -.ad l \fB-l\fP|\fB--logicalvolume\fP \fINumber\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP -.ad b .br -.ad l \fB--metadataprofile\fP \fIString\fP -.ad b .br -.ad l \fB--monitor\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--noudevsync\fP -.ad b .br -.ad l \fB-P\fP|\fB--partial\fP -.ad b .br -.ad l \fB-s\fP|\fB--physicalextentsize\fP \fISize\fP[m|UNIT] -.ad b .br -.ad l \fB--poll\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--readonly\fP -.ad b .br -.ad l \fB--refresh\fP -.ad b .br -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP -.ad b .br -.ad l \fB-x\fP|\fB--resizeable\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-S\fP|\fB--select\fP \fIString\fP -.ad b .br -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--sysinit\fP -.ad b .br -.ad l \fB--systemid\fP \fIString\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-u\fP|\fB--uuid\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l - \fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP -.ad b + \fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. vgchange changes VG attributes, changes LV activation in the kernel, and includes other utilities for VG maintenance. +. .SH USAGE +. Change a general VG attribute. .br For options listed in parentheses, any one is @@ -235,14 +146,14 @@ required, after which the others are optional. .br \fB--deltag\fP \fITag\fP .br - \fB--alloc\fP + \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy .br \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br - \fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP + \fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP .br \fB--profile\fP \fIString\fP .br @@ -256,40 +167,28 @@ required, after which the others are optional. .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Start or stop monitoring LVs from dmeventd. .br .P @@ -298,48 +197,32 @@ Start or stop monitoring LVs from dmeventd. .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--sysinit\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Start or stop processing LV conversions. .br .P @@ -348,40 +231,28 @@ Start or stop processing LV conversions. .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Activate or deactivate LVs. .br .P @@ -390,68 +261,42 @@ Activate or deactivate LVs. .RS 4 .ad l [ \fB-K\fP|\fB--ignoreactivationskip\fP ] -.ad b .br -.ad l [ \fB-P\fP|\fB--partial\fP ] -.ad b .br -.ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP ] -.ad b .br -.ad l [ \fB--sysinit\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--monitor\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Reactivate LVs using the latest metadata. .br .P @@ -460,59 +305,45 @@ Reactivate LVs using the latest metadata. .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--sysinit\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--poll\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--ignoremonitoring\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Change the system ID of a VG. .br .P \fBvgchange\fP \fB--systemid\fP \fIString\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Start the lockspace of a shared VG in lvmlockd. .br .P @@ -521,16 +352,16 @@ Start the lockspace of a shared VG in lvmlockd. .RS 4 .ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Stop the lockspace of a shared VG in lvmlockd. .br .P @@ -539,105 +370,80 @@ Stop the lockspace of a shared VG in lvmlockd. .RS 4 .ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP|\fISelect\fP ... ] .RE -- - +.P +\(em +.P Change the lock type for a shared VG. .br .P \fBvgchange\fP \fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Common options for command: . .RS 4 +.ad l +.ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--activate\fP \fBy\fP|\fBn\fP|\fBay\fP .br -.ad b Change the active state of LVs. An active LV can be used through a block device, allowing data on the LV to be accessed. @@ -655,18 +461,17 @@ activation commands. By default, LVs are autoactivated. An autoactivation property can be set on a VG or LV to disable autoactivation, see --setautoactivation y|n in vgchange, lvchange, vgcreate, and lvcreate. Display the property with vgs or lvs "-o autoactivation". -The lvm.conf auto_activation_volume_list includes names of VGs or LVs +The \fBlvm.conf\fP(5) auto_activation_volume_list includes names of VGs or LVs that should be autoactivated, and anything not listed is not autoactivated. When auto_activation_volume_list is undefined (the default), it has no effect. If auto_activation_volume_list is defined and empty, no LVs are autoactivated. Items included by auto_activation_volume_list will not be autoactivated if the autoactivation property has been disabled. See \fBlvmlockd\fP(8) for more information about activation options \fBey\fP and \fBsy\fP for shared VGs. +. .HP -.ad l \fB--activationmode\fP \fBpartial\fP|\fBdegraded\fP|\fBcomplete\fP .br -.ad b Determines if LV activation is allowed when PVs are missing, e.g. because of a device failure. \fBcomplete\fP only allows LVs with no missing PVs to be activated, @@ -675,23 +480,23 @@ and is the most restrictive mode. (This does not include the "mirror" type, see "raid1" instead.) \fBpartial\fP allows any LV with missing PVs to be activated, and should only be used for recovery or repair. -For default, see lvm.conf/activation_mode. +For default, see \fBlvm.conf\fP(5) activation_mode. See \fBlvmraid\fP(7) for more information. +. .HP -.ad l \fB--addtag\fP \fITag\fP .br -.ad b Adds a tag to a PV, VG or LV. This option can be repeated to add multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -708,205 +513,178 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--deltag\fP \fITag\fP .br -.ad b Deletes a tag from a PV, VG or LV. This option can be repeated to delete multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP -.ad l \fB--detachprofile\fP .br -.ad b Detaches a metadata profile from a VG or LV. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-K\fP|\fB--ignoreactivationskip\fP .br -.ad b Ignore the "activation skip" LV flag during activation to allow LVs with the flag set to be activated. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--ignoremonitoring\fP .br -.ad b Do not interact with dmeventd unless --monitor is specified. Do not use this if dmeventd is already monitoring a device. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--lockstart\fP .br -.ad b Start the lockspace of a shared VG in lvmlockd. lvmlockd locks becomes available for the VG, allowing LVM to use the VG. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--lockstop\fP .br -.ad b Stop the lockspace of a shared VG in lvmlockd. lvmlockd locks become unavailable for the VG, preventing LVM from using the VG. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP .br -.ad b Change the VG lock type to or from a shared lock type used with lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB-l\fP|\fB--logicalvolume\fP \fINumber\fP .br -.ad b Sets the maximum number of LVs allowed in a VG. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP .br -.ad b Sets the maximum number of PVs that can belong to the VG. The value 0 removes any limitation. For large numbers of PVs, also see options --pvmetadatacopies, and --vgmetadatacopies for improving performance. +. .HP -.ad l \fB--metadataprofile\fP \fIString\fP .br -.ad b The metadata profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--monitor\fP \fBy\fP|\fBn\fP .br -.ad b Start (yes) or stop (no) monitoring an LV with dmeventd. dmeventd monitors kernel events for an LV, and performs automated maintenance for the LV in reponse to specific events. See \fBdmeventd\fP(8) for more information. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB-P\fP|\fB--partial\fP .br -.ad b Commands will do their best to activate LVs with missing PV extents. Missing extents may be replaced with error or zero segments -according to the lvm.conf missing_stripe_filler setting. +according to the missing_stripe_filler setting. Metadata may not be changed with this option. +. .HP -.ad l \fB-s\fP|\fB--physicalextentsize\fP \fISize\fP[m|UNIT] .br -.ad b Sets the physical extent size of PVs in the VG. The value must be either a power of 2 of at least 1 sector (where the sector size is the largest sector size of the PVs @@ -916,11 +694,10 @@ without recreating the VG, unless no extents need moving. Before increasing the physical extent size, you might need to use lvresize, pvresize and/or pvmove so that everything fits. For example, every contiguous range of extents used in a LV must start and end on an extent boundary. +. .HP -.ad l \fB--poll\fP \fBy\fP|\fBn\fP .br -.ad b When yes, start the background transformation of an LV. An incomplete transformation, e.g. pvmove or lvconvert interrupted by reboot or crash, can be restarted from the last checkpoint with --poll y. @@ -928,18 +705,16 @@ When no, background transformation of an LV will not occur, and the transformation will not complete. It may not be appropriate to immediately poll an LV after activation, in which case --poll n can be used to defer polling until a later --poll y command. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad b The number of metadata areas to set aside on a PV for storing VG metadata. When 2, one copy of the VG metadata is stored at the front of the PV and a second copy is stored at the end. @@ -947,56 +722,50 @@ When 1, one copy of the VG metadata is stored at the front of the PV. When 0, no copies of the VG metadata are stored on the given PV. This may be useful in VGs containing many PVs (this places limitations on the ability to use vgsplit later.) +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--refresh\fP .br -.ad b If the LV is active, reload its metadata. This is not necessary in normal operation, but may be useful if something has gone wrong, or if some form of manual LV sharing is being used. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-x\fP|\fB--resizeable\fP \fBy\fP|\fBn\fP .br -.ad b Enables or disables the addition or removal of PVs to/from a VG (by vgextend/vgreduce). +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -1005,11 +774,10 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP .br -.ad b Set the autoactivation property on a VG or LV. Display the property with vgs or lvs "-o autoactivation". When the autoactivation property is disabled, the VG or LV @@ -1019,11 +787,10 @@ If autoactivation is disabled on a VG, no LVs will be autoactivated in that VG, and the LV autoactivation property has no effect. If autoactivation is enabled on a VG, autoactivation can be disabled for individual LVs. +. .HP -.ad l \fB--sysinit\fP .br -.ad b Indicates that vgchange/lvchange is being invoked from early system initialisation scripts (e.g. rc.sysinit or an initrd), before writable filesystems are available. As such, some functionality needs to be disabled and this option @@ -1031,49 +798,43 @@ acts as a shortcut which selects an appropriate set of options. Currently, this is equivalent to using --ignorelockingfailure, --ignoremonitoring, --poll n, and setting env var LVM_SUPPRESS_LOCKING_FAILURE_MESSAGES. vgchange/lvchange skip autoactivation, and defer to pvscan autoactivation. +. .HP -.ad l \fB--systemid\fP \fIString\fP .br -.ad b Changes the system ID of the VG. Using this option requires caution because the VG may become foreign to the host running the command, leaving the host unable to access it. See \fBlvmsystemid\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-u\fP|\fB--uuid\fP .br -.ad b Generate new random UUID for specified VGs. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l -\fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP +\fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP .br -.ad b Number of copies of the VG metadata that are kept. VG metadata is kept in VG metadata areas on PVs in the VG, i.e. reserved space at the start and/or end of the PVs. @@ -1087,127 +848,58 @@ The number can also be replaced with special string values: metadataignore flags. \fBall\fP causes LVM to first clear the metadataignore flags on all PVs, and then to become unmanaged. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES -If vgchange recognizes COW snapshot LVs that were dropped because they ran -out of space, it displays a message informing the administrator that the -snapshots should be removed. -.SH EXAMPLES -Activate all LVs in all VGs on all existing devices. -.br -.B vgchange -a y - -Change the maximum number of LVs for an inactive VG. -.br -.B vgchange -l 128 vg00 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgck.8_pregen b/man/vgck.8_pregen index aef35f3b2..f177dfbdd 100644 --- a/man/vgck.8_pregen +++ b/man/vgck.8_pregen @@ -1,17 +1,24 @@ .TH VGCK 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgck - Check the consistency of volume group(s) +. +vgck \(em Check the consistency of volume group(s) . .SH SYNOPSIS +. \fBvgck\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. vgck checks LVM metadata for consistency. +. .SH USAGE +. Read and display information about a VG. .br .P @@ -20,211 +27,170 @@ Read and display information about a VG. .RS 4 .ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP ... ] .RE - +.P Rewrite VG metadata to correct problems. .br .P \fBvgck\fP \fB--updatemetadata\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 +.ad l +.ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--updatemetadata\fP .br -.ad b Update VG metadata to correct problems. If VG metadata was updated while a PV was missing, and the PV reappears with an old version of metadata, then this option @@ -235,122 +201,64 @@ this option will clear the outdated metadata from the previously missing PV. If metadata text is damaged on one PV, using this option will replace the damaged metadata text. For more severe damage, e.g. with headers, see \fBpvck\fP(8). +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgconvert.8_pregen b/man/vgconvert.8_pregen index 093512ab0..d18e7af08 100644 --- a/man/vgconvert.8_pregen +++ b/man/vgconvert.8_pregen @@ -1,125 +1,90 @@ .TH VGCONVERT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgconvert - Change volume group metadata format +. +vgconvert \(em Change volume group metadata format . .SH SYNOPSIS +. \fBvgconvert\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgconvert is no longer a part of LVM. It was removed along with support for the LVM1 format. Use an older version of LVM to convert VGs from the LVM1 format to LVM2. +. .SH USAGE +. \fBvgconvert\fP \fIVG\fP ... .br .RS 4 .ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP ] -.ad b .br -.ad l [ \fB--labelsector\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--bootloaderareasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--metadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE - +. .SH OPTIONS +. +. .HP -.ad l \fB--bootloaderareasize\fP \fISize\fP[m|UNIT] .br -.ad b Reserve space for the bootloader between the LVM metadata area and the first PE. The bootloader area is reserved for bootloaders to embed their own data or metadata; LVM will not use it. @@ -131,122 +96,106 @@ and --dataalignmentoffset. The bootloader area may be larger than requested due to the alignment, but it's never less than the requested size. To see the bootloader area start and size of an existing PV use pvs -o +pv_ba_start,pv_ba_size. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--labelsector\fP \fINumber\fP .br -.ad b By default the PV is labelled with an LVM2 identifier in its second sector (sector 1). This lets you use a different sector near the start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS in the source). Use with care. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--metadatasize\fP \fISize\fP[m|UNIT] .br -.ad b The approximate amount of space used for each VG metadata area. The size may be rounded. +. .HP -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP .br -.ad b Specifies the type of on-disk metadata to use. \fBlvm2\fP (or just \fB2\fP) is the current, standard format. \fBlvm1\fP (or just \fB1\fP) is no longer used. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad b The number of metadata areas to set aside on a PV for storing VG metadata. When 2, one copy of the VG metadata is stored at the front of the PV and a second copy is stored at the end. @@ -254,146 +203,85 @@ When 1, one copy of the VG metadata is stored at the front of the PV. When 0, no copies of the VG metadata are stored on the given PV. This may be useful in VGs containing many PVs (this places limitations on the ability to use vgsplit later.) +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. - -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgcreate.8_pregen b/man/vgcreate.8_pregen index 3a3c35a08..7e357a548 100644 --- a/man/vgcreate.8_pregen +++ b/man/vgcreate.8_pregen @@ -1,206 +1,141 @@ .TH VGCREATE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgcreate - Create a volume group +. +vgcreate \(em Create a volume group . .SH SYNOPSIS +. \fBvgcreate\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgcreate creates a new VG on block devices. If the devices were not previously initialized as PVs with \fBpvcreate\fP(8), vgcreate will inititialize them, making them PVs. The pvcreate options for initializing devices are also available with vgcreate. - +.P When vgcreate uses an existing PV, that PV's existing values for metadata size, PE start, etc, are used, even if different values are specified in the vgcreate command. To change these values, first use pvremove on the device. - +. .SH USAGE +. \fBvgcreate\fP \fIVG\fP\fI_new\fP \fIPV\fP ... .br .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--clustered\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-l\fP|\fB--maxlogicalvolumes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP ] -.ad b .br -.ad l [ \fB-s\fP|\fB--physicalextentsize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--addtag\fP \fITag\fP ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l [ \fB--metadataprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--labelsector\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--metadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l -[ \fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP ] -.ad b +[ \fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP ] .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--dataalignment\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--systemid\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP ] -.ad b .br -.ad l [ \fB--setautoactivation\fP \fBy\fP|\fBn\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--addtag\fP \fITag\fP .br -.ad b Adds a tag to a PV, VG or LV. This option can be repeated to add multiple tags at once. See \fBlvm\fP(8) for information about tags. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -217,192 +152,167 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB-c\fP|\fB--clustered\fP \fBy\fP|\fBn\fP .br -.ad b This option was specific to clvm and is now replaced by the --shared option with \fBlvmlockd\fP(8). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--dataalignment\fP \fISize\fP[k|UNIT] .br -.ad b Align the start of a PV data area with a multiple of this number. To see the location of the first Physical Extent (PE) of an existing PV, use pvs -o +pe_start. In addition, it may be shifted by an alignment offset, see --dataalignmentoffset. Also specify an appropriate PE size when creating a VG. +. .HP -.ad l \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] .br -.ad b Shift the start of the PV data area by this additional offset. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--labelsector\fP \fINumber\fP .br -.ad b By default the PV is labelled with an LVM2 identifier in its second sector (sector 1). This lets you use a different sector near the start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS in the source). Use with care. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--locktype\fP \fBsanlock\fP|\fBdlm\fP|\fBnone\fP .br -.ad b Specify the VG lock type directly in place of using --shared. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-l\fP|\fB--maxlogicalvolumes\fP \fINumber\fP .br -.ad b Sets the maximum number of LVs allowed in a VG. +. .HP -.ad l \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP .br -.ad b Sets the maximum number of PVs that can belong to the VG. The value 0 removes any limitation. For large numbers of PVs, also see options --pvmetadatacopies, and --vgmetadatacopies for improving performance. +. .HP -.ad l \fB--metadataprofile\fP \fIString\fP .br -.ad b The metadata profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--metadatasize\fP \fISize\fP[m|UNIT] .br -.ad b The approximate amount of space used for each VG metadata area. The size may be rounded. +. .HP -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP .br -.ad b Specifies the type of on-disk metadata to use. \fBlvm2\fP (or just \fB2\fP) is the current, standard format. \fBlvm1\fP (or just \fB1\fP) is no longer used. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB-s\fP|\fB--physicalextentsize\fP \fISize\fP[m|UNIT] .br -.ad b Sets the physical extent size of PVs in the VG. The value must be either a power of 2 of at least 1 sector (where the sector size is the largest sector size of the PVs currently used in the VG), or at least 128KiB. Once this value has been set, it is difficult to change without recreating the VG, unless no extents need moving. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad b The number of metadata areas to set aside on a PV for storing VG metadata. When 2, one copy of the VG metadata is stored at the front of the PV and a second copy is stored at the end. @@ -410,29 +320,26 @@ When 1, one copy of the VG metadata is stored at the front of the PV. When 0, no copies of the VG metadata are stored on the given PV. This may be useful in VGs containing many PVs (this places limitations on the ability to use vgsplit later.) +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--setautoactivation\fP \fBy\fP|\fBn\fP .br -.ad b Set the autoactivation property on a VG or LV. Display the property with vgs or lvs "-o autoactivation". When the autoactivation property is disabled, the VG or LV @@ -442,21 +349,19 @@ If autoactivation is disabled on a VG, no LVs will be autoactivated in that VG, and the LV autoactivation property has no effect. If autoactivation is enabled on a VG, autoactivation can be disabled for individual LVs. +. .HP -.ad l \fB--shared\fP .br -.ad b Create a shared VG using lvmlockd if LVM is compiled with lockd support. lvmlockd will select lock type sanlock or dlm depending on which lock manager is running. This allows multiple hosts to share a VG on shared devices. lvmlockd and a lock manager must be configured and running. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB--systemid\fP \fIString\fP .br -.ad b Specifies the system ID that will be given to the new VG, overriding the system ID of the host running the command. A VG is normally created without this option, in which case the new VG is given the system ID of @@ -464,34 +369,30 @@ the host creating it. Using this option requires caution because the system ID of the new VG may not match the system ID of the host running the command, leaving the VG inaccessible to the host. See \fBlvmsystemid\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l -\fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP +\fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP .br -.ad b Number of copies of the VG metadata that are kept. VG metadata is kept in VG metadata areas on PVs in the VG, i.e. reserved space at the start and/or end of the PVs. @@ -505,30 +406,28 @@ The number can also be replaced with special string values: metadataignore flags. \fBall\fP causes LVM to first clear the metadataignore flags on all PVs, and then to become unmanaged. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .HP -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .br -.ad b Controls if the first 4 sectors (2048 bytes) of the device are wiped. The default is to wipe these sectors unless either or both of --restorefile or --uuid are specified. +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIPV\fP -.br +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -536,96 +435,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Create a VG with two PVs, using the default physical extent size. -.br -.B vgcreate myvg /dev/sdk1 /dev/sdl1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgdisplay.8_pregen b/man/vgdisplay.8_pregen index a6f8106f2..467f74506 100644 --- a/man/vgdisplay.8_pregen +++ b/man/vgdisplay.8_pregen @@ -1,337 +1,257 @@ .TH VGDISPLAY 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgdisplay - Display volume group information +. +vgdisplay \(em Display volume group information . .SH SYNOPSIS +. \fBvgdisplay\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. vgdisplay shows the attributes of VGs, and the associated PVs and LVs. - +.P \fBvgs\fP(8) is a preferred alternative that shows the same information and more, using a more compact and configurable output format. +. .SH USAGE +. \fBvgdisplay\fP .br .RS 4 .ad l [ \fB-A\fP|\fB--activevolumegroups\fP ] -.ad b .br -.ad l [ \fB-c\fP|\fB--colon\fP ] -.ad b .br -.ad l [ \fB-C\fP|\fB--columns\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-s\fP|\fB--short\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--activevolumegroups\fP .br -.ad b Only select active VGs. The VG is considered active if at least one of its LVs is active. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB-c\fP|\fB--colon\fP .br -.ad b Generate colon separated output for easier parsing in scripts or programs. Also see \fBvgs\fP(8) which provides considerably more control over the output. +. .HP -.ad l \fB-C\fP|\fB--columns\fP .br -.ad b Display output in columns, the equivalent of \fBvgs\fP(8). Options listed are the same as options given in \fBvgs\fP(8). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -345,49 +265,44 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -396,176 +311,116 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-s\fP|\fB--short\fP .br -.ad b Give a short listing showing the existence of VGs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgexport.8_pregen b/man/vgexport.8_pregen index 89a25af07..0e6e0b164 100644 --- a/man/vgexport.8_pregen +++ b/man/vgexport.8_pregen @@ -1,33 +1,40 @@ .TH VGEXPORT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgexport - Unregister volume group(s) from the system +. +vgexport \(em Unregister volume group(s) from the system . .SH SYNOPSIS +. \fBvgexport\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgexport changes a VG into the exported state, which ensures that the VG and its disks are not being used, and cannot be used until the VG is imported by \fBvgimport\fP(8). Putting a VG into an unusable, offline state can be useful when doing things like moving a VG's disks to another system. Exporting a VG provides some protection from its LVs being accidentally used, or being used by an automated system before it's ready. - +.P A VG cannot be exported until all of its LVs are inactive. - +.P LVM commands will ignore an exported VG or report an error if a command tries to use it. - +.P For an exported VG, the vgs command will display \"x\" in the third VG attribute, and the pvs command will display \"x\" in the second PV attribute. Both vgs and pvs will display \"exported\" from the export report field. - +.P vgexport clears the VG system ID, and vgimport sets the VG system ID to match the host running vgimport (if the host has a system ID). +. .SH USAGE +. Export specified VGs. .br .P @@ -36,22 +43,22 @@ Export specified VGs. .RS 4 .ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Export all VGs. .br .P \fBvgexport\fP \fB-a\fP|\fB--all\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 @@ -59,183 +66,140 @@ Common options for command: [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -244,138 +208,78 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgextend.8_pregen b/man/vgextend.8_pregen index c4c0b130a..e5e01c4c5 100644 --- a/man/vgextend.8_pregen +++ b/man/vgextend.8_pregen @@ -1,296 +1,232 @@ .TH VGEXTEND 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgextend - Add physical volumes to a volume group +. +vgextend \(em Add physical volumes to a volume group . .SH SYNOPSIS +. \fBvgextend\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgextend adds one or more PVs to a VG. This increases the space available for LVs in the VG. - +.P Also, PVs that have gone missing and then returned, e.g. due to a transient device failure, can be added back to the VG without re-initializing them (see --restoremissing). - +.P If the specified PVs have not yet been initialized with pvcreate, vgextend will initialize them. In this case pvcreate options can be used, e.g. --labelsector, --metadatasize, --metadataignore, --pvmetadatacopies, --dataalignment, --dataalignmentoffset. +. .SH USAGE +. \fBvgextend\fP \fIVG\fP \fIPV\fP ... .br .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP ] -.ad b .br -.ad l [ \fB--labelsector\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB--metadatasize\fP \fISize\fP[m|UNIT] ] -.ad b .br -.ad l [ \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP ] -.ad b .br -.ad l [ \fB--metadataignore\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--dataalignment\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--restoremissing\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--dataalignment\fP \fISize\fP[k|UNIT] .br -.ad b Align the start of a PV data area with a multiple of this number. To see the location of the first Physical Extent (PE) of an existing PV, use pvs -o +pe_start. In addition, it may be shifted by an alignment offset, see --dataalignmentoffset. Also specify an appropriate PE size when creating a VG. +. .HP -.ad l \fB--dataalignmentoffset\fP \fISize\fP[k|UNIT] .br -.ad b Shift the start of the PV data area by this additional offset. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--labelsector\fP \fINumber\fP .br -.ad b By default the PV is labelled with an LVM2 identifier in its second sector (sector 1). This lets you use a different sector near the start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS in the source). Use with care. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--metadataignore\fP \fBy\fP|\fBn\fP .br -.ad b Specifies the metadataignore property of a PV. If yes, metadata areas on the PV are ignored, and lvm will not store metadata in the metadata areas of the PV. If no, lvm will store metadata on the PV. +. .HP -.ad l \fB--metadatasize\fP \fISize\fP[m|UNIT] .br -.ad b The approximate amount of space used for each VG metadata area. The size may be rounded. +. .HP -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP .br -.ad b Specifies the type of on-disk metadata to use. \fBlvm2\fP (or just \fB2\fP) is the current, standard format. \fBlvm1\fP (or just \fB1\fP) is no longer used. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB--pvmetadatacopies\fP \fB0\fP|\fB1\fP|\fB2\fP .br -.ad b The number of metadata areas to set aside on a PV for storing VG metadata. When 2, one copy of the VG metadata is stored at the front of the PV and a second copy is stored at the end. @@ -298,78 +234,70 @@ When 1, one copy of the VG metadata is stored at the front of the PV. When 0, no copies of the VG metadata are stored on the given PV. This may be useful in VGs containing many PVs (this places limitations on the ability to use vgsplit later.) +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--restoremissing\fP .br -.ad b Add a PV back into a VG after the PV was missing and then returned, e.g. due to a transient failure. The PV is not reinitialized. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .HP -.ad l \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP .br -.ad b Controls if the first 4 sectors (2048 bytes) of the device are wiped. The default is to wipe these sectors unless either or both of --restorefile or --uuid are specified. +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIPV\fP -.br +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -377,96 +305,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Add two PVs to a VG. -.br -.B vgextend vg00 /dev/sda4 /dev/sdn1 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgimport.8_pregen b/man/vgimport.8_pregen index 993a52e21..c0b815b65 100644 --- a/man/vgimport.8_pregen +++ b/man/vgimport.8_pregen @@ -1,19 +1,26 @@ .TH VGIMPORT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgimport - Register exported volume group with system +. +vgimport \(em Register exported volume group with system . .SH SYNOPSIS +. \fBvgimport\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgimport makes exported VGs known to the system again, perhaps after moving the PVs from a different system. - +.P vgexport clears the VG system ID, and vgimport sets the VG system ID to match the host running vgimport (if the host has a system ID). +. .SH USAGE +. Import specified VGs. .br .P @@ -22,218 +29,172 @@ Import specified VGs. .RS 4 .ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Import all VGs. .br .P \fBvgimport\fP \fB-a\fP|\fB--all\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Import all visible VGs. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -242,138 +203,78 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgimportclone.8_pregen b/man/vgimportclone.8_pregen index 2fe7ed60f..ee9bbe66c 100644 --- a/man/vgimportclone.8_pregen +++ b/man/vgimportclone.8_pregen @@ -1,252 +1,208 @@ .TH VGIMPORTCLONE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgimportclone - Import a VG from cloned PVs +. +vgimportclone \(em Import a VG from cloned PVs . .SH SYNOPSIS +. \fBvgimportclone\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgimportclone imports a VG from duplicated PVs, e.g. created by a hardware snapshot of existing PVs. - +.P A duplicated VG cannot used until it is made to coexist with the original VG. vgimportclone renames the VG associated with the specified PVs and changes the associated VG and PV UUIDs. +. .SH USAGE +. \fBvgimportclone\fP \fIPV\fP ... .br .RS 4 .ad l [ \fB-n\fP|\fB--basevgname\fP \fIVG\fP ] -.ad b .br -.ad l [ \fB-i\fP|\fB--import\fP ] -.ad b .br -.ad l [ \fB--importdevices\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-n\fP|\fB--basevgname\fP \fIString\fP .br -.ad b By default the snapshot VG will be renamed to the original name plus a numeric suffix to avoid duplicate naming (e.g. 'test_vg' would be renamed to 'test_vg1'). This option will override the base VG name that is used for all VG renames. If a VG already exists with the specified name a numeric suffix will be added (like the previous example) to make it unique. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-i\fP|\fB--import\fP .br -.ad b Import exported VGs. Otherwise VGs that have been exported will not be changed (nor will their associated PVs). +. .HP -.ad l \fB--importdevices\fP .br -.ad b Add devices to the devices file. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIPV\fP -.br +. +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -254,99 +210,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -An original VG "vg00" has PVs "/dev/sda" and "/dev/sdb". -The corresponding PVs from a hardware snapshot are "/dev/sdc" and "/dev/sdd". -Rename the VG associated with "/dev/sdc" and "/dev/sdd" from "vg00" to "vg00_snap" -(and change associated UUIDs). -.br -.B vgimportclone --basevgname vg00_snap /dev/sdc /dev/sdd -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgimportdevices.8_pregen b/man/vgimportdevices.8_pregen index 18beabdfa..364ef52a4 100644 --- a/man/vgimportdevices.8_pregen +++ b/man/vgimportdevices.8_pregen @@ -1,25 +1,31 @@ .TH VGIMPORTDEVICES 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgimportdevices - Add devices for a VG to the devices file. +. +vgimportdevices \(em Add devices for a VG to the devices file. . .SH SYNOPSIS +. \fBvgimportdevices\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgimportdevices adds PVs from a VG to the devices file. This is similar to using using lvmdevices --adddev to add each PV to the devices file individually. vgimportdevices will also update the VG metadata to include the device IDs of each PV. vgimportdevices will create a new devices file if none exists. - +.P When a devices file is used, the regex filter is ignored, except in the case of vgimportdevices which will apply the regex filter when looking for the VGs to import to the devices file. Use vgimportdevices -a to import all VGs on a system to the devices file. - +. .SH USAGE +. Add devices from specific VGs to the devices file. .br .P @@ -28,217 +34,171 @@ Add devices from specific VGs to the devices file. .RS 4 .ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Add devices from all accessible VGs to the devices file. .br .P \fBvgimportdevices\fP \fB-a\fP|\fB--all\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -247,138 +207,78 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgmerge.8_pregen b/man/vgmerge.8_pregen index cca10b528..1264bb565 100644 --- a/man/vgmerge.8_pregen +++ b/man/vgmerge.8_pregen @@ -1,327 +1,225 @@ .TH VGMERGE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgmerge - Merge volume groups +. +vgmerge \(em Merge volume groups . .SH SYNOPSIS +. \fBvgmerge\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgmerge merges two existing VGs. The inactive source VG is merged into the destination VG if physical extent sizes are equal and PV and LV summaries of both VGs fit into the destination VG's limits. +. .SH USAGE +. \fBvgmerge\fP \fIVG\fP \fIVG\fP .br .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-l\fP|\fB--list\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB-l\fP|\fB--list\fP .br -.ad b Display merged destination VG like vgdisplay -v. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Merge an inactive VG named "vg00" into the active or inactive VG named -"databases", giving verbose runtime information. -.br -.B vgmerge -v databases vg00 -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgmknodes.8_pregen b/man/vgmknodes.8_pregen index 34213ef8e..10f235949 100644 --- a/man/vgmknodes.8_pregen +++ b/man/vgmknodes.8_pregen @@ -1,356 +1,255 @@ .TH VGMKNODES 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgmknodes - Create the special files for volume group devices in /dev +. +vgmknodes \(em Create the special files for volume group devices in /dev . .SH SYNOPSIS +. \fBvgmknodes\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. vgmknodes checks the LVM device nodes in /dev that are needed for active LVs and creates any that are missing and removes unused ones. - +.P This command should not usually be needed if all the system components are interoperating correctly. +. .SH USAGE +. \fBvgmknodes\fP .br .RS 4 .ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--refresh\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fILV\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--refresh\fP .br -.ad b If the LV is active, reload its metadata. This is not necessary in normal operation, but may be useful if something has gone wrong, or if some form of manual LV sharing is being used. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fILV\fP -.br +.TP +.I LV Logical Volume name. See \fBlvm\fP(8) for valid names. An LV positional arg generally includes the VG name and LV name, e.g. VG/LV. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgreduce.8_pregen b/man/vgreduce.8_pregen index f0d22121b..1509e4bd0 100644 --- a/man/vgreduce.8_pregen +++ b/man/vgreduce.8_pregen @@ -1,8 +1,11 @@ .TH VGREDUCE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgreduce - Remove physical volume(s) from a volume group +. +vgreduce \(em Remove physical volume(s) from a volume group . .SH SYNOPSIS +. \fBvgreduce\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] @@ -10,116 +13,82 @@ vgreduce - Remove physical volume(s) from a volume group .P .ad l \fB-a\fP|\fB--all\fP -.ad b .br -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB--commandprofile\fP \fIString\fP -.ad b .br -.ad l \fB--config\fP \fIString\fP -.ad b .br -.ad l \fB-d\fP|\fB--debug\fP -.ad b .br -.ad l \fB--devices\fP \fIPV\fP -.ad b .br -.ad l \fB--devicesfile\fP \fIString\fP -.ad b .br -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP -.ad b .br -.ad l \fB-f\fP|\fB--force\fP -.ad b .br -.ad l \fB-h\fP|\fB--help\fP -.ad b .br -.ad l \fB--lockopt\fP \fIString\fP -.ad b .br -.ad l \fB--longhelp\fP -.ad b .br -.ad l \fB--mirrorsonly\fP -.ad b .br -.ad l \fB--nolocking\fP -.ad b .br -.ad l \fB--profile\fP \fIString\fP -.ad b .br -.ad l \fB-q\fP|\fB--quiet\fP -.ad b .br -.ad l \fB--removemissing\fP -.ad b .br -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP -.ad b .br -.ad l \fB-t\fP|\fB--test\fP -.ad b .br -.ad l \fB-v\fP|\fB--verbose\fP -.ad b .br -.ad l \fB--version\fP -.ad b .br -.ad l \fB-y\fP|\fB--yes\fP .ad b +. .SH DESCRIPTION +. vgreduce removes one or more unused PVs from a VG. +. .SH USAGE +. Remove a PV from a VG. .br .P \fBvgreduce\fP \fIVG\fP \fIPV\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Remove all unused PVs from a VG. .br .P \fBvgreduce\fP \fB-a\fP|\fB--all\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Remove all missing PVs from a VG. .br .P @@ -128,215 +97,166 @@ Remove all missing PVs from a VG. .RS 4 .ad l [ \fB--mirrorsonly\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br -- - +.P +\(em +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b Removes all empty PVs if none are named on the command line. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--mirrorsonly\fP .br -.ad b Only remove missing PVs from mirror LVs. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--removemissing\fP .br -.ad b Removes all missing PVs from the VG, if there are no LVs allocated on them. This resumes normal operation of the VG (new LVs may again be created, changed and so on). @@ -347,56 +267,51 @@ were partly on the missing disks are removed completely, including those parts on disks that are still present. If LVs spanned several disks, including ones that are lost, salvaging some data first may be possible by activating LVs in partial mode. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIPV\fP -.br +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -404,91 +319,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgremove.8_pregen b/man/vgremove.8_pregen index 73d6dbd4a..cf5c48ce4 100644 --- a/man/vgremove.8_pregen +++ b/man/vgremove.8_pregen @@ -1,233 +1,189 @@ .TH VGREMOVE 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgremove - Remove volume group(s) +. +vgremove \(em Remove volume group(s) . .SH SYNOPSIS +. \fBvgremove\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgremove removes one or more VGs. If LVs exist in the VG, a prompt is used to confirm LV removal. - +.P If one or more PVs in the VG are lost, consider \fBvgreduce --removemissing\fP to make the VG metadata consistent again. - +.P Repeat the force option (\fB-ff\fP) to forcibly remove LVs in the VG without confirmation. +. .SH USAGE +. \fBvgremove\fP \fIVG\fP|\fITag\fP|\fISelect\fP ... .br .RS 4 .ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--noudevsync\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--noudevsync\fP .br -.ad b Disables udev synchronisation. The process will not wait for notification from udev. It will continue irrespective of any possible udev processing in the background. Only use this if udev is not running or has rules that ignore the devices LVM creates. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -236,138 +192,78 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fISelect\fP -.br +.TP +.I Select Select indicates that a required positional parameter can be omitted if the \fB--select\fP option is used. No arg appears in this position. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgrename.8_pregen b/man/vgrename.8_pregen index ba5adca31..24ff24744 100644 --- a/man/vgrename.8_pregen +++ b/man/vgrename.8_pregen @@ -1,15 +1,20 @@ .TH VGRENAME 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgrename - Rename a volume group +. +vgrename \(em Rename a volume group . .SH SYNOPSIS +. \fBvgrename\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgrename renames a VG. - +.P All VGs visible to a system need to have different names, otherwise many LVM commands will refuse to run or give warning messages. VGs with the same name can occur when disks are moved between machines, or filters are @@ -17,353 +22,243 @@ changed. If a newly connected disk has a VG with the same name as the VG containing the root filesystem, the machine may not boot correctly. When two VGs have the same name, the VG UUID can be used in place of the source VG name. +. .SH USAGE +. Rename a VG. .br .P \fBvgrename\fP \fIVG\fP \fIVG\fP\fI_new\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Rename a VG by specifying the VG UUID. .br .P \fBvgrename\fP \fIString\fP \fIVG\fP\fI_new\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-f\fP|\fB--force\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-f\fP|\fB--force\fP ... .br -.ad b Override various checks, confirmations and protections. Use with extreme caution. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH EXAMPLES - -Rename VG "vg02" to "myvg": -.br -.B vgrename "vg02" "myvg" - -Rename the VG with the specified UUID to "myvg". -.br -.B vgrename Zvlifi-Ep3t-e0Ng-U42h-o0ye-KHu1-nl7Ns4 myvg -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgs.8_pregen b/man/vgs.8_pregen index 2cf23764e..ffb4ddc41 100644 --- a/man/vgs.8_pregen +++ b/man/vgs.8_pregen @@ -1,327 +1,248 @@ .TH VGS 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgs - Display information about volume groups +. +vgs \(em Display information about volume groups . .SH SYNOPSIS +. \fBvgs\fP .br [ \fIoption_args\fP ] .br [ \fIposition_args\fP ] .br +. .SH DESCRIPTION +. vgs produces formatted output about VGs. +. .SH USAGE +. \fBvgs\fP .br .RS 4 .ad l [ \fB-a\fP|\fB--all\fP ] -.ad b .br -.ad l [ \fB-o\fP|\fB--options\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-S\fP|\fB--select\fP \fIString\fP ] -.ad b .br -.ad l [ \fB-O\fP|\fB--sort\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--aligned\fP ] -.ad b .br -.ad l [ \fB--binary\fP ] -.ad b .br -.ad l [ \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP ] -.ad b .br -.ad l [ \fB--foreign\fP ] -.ad b .br -.ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--logonly\fP ] -.ad b .br -.ad l [ \fB--nameprefixes\fP ] -.ad b .br -.ad l [ \fB--noheadings\fP ] -.ad b .br -.ad l [ \fB--nosuffix\fP ] -.ad b .br -.ad l [ \fB--readonly\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br -.ad l [ \fB--rows\fP ] -.ad b .br -.ad l [ \fB--separator\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--shared\fP ] -.ad b .br -.ad l [ \fB--unbuffered\fP ] -.ad b .br -.ad l -[ \fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP ] -.ad b +[ \fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy +] .br -.ad l [ \fB--unquoted\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br .RS 4 [ \fIVG\fP|\fITag\fP ... ] .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--aligned\fP .br -.ad b Use with --separator to align the output columns +. .HP -.ad l \fB-a\fP|\fB--all\fP .br -.ad b List all VGs. Equivalent to not specifying any VGs. +. .HP -.ad l \fB--binary\fP .br -.ad b Use binary values "0" or "1" instead of descriptive literal values for columns that have exactly two valid values to report (not counting the "unknown" value which denotes that the value could not be determined). +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB--configreport\fP \fBlog\fP|\fBvg\fP|\fBlv\fP|\fBpv\fP|\fBpvseg\fP|\fBseg\fP .br -.ad b See \fBlvmreport\fP(7). +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB--foreign\fP .br -.ad b Report/display foreign VGs that would otherwise be skipped. See \fBlvmsystemid\fP(7) for more information about foreign VGs. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--logonly\fP .br -.ad b Suppress command report and display only log report. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--nameprefixes\fP .br -.ad b Add an "LVM2_" prefix plus the field name to the output. Useful with --noheadings to produce a list of field=value pairs that can be used to set environment variables (for example, in udev rules). +. .HP -.ad l \fB--noheadings\fP .br -.ad b Suppress the headings line that is normally the first line of output. Useful if grepping the output. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--nosuffix\fP .br -.ad b Suppress the suffix on output sizes. Use with --units (except h and H) if processing the output. +. .HP -.ad l \fB-o\fP|\fB--options\fP \fIString\fP .br -.ad b Comma-separated, ordered list of fields to display in columns. -String arg syntax is: [+|-|#]Field1[,Field2 ...] +String arg syntax is: [\fB+\fP|\fB-\fP|\fB#\fP]\fIField1\fP[\fB,\fP\fIField2\fP ...] The prefix \fB+\fP will append the specified fields to the default fields, \fB-\fP will remove the specified fields from the default fields, and \fB#\fP will compact specified fields (removing them when empty for all rows.) @@ -335,55 +256,49 @@ Use field name \fBlv_all\fP to view all LV fields, \fBpvseg_all\fP all PV segment fields, \fBseg_all\fP all LV segment fields, and \fBpvseg_all\fP all PV segment columns. -See the lvm.conf report section for more config options. +See the \fBlvm.conf\fP(5) report section for more config options. See \fBlvmreport\fP(7) for more information about reporting. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--readonly\fP .br -.ad b Run the command in a special read-only mode which will read on-disk metadata without needing to take any locks. This can be used to peek inside metadata used by a virtual machine image while the virtual machine is running. No attempt will be made to communicate with the device-mapper kernel driver, so this option is unable to report whether or not LVs are actually in use. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB--rows\fP .br -.ad b Output columns as rows. +. .HP -.ad l \fB-S\fP|\fB--select\fP \fIString\fP .br -.ad b Select objects for processing and reporting based on specified criteria. The criteria syntax is described by \fB--select help\fP and \fBlvmreport\fP(7). For reporting commands, one row is displayed for each object matching the criteria. @@ -392,193 +307,117 @@ Rows can be displayed with an additional "selected" field (-o selected) showing 1 if the row matches the selection and 0 otherwise. For non-reporting commands which process LVM entities, the selection is used to choose items to process. +. .HP -.ad l \fB--separator\fP \fIString\fP .br -.ad b String to use to separate each column. Useful if grepping the output. +. .HP -.ad l \fB--shared\fP .br -.ad b Report/display shared VGs that would otherwise be skipped when lvmlockd is not being used on the host. See \fBlvmlockd\fP(8) for more information about shared VGs. +. .HP -.ad l \fB-O\fP|\fB--sort\fP \fIString\fP .br -.ad b Comma-separated ordered list of columns to sort by. Replaces the default selection. Precede any column with \fB-\fP for a reverse sort on that column. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB--unbuffered\fP .br -.ad b Produce output immediately without sorting or aligning the columns properly. +. .HP .ad l -\fB--units\fP \fBr\fP|\fBR\fP|\fBh\fP|\fBH\fP|\fBb\fP|\fBB\fP|\fBs\fP|\fBS\fP|\fBk\fP|\fBK\fP|\fBm\fP|\fBM\fP|\fBg\fP|\fBG\fP|\fBt\fP|\fBT\fP|\fBp\fP|\fBP\fP|\fBe\fP|\fBE\fP -.br +\fB--units\fP \c +.nh +\%[\fINumber\fP]\fBr\fP|\:\fBR\fP|\:\fBh\fP|\:\fBH\fP|\:\fBb\fP|\:\fBB\fP|\:\fBs\fP|\:\fBS\fP|\:\fBk\fP|\:\fBK\fP|\:\fBm\fP|\:\fBM\fP|\:\fBg\fP|\:\fBG\fP|\:\fBt\fP|\:\fBT\fP|\:\fBp\fP|\:\fBP\fP|\:\fBe\fP|\:\fBE\fP +.hy .ad b +.br All sizes are output in these units: human-(r)eadable with '<' rounding indicator, (h)uman-readable, (b)ytes, (s)ectors, (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. Capitalise to use multiples of 1000 (S.I.) instead of 1024. Custom units can be specified, e.g. --units 3M. +. .HP -.ad l \fB--unquoted\fP .br -.ad b When used with --nameprefixes, output values in the field=value pairs are not quoted. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fITag\fP -.br +.TP +.I Tag Tag name. See \fBlvm\fP(8) for information about tag names and using tags in place of a VG, LV or PV. -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH NOTES -. -The vg_attr bits are: -.IP 1 3 -Permissions: (w)riteable, (r)ead-only -.IP 2 3 -Resi(z)eable -.IP 3 3 -E(x)ported -.IP 4 3 -(p)artial: one or more physical volumes belonging to the volume group -are missing from the system -.IP 5 3 -Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere -.IP 6 3 -(c)lustered, (s)hared -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgscan.8_pregen b/man/vgscan.8_pregen index 40145b078..959e16190 100644 --- a/man/vgscan.8_pregen +++ b/man/vgscan.8_pregen @@ -1,343 +1,242 @@ .TH VGSCAN 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgscan - Search for all volume groups +. +vgscan \(em Search for all volume groups . .SH SYNOPSIS +. \fBvgscan\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgscan scans all supported LVM block devices in the system for VGs. +. .SH USAGE +. \fBvgscan\fP .br .RS 4 .ad l [ \fB--ignorelockingfailure\fP ] -.ad b .br -.ad l [ \fB--mknodes\fP ] -.ad b .br -.ad l [ \fB--notifydbus\fP ] -.ad b .br -.ad l [ \fB--reportformat\fP \fBbasic\fP|\fBjson\fP ] -.ad b .br [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--ignorelockingfailure\fP .br -.ad b Allows a command to continue with read-only metadata operations after locking failures. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB--mknodes\fP .br -.ad b Also checks the LVM special files in /dev that are needed for active LVs and creates any missing ones and removes unused ones. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--notifydbus\fP .br -.ad b Send a notification to D-Bus. The command will exit with an error if LVM is not built with support for D-Bus notification, or if the notify_dbus config setting is disabled. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB--reportformat\fP \fBbasic\fP|\fBjson\fP .br -.ad b Overrides current output format for reports which is defined globally by -the report/output_format setting in lvm.conf. +the report/output_format setting in \fBlvm.conf\fP(5). \fBbasic\fP is the original format with columns and rows. If there is more than one report per command, each report is prefixed with the report name for identification. \fBjson\fP produces report output in JSON format. See \fBlvmreport\fP(7) for more information. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIString\fP -.br +. +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7) diff --git a/man/vgsplit.8_pregen b/man/vgsplit.8_pregen index c4721b9ba..331c6e491 100644 --- a/man/vgsplit.8_pregen +++ b/man/vgsplit.8_pregen @@ -1,156 +1,128 @@ .TH VGSPLIT 8 "LVM TOOLS #VERSION#" "Red Hat, Inc." +. .SH NAME -vgsplit - Move physical volumes into a new or existing volume group +. +vgsplit \(em Move physical volumes into a new or existing volume group . .SH SYNOPSIS +. \fBvgsplit\fP \fIoption_args\fP \fIposition_args\fP .br [ \fIoption_args\fP ] .br +. .SH DESCRIPTION +. vgsplit moves one or more PVs from a source VG (the first VG arg) to a destination VG (the second VG arg). The PV(s) to move are named after the source and destination VGs, or an LV is named, in which case the PVs underlying the LV are moved. - +.P If the destination VG does not exist, a new VG is created (command options can be used to specify properties of the new VG, also see -\fBvgcreate\fP(8).) - +\fBvgcreate\fP(8)). +.P LVs cannot be split between VGs; each LV must be entirely on the PVs in the source or destination VG. - +.P vgsplit can only move complete PVs. (See \fBpvmove\fP(8) for moving part of a PV.) +. .SH USAGE +. Split a VG by specified PVs. .br .P \fBvgsplit\fP \fIVG\fP \fIVG\fP \fIPV\fP ... .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Split a VG by PVs in a specified LV. .br .P \fBvgsplit\fP \fB-n\fP|\fB--name\fP \fILV\fP \fIVG\fP \fIVG\fP .br .RS 4 +.ad l [ COMMON_OPTIONS ] +.ad b .RE -.br - +.P Common options for command: . .RS 4 .ad l [ \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB-l\fP|\fB--maxlogicalvolumes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP ] -.ad b .br -.ad l [ \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP ] -.ad b .br -.ad l -[ \fB--alloc\fP +[ \fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy ] -.ad b .br -.ad l -[ \fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP ] +[ \fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP ] .ad b .RE - +.P Common options for lvm: . .RS 4 .ad l [ \fB-d\fP|\fB--debug\fP ] -.ad b .br -.ad l [ \fB-h\fP|\fB--help\fP ] -.ad b .br -.ad l [ \fB-q\fP|\fB--quiet\fP ] -.ad b .br -.ad l [ \fB-t\fP|\fB--test\fP ] -.ad b .br -.ad l [ \fB-v\fP|\fB--verbose\fP ] -.ad b .br -.ad l [ \fB-y\fP|\fB--yes\fP ] -.ad b .br -.ad l [ \fB--commandprofile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--config\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--devices\fP \fIPV\fP ] -.ad b .br -.ad l [ \fB--devicesfile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--driverloaded\fP \fBy\fP|\fBn\fP ] -.ad b .br -.ad l [ \fB--lockopt\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--longhelp\fP ] -.ad b .br -.ad l [ \fB--nolocking\fP ] -.ad b .br -.ad l [ \fB--profile\fP \fIString\fP ] -.ad b .br -.ad l [ \fB--version\fP ] .ad b .RE +. .SH OPTIONS +. +. .HP .ad l -\fB--alloc\fP +\fB--alloc\fP \c .nh -\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP +\%\fBcontiguous\fP|\:\fBcling\fP|\:\fBcling_by_tags\fP|\:\fBnormal\fP|\:\fBanywhere\fP|\:\fBinherit\fP .hy -.br .ad b +.br Determines the allocation policy when a command needs to allocate Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy which can be changed with vgchange/lvchange, or overridden on the @@ -167,157 +139,136 @@ e.g. by placing two stripes on the same PV. Optional positional PV args on the command line can also be used to limit which PVs the command will use for allocation. See \fBlvm\fP(8) for more information about allocation. +. .HP -.ad l \fB-A\fP|\fB--autobackup\fP \fBy\fP|\fBn\fP .br -.ad b Specifies if metadata should be backed up automatically after a change. Enabling this is strongly advised! See \fBvgcfgbackup\fP(8) for more information. +. .HP -.ad l \fB--commandprofile\fP \fIString\fP .br -.ad b The command profile to use for command configuration. See \fBlvm.conf\fP(5) for more information about profiles. +. .HP -.ad l \fB--config\fP \fIString\fP .br -.ad b -Config settings for the command. These override lvm.conf settings. -The String arg uses the same format as lvm.conf, +Config settings for the command. These override \fBlvm.conf\fP(5) settings. +The String arg uses the same format as \fBlvm.conf\fP(5), or may use section/field syntax. See \fBlvm.conf\fP(5) for more information about config. +. .HP -.ad l \fB-d\fP|\fB--debug\fP ... .br -.ad b Set debug level. Repeat from 1 to 6 times to increase the detail of messages sent to the log file and/or syslog (if configured). +. .HP -.ad l \fB--devices\fP \fIPV\fP .br -.ad b Devices that the command can use. This option can be repeated or accepts a comma separated list of devices. This overrides the devices file. +. .HP -.ad l \fB--devicesfile\fP \fIString\fP .br -.ad b A file listing devices that LVM should use. -The file must exist in /etc/lvm/devices/ and is managed -with the lvmdevices(8) command. -This overrides the lvm.conf devices/devicesfile and -devices/use_devicesfile settings. +The file must exist in \fI#DEFAULT_SYS_DIR#/devices/\fP and is managed +with the \fBlvmdevices\fP(8) command. +This overrides the \fBlvm.conf\fP(5) \fBdevices/devicesfile\fP and +\fBdevices/use_devicesfile\fP settings. +. .HP -.ad l \fB--driverloaded\fP \fBy\fP|\fBn\fP .br -.ad b If set to no, the command will not attempt to use device-mapper. For testing and debugging. +. .HP -.ad l \fB-h\fP|\fB--help\fP .br -.ad b Display help text. +. .HP -.ad l \fB--lockopt\fP \fIString\fP .br -.ad b Used to pass options for special cases to lvmlockd. See \fBlvmlockd\fP(8) for more information. +. .HP -.ad l \fB--longhelp\fP .br -.ad b Display long help text. +. .HP -.ad l \fB-l\fP|\fB--maxlogicalvolumes\fP \fINumber\fP .br -.ad b Sets the maximum number of LVs allowed in a VG. +. .HP -.ad l \fB-p\fP|\fB--maxphysicalvolumes\fP \fINumber\fP .br -.ad b Sets the maximum number of PVs that can belong to the VG. The value 0 removes any limitation. For large numbers of PVs, also see options --pvmetadatacopies, and --vgmetadatacopies for improving performance. +. .HP -.ad l \fB-M\fP|\fB--metadatatype\fP \fBlvm2\fP .br -.ad b Specifies the type of on-disk metadata to use. \fBlvm2\fP (or just \fB2\fP) is the current, standard format. \fBlvm1\fP (or just \fB1\fP) is no longer used. +. .HP -.ad l \fB-n\fP|\fB--name\fP \fIString\fP .br -.ad b Move only PVs used by the named LV. +. .HP -.ad l \fB--nolocking\fP .br -.ad b Disable locking. +. .HP -.ad l \fB--profile\fP \fIString\fP .br -.ad b An alias for --commandprofile or --metadataprofile, depending on the command. +. .HP -.ad l \fB-q\fP|\fB--quiet\fP ... .br -.ad b Suppress output and log messages. Overrides --debug and --verbose. Repeat once to also suppress any prompts with answer 'no'. +. .HP -.ad l \fB-t\fP|\fB--test\fP .br -.ad b Run in test mode. Commands will not update metadata. This is implemented by disabling all metadata writing but nevertheless returning success to the calling function. This may lead to unusual error messages in multi-stage operations if a tool relies on reading back metadata it believes has changed but hasn't. +. .HP -.ad l \fB-v\fP|\fB--verbose\fP ... .br -.ad b Set verbose level. Repeat from 1 to 4 times to increase the detail of messages sent to stdout and stderr. +. .HP -.ad l \fB--version\fP .br -.ad b Display version information. +. .HP -.ad l -\fB--[vg]metadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP +\fB--\fP[\fBvg\fP]\fBmetadatacopies\fP \fBall\fP|\fBunmanaged\fP|\fINumber\fP .br -.ad b Number of copies of the VG metadata that are kept. VG metadata is kept in VG metadata areas on PVs in the VG, i.e. reserved space at the start and/or end of the PVs. @@ -331,22 +282,21 @@ The number can also be replaced with special string values: metadataignore flags. \fBall\fP causes LVM to first clear the metadataignore flags on all PVs, and then to become unmanaged. +. .HP -.ad l \fB-y\fP|\fB--yes\fP .br -.ad b Do not prompt for confirmation interactively but always assume the answer yes. Use with extreme caution. (For automatic no, see -qq.) +. .SH VARIABLES -.HP -\fIVG\fP -.br +. +.TP +.I VG Volume Group name. See \fBlvm\fP(8) for valid names. -.HP -\fIPV\fP -.br +.TP +.I PV Physical Volume name, a device path under /dev. For commands managing physical extents, a PV positional arg generally accepts a suffix indicating a range (or multiple ranges) @@ -354,91 +304,36 @@ of physical extents (PEs). When the first PE is omitted, it defaults to the start of the device, and when the last PE is omitted it defaults to end. Start and end range (inclusive): \fIPV\fP[\fB:\fP\fIPE\fP\fB-\fP\fIPE\fP]... Start and length range (counting from 0): \fIPV\fP[\fB:\fP\fIPE\fP\fB+\fP\fIPE\fP]... -.HP -\fIString\fP -.br +.TP +.I String See the option description for information about the string content. -.HP -\fISize\fP[UNIT] -.br +.TP +.IR Size [UNIT] Size is an input number that accepts an optional unit. Input units are always treated as base two values, regardless of capitalization, e.g. 'k' and 'K' both refer to 1024. The default input unit is specified by letter, followed by |UNIT. -UNIT represents other possible input units: \fBbBsSkKmMgGtTpPeE\fP. -b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB, -m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB. +UNIT represents other possible input units: +.BR b | B +is bytes, +.BR s | S +is sectors of 512 bytes, +.BR k | K +is KiB, +.BR m | M +is MiB, +.BR g | G +is GiB, +.BR t | T +is TiB, +.BR p | P +is PiB, +.BR e | E +is EiB. (This should not be confused with the output control --units, where capital letters mean multiple of 1000.) +. .SH ENVIRONMENT VARIABLES +. See \fBlvm\fP(8) for information about environment variables used by lvm. For example, LVM_VG_NAME can generally be substituted for a required VG parameter. -.SH SEE ALSO -.nh -.ad l -.BR lvm (8), -.BR lvm.conf (5), -.BR lvmconfig (8), -.BR lvmdevices (8), - -.BR pvchange (8), -.BR pvck (8), -.BR pvcreate (8), -.BR pvdisplay (8), -.BR pvmove (8), -.BR pvremove (8), -.BR pvresize (8), -.BR pvs (8), -.BR pvscan (8), - -.BR vgcfgbackup (8), -.BR vgcfgrestore (8), -.BR vgchange (8), -.BR vgck (8), -.BR vgcreate (8), -.BR vgconvert (8), -.BR vgdisplay (8), -.BR vgexport (8), -.BR vgextend (8), -.BR vgimport (8), -.BR vgimportclone (8), -.BR vgimportdevices (8), -.BR vgmerge (8), -.BR vgmknodes (8), -.BR vgreduce (8), -.BR vgremove (8), -.BR vgrename (8), -.BR vgs (8), -.BR vgscan (8), -.BR vgsplit (8), - -.BR lvcreate (8), -.BR lvchange (8), -.BR lvconvert (8), -.BR lvdisplay (8), -.BR lvextend (8), -.BR lvreduce (8), -.BR lvremove (8), -.BR lvrename (8), -.BR lvresize (8), -.BR lvs (8), -.BR lvscan (8), - -.BR lvm-fullreport (8), -.BR lvm-lvpoll (8), -.BR lvm2-activation-generator (8), -.BR blkdeactivate (8), -.BR lvmdump (8), - -.BR dmeventd (8), -.BR lvmpolld (8), -.BR lvmlockd (8), -.BR lvmlockctl (8), -.BR cmirrord (8), -.BR lvmdbusd (8), - -.BR lvmsystemid (7), -.BR lvmreport (7), -.BR lvmraid (7), -.BR lvmthin (7), -.BR lvmcache (7)

3 years

1
0
0 / 0

main - man: replace empty lines

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=d1f8978ac5adbe7274f... Commit: d1f8978ac5adbe7274faa62011dbb30a95719191 Parent: 5f75f5e2bc0f10c74151914aa59264d29815d9ba Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Fri Apr 16 15:57:01 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:54:37 2021 +0200 man: replace empty lines --- man/lvchange.8_end | 4 +++- man/lvconvert.8_des | 28 ++++++++++++++-------------- man/lvconvert.8_end | 44 ++++++++++++++++++++++++-------------------- man/lvcreate.8_des | 22 +++++++++++----------- man/lvcreate.8_end | 38 ++++++++++++++++++++------------------ man/lvdisplay.8_des | 2 +- man/lvextend.8_des | 6 +++--- man/lvextend.8_end | 6 ++++-- man/lvm-lvpoll.8_end | 16 +++++++++------- man/lvm.8_main | 2 +- man/lvmdevices.8_des | 23 +++++++++++------------ man/lvmdiskscan.8_des | 3 +-- man/lvreduce.8_des | 6 +++--- man/lvreduce.8_end | 3 ++- man/lvremove.8_des | 10 +++++----- man/lvremove.8_end | 4 +++- man/lvrename.8_end | 5 +++-- man/lvresize.8_des | 2 +- man/lvresize.8_end | 3 ++- man/lvs.8_end | 1 + man/pvchange.8_des | 2 +- man/pvchange.8_end | 3 ++- man/pvck.8_des | 47 +++++++++++++++++++++++------------------------ man/pvck.8_end | 3 ++- man/pvcreate.8_des | 24 ++++++++++++------------ man/pvcreate.8_end | 5 +++-- man/pvdisplay.8_des | 2 +- man/pvmove.8_des | 4 ++-- man/pvmove.8_end | 38 ++++++++++++++++++++------------------ man/pvremove.8_des | 4 ++-- man/pvresize.8_end | 6 +++++- man/pvs.8_end | 1 + man/pvscan.8_des | 33 ++++++++++++++++----------------- man/vgcfgbackup.8_des | 8 ++++---- man/vgcfgrestore.8_des | 4 ++-- man/vgcfgrestore.8_end | 3 ++- man/vgchange.8_end | 6 +++++- man/vgcreate.8_des | 3 +-- man/vgcreate.8_end | 3 ++- man/vgdisplay.8_des | 2 +- man/vgexport.8_des | 8 ++++---- man/vgextend.8_des | 4 ++-- man/vgextend.8_end | 3 ++- man/vgimport.8_des | 2 +- man/vgimportclone.8_des | 2 +- man/vgimportclone.8_end | 3 ++- man/vgimportdevices.8_des | 3 +-- man/vgmerge.8_end | 3 ++- man/vgmknodes.8_des | 2 +- man/vgremove.8_des | 4 ++-- man/vgrename.8_des | 2 +- man/vgrename.8_end | 5 +++-- man/vgs.8_end | 1 + man/vgsplit.8_des | 8 ++++---- 54 files changed, 256 insertions(+), 223 deletions(-) diff --git a/man/lvchange.8_end b/man/lvchange.8_end index e3087d7fc..e6d44c52f 100644 --- a/man/lvchange.8_end +++ b/man/lvchange.8_end @@ -1,4 +1,6 @@ +. .SH EXAMPLES +. Change LV permission to read-only: -.sp +.br .B lvchange -pr vg00/lvol1 diff --git a/man/lvconvert.8_des b/man/lvconvert.8_des index cc233fb1d..f36135f21 100644 --- a/man/lvconvert.8_des +++ b/man/lvconvert.8_des @@ -1,42 +1,42 @@ lvconvert changes the LV type and includes utilities for LV data maintenance. The LV type controls data layout and redundancy. The LV type is also called the segment type or segtype. - +.P To display the current LV type, run the command: - +.P .B lvs -o name,segtype .I LV - +.P In some cases, an LV is a single device mapper (dm) layer above physical devices. In other cases, hidden LVs (dm devices) are layered between the visible LV and physical devices. LVs in the middle layers are called sub LVs. A command run on a visible LV sometimes operates on a sub LV rather than the specified LV. In other cases, a sub LV must be specified directly on the command line. - +.P Sub LVs can be displayed with the command: - +.P .B lvs -a - +.P The .B linear type is equivalent to the .B striped type when one stripe exists. In that case, the types can sometimes be used interchangably. - +.P In most cases, the .B mirror type is deprecated and the .B raid1 type should be used. They are both implementations of mirroring. - +.P Striped raid types are \fBraid0/raid0_meta\fP, \fBraid5\fP (an alias for raid5_ls), \fBraid6\fP (an alias for raid6_zr) and \fBraid10\fP (an alias for raid10_near). - +.P As opposed to mirroring, raid5 and raid6 stripe data and calculate parity blocks. The parity blocks can be used for data block recovery in case devices fail. A maximum number of one device in a raid5 LV may fail, and @@ -45,27 +45,27 @@ data blocks for performance reasons, thus avoiding contention on a single device. Specific arrangements of parity and data blocks (layouts) can be used to optimize I/O performance, or to convert between raid levels. See \fBlvmraid\fP(7) for more information. - +.P Layouts of raid5 rotating parity blocks can be: left-asymmetric (raid5_la), left-symmetric (raid5_ls with alias raid5), right-asymmetric (raid5_ra), right-symmetric (raid5_rs) and raid5_n, which doesn't rotate parity blocks. Layouts of raid6 are: zero-restart (raid6_zr with alias raid6), next-restart (raid6_nr), and next-continue (raid6_nc). - +.P Layouts including _n allow for conversion between raid levels (raid5_n to raid6 or raid5_n to striped/raid0/raid0_meta). Additionally, special raid6 layouts for raid level conversions between raid5 and raid6 are: raid6_ls_6, raid6_rs_6, raid6_la_6 and raid6_ra_6. Those correspond to their raid5 counterparts (e.g. raid5_rs can be directly converted to raid6_rs_6 and vice-versa). - +.P raid10 (an alias for raid10_near) is currently limited to one data copy and even number of sub LVs. This is a mirror group layout, thus a single sub LV may fail per mirror group without data loss. - +.P Striped raid types support converting the layout, their stripesize and their number of stripes. - +.P The striped raid types combined with raid1 allow for conversion from linear \[->] striped/raid0/raid0_meta and vice-versa by e.g. linear \[<>] raid1 \[<>] raid5_n (then adding stripes) \[<>] striped/raid0/raid0_meta. diff --git a/man/lvconvert.8_end b/man/lvconvert.8_end index 1087c6ed4..97495067c 100644 --- a/man/lvconvert.8_end +++ b/man/lvconvert.8_end @@ -1,4 +1,6 @@ +. .SH NOTES +. This previous command syntax would perform two different operations: .br \fBlvconvert --thinpool\fP \fILV1\fP \fB--poolmetadata\fP \fILV2\fP @@ -7,7 +9,7 @@ If LV1 was not a thin pool, the command would convert LV1 to a thin pool, optionally using a specified LV for metadata. But, if LV1 was already a thin pool, the command would swap the current metadata LV with LV2 (for repair purposes.) - +.P In the same way, this previous command syntax would perform two different operations: .br @@ -17,74 +19,76 @@ If LV1 was not a cache pool, the command would convert LV1 to a cache pool, optionally using a specified LV for metadata. But, if LV1 was already a cache pool, the command would swap the current metadata LV with LV2 (for repair purposes.) +. .SH EXAMPLES +. Convert a linear LV to a two-way mirror LV. .br .B lvconvert --type mirror --mirrors 1 vg/lvol1 - +.P Convert a linear LV to a two-way RAID1 LV. .br .B lvconvert --type raid1 --mirrors 1 vg/lvol1 - +.P Convert a mirror LV to use an in-memory log. .br .B lvconvert --mirrorlog core vg/lvol1 - +.P Convert a mirror LV to use a disk log. .br .B lvconvert --mirrorlog disk vg/lvol1 - +.P Convert a mirror or raid1 LV to a linear LV. .br .B lvconvert --type linear vg/lvol1 - +.P Convert a mirror LV to a raid1 LV with the same number of images. .br .B lvconvert --type raid1 vg/lvol1 - +.P Convert a linear LV to a two-way mirror LV, allocating new extents from specific PV ranges. .br .B lvconvert --mirrors 1 vg/lvol1 /dev/sda:0-15 /dev/sdb:0-15 - +.P Convert a mirror LV to a linear LV, freeing physical extents from a specific PV. .br .B lvconvert --type linear vg/lvol1 /dev/sda - +.P Split one image from a mirror or raid1 LV, making it a new LV. .br .B lvconvert --splitmirrors 1 --name lv_split vg/lvol1 - +.P Split one image from a raid1 LV, and track changes made to the raid1 LV while the split image remains detached. .br .B lvconvert --splitmirrors 1 --trackchanges vg/lvol1 - +.P Merge an image (that was previously created with --splitmirrors and --trackchanges) back into the original raid1 LV. .br .B lvconvert --mergemirrors vg/lvol1_rimage_1 - +.P Replace PV /dev/sdb1 with PV /dev/sdf1 in a raid1/4/5/6/10 LV. .br .B lvconvert --replace /dev/sdb1 vg/lvol1 /dev/sdf1 - +.P Replace 3 PVs /dev/sd[b-d]1 with PVs /dev/sd[f-h]1 in a raid1 LV. .br .B lvconvert --replace /dev/sdb1 --replace /dev/sdc1 --replace /dev/sdd1 .RS .B vg/lvol1 /dev/sd[fgh]1 .RE - +.P Replace the maximum of 2 PVs /dev/sd[bc]1 with PVs /dev/sd[gh]1 in a raid6 LV. .br .B lvconvert --replace /dev/sdb1 --replace /dev/sdc1 vg/lvol1 /dev/sd[gh]1 - +.P Convert an LV into a thin LV in the specified thin pool. The existing LV is used as an external read-only origin for the new thin LV. .br .B lvconvert --type thin --thinpool vg/tpool1 vg/lvol1 - +.P Convert an LV into a thin LV in the specified thin pool. The existing LV is used as an external read-only origin for the new thin LV, and is renamed "external". @@ -93,20 +97,20 @@ renamed "external". .RS .B --originname external vg/lvol1 .RE - +.P Convert an LV to a cache pool LV using another specified LV for cache pool metadata. .br .B lvconvert --type cache-pool --poolmetadata vg/poolmeta1 vg/lvol1 - +.P Convert an LV to a cache LV using the specified cache pool and chunk size. .br .B lvconvert --type cache --cachepool vg/cpool1 -c 128 vg/lvol1 - +.P Detach and keep the cache pool from a cache LV. .br .B lvconvert --splitcache vg/lvol1 - +.P Detach and remove the cache pool from a cache LV. .br .B lvconvert --uncache vg/lvol1 diff --git a/man/lvcreate.8_des b/man/lvcreate.8_des index 7bb2bb61a..4f7e712fe 100644 --- a/man/lvcreate.8_des +++ b/man/lvcreate.8_des @@ -2,45 +2,45 @@ lvcreate creates a new LV in a VG. For standard LVs, this requires allocating logical extents from the VG's free physical extents. If there is not enough free space, the VG can be extended with other PVs (\fBvgextend\fP(8)), or existing LVs can be reduced or removed -(\fBlvremove\fP(8), \fBlvreduce\fP(8).) - +(\fBlvremove\fP(8), \fBlvreduce\fP(8)). +.P To control which PVs a new LV will use, specify one or more PVs as position args at the end of the command line. lvcreate will allocate physical extents only from the specified PVs. - +.P lvcreate can also create snapshots of existing LVs, e.g. for backup purposes. The data in a new snapshot LV represents the content of the original LV from the time the snapshot was created. - +.P RAID LVs can be created by specifying an LV type when creating the LV (see \fBlvmraid\fP(7)). Different RAID levels require different numbers of unique PVs be available in the VG for allocation. - +.P Thin pools (for thin provisioning) and cache pools (for caching) are represented by special LVs with types thin-pool and cache-pool (see \fBlvmthin\fP(7) and \fBlvmcache\fP(7)). The pool LVs are not usable as standard block devices, but the LV names act as references to the pools. - +.P Thin LVs are thinly provisioned from a thin pool, and are created with a virtual size rather than a physical size. A cache LV is the combination of a standard LV with a cache pool, used to cache active portions of the LV to improve performance. - +.P VDO LVs are also provisioned volumes from a VDO pool, and are created with a virtual size rather than a physical size (see \fBlvmvdo\fP(7)). - +.P .SS Usage notes In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See descriptions in the options section. - +.P In the usage section below, \fB--name\fP is omitted from the required options, even though it is typically used. When the name is not specified, a new LV name is generated with the "lvol" prefix and a unique numeric suffix. - +.P In the usage section below, when creating a pool and the name is omitted the new LV pool name is generated with the "vpool" for vdo-pools for prefix and a unique numeric suffix. - +.P Pool name can be specified together with \fIVG\fP name i.e.: vg00/mythinpool. diff --git a/man/lvcreate.8_end b/man/lvcreate.8_end index 9be3426da..30e862d83 100644 --- a/man/lvcreate.8_end +++ b/man/lvcreate.8_end @@ -1,50 +1,52 @@ +. .SH EXAMPLES - +. +.P Create a striped LV with 3 stripes, a stripe size of 8KiB and a size of 100MiB. The LV name is chosen by lvcreate. .br .B lvcreate -i 3 -I 8 -L 100m vg00 - +.P Create a raid1 LV with two images, and a useable size of 500 MiB. This operation requires two devices, one for each mirror image. RAID metadata (superblock and bitmap) is also included on the two devices. .br .B lvcreate --type raid1 -m1 -L 500m -n mylv vg00 - +.P Create a mirror LV with two images, and a useable size of 500 MiB. This operation requires three devices: two for mirror images and one for a disk log. .br .B lvcreate --type mirror -m1 -L 500m -n mylv vg00 - +.P Create a mirror LV with 2 images, and a useable size of 500 MiB. This operation requires 2 devices because the log is in memory. .br .B lvcreate --type mirror -m1 --mirrorlog core -L 500m -n mylv vg00 - +.P Create a copy-on-write snapshot of an LV: .br .B lvcreate --snapshot --size 100m --name mysnap vg00/mylv - +.P Create a copy-on-write snapshot with a size sufficient for overwriting 20% of the size of the original LV. .br .B lvcreate -s -l 20%ORIGIN -n mysnap vg00/mylv - +.P Create a sparse LV with 1TiB of virtual space, and actual space just under 100MiB. .br .B lvcreate --snapshot --virtualsize 1t --size 100m --name mylv vg00 - +.P Create a linear LV with a usable size of 64MiB on specific physical extents. .br .B lvcreate -L 64m -n mylv vg00 /dev/sda:0-7 /dev/sdb:0-7 - +.P Create a RAID5 LV with a usable size of 5GiB, 3 stripes, a stripe size of 64KiB, using a total of 4 devices (including one for parity). .br .B lvcreate --type raid5 -L 5G -i 3 -I 64 -n mylv vg00 - +.P Create a RAID5 LV using all of the free space in the VG and spanning all the PVs in the VG (note that the command will fail if there are more than 8 PVs in the VG, in which case \fB-i 7\fP must be used to get to the current maximum of @@ -54,7 +56,7 @@ the VG, in which case \fB-i 7\fP must be used to get to the current maximum of .RS .B --type raid5 -l 100%FREE -n mylv vg00 .RE - +.P Create RAID10 LV with a usable size of 5GiB, using 2 stripes, each on a two-image mirror. (Note that the \fB-i\fP and \fB-m\fP arguments behave differently: @@ -63,11 +65,11 @@ but \fB-m\fP specifies the number of images in addition to the first image). .br .B lvcreate --type raid10 -L 5G -i 2 -m 1 -n mylv vg00 - +.P Create a 1TiB thin LV mythin, with 256GiB thinpool tpool0 in vg00. .br .B lvcreate -T -V 1T --size 256G --name mythin vg00/tpool0 - +.P Create a 1TiB thin LV, first creating a new thin pool for it, where the thin pool has 100MiB of space, uses 2 stripes, has a 64KiB stripe size, and 256KiB chunk size. @@ -76,22 +78,22 @@ size, and 256KiB chunk size. .RS .B -V 1t -L 100m -i 2 -I 64 -c 256 vg00 .RE - +.P Create a thin snapshot of a thin LV (the size option must not be used, otherwise a copy-on-write snapshot would be created). .br .B lvcreate --snapshot --name mysnap vg00/thinvol - +.P Create a thin snapshot of the read-only inactive LV named "origin" which becomes an external origin for the thin snapshot LV. .br .B lvcreate --snapshot --name mysnap --thinpool mypool vg00/origin - +.P Create a cache pool from a fast physical device. The cache pool can then be used to cache an LV. .br .B lvcreate --type cache-pool -L 1G -n my_cpool vg00 /dev/fast1 - +.P Create a cache LV, first creating a new origin LV on a slow physical device, then combining the new origin LV with an existing cache pool. .br @@ -99,7 +101,7 @@ then combining the new origin LV with an existing cache pool. .RS .B -L 100G -n mylv vg00 /dev/slow1 .RE - +.P Create a VDO LV vdo0 with VDOPoolLV size of 10GiB and name vpool1. .br .B lvcreate --vdo --size 10G --name vdo0 vg00/vpool1 diff --git a/man/lvdisplay.8_des b/man/lvdisplay.8_des index 48552cc95..ee004b185 100644 --- a/man/lvdisplay.8_des +++ b/man/lvdisplay.8_des @@ -1,5 +1,5 @@ lvdisplay shows the attributes of LVs, like size, read/write status, snapshot information, etc. - +.P \fBlvs\fP(8) is a preferred alternative that shows the same information and more, using a more compact and configurable output format. diff --git a/man/lvextend.8_des b/man/lvextend.8_des index eafd24755..6fc6a8ddd 100644 --- a/man/lvextend.8_des +++ b/man/lvextend.8_des @@ -1,12 +1,12 @@ lvextend extends the size of an LV. This requires allocating logical extents from the VG's free physical extents. If the extension adds a new LV segment, the new segment will use the existing segment type of the LV. - +.P Extending a copy-on-write snapshot LV adds space for COW blocks. - +.P Use \fBlvconvert\fP(8) to change the number of data images in a RAID or mirrored LV. - +.P In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See both descriptions the options section. diff --git a/man/lvextend.8_end b/man/lvextend.8_end index af24d4f80..3cffe1d25 100644 --- a/man/lvextend.8_end +++ b/man/lvextend.8_end @@ -1,14 +1,16 @@ +. .SH EXAMPLES +. Extend the size of an LV by 54MiB, using a specific PV. .br .B lvextend -L +54 vg01/lvol10 /dev/sdk3 - +.P Extend the size of an LV by the amount of free space on PV /dev/sdk3. This is equivalent to specifying "-l +100%PVS" on the command line. .br .B lvextend vg01/lvol01 /dev/sdk3 - +.P Extend an LV by 16MiB using specific physical extents. .br .B lvextend -L+16m vg01/lvol01 /dev/sda:8-9 /dev/sdb:8-9 diff --git a/man/lvm-lvpoll.8_end b/man/lvm-lvpoll.8_end index d38dfd0f3..6706a3e8f 100644 --- a/man/lvm-lvpoll.8_end +++ b/man/lvm-lvpoll.8_end @@ -1,31 +1,33 @@ +. .SH NOTES - +. To find the name of the pvmove LV that was created by an original \fBpvmove /dev/name\fP command, use the command: .br \fBlvs -a -S move_pv=/dev/name\fP. +. .SH EXAMPLES - +. Continue polling a pvmove operation. .br .B lvm lvpoll --polloperation pvmove vg00/pvmove0 - +.P Abort a pvmove operation. .br .B lvm lvpoll --polloperation pvmove --abort vg00/pvmove0 - +.P Continue polling a mirror conversion. .br .B lvm lvpoll --polloperation convert vg00/lvmirror - +.P Continue mirror repair. .br .B lvm lvpoll --polloperation convert vg/damaged_mirror --handlemissingpvs - +.P Continue snapshot merge. .br .B lvm lvpoll --polloperation merge vg/snapshot_old - +.P Continue thin snapshot merge. .br .B lvm lvpoll --polloperation merge_thin vg/thin_snapshot diff --git a/man/lvm.8_main b/man/lvm.8_main index 509a635ef..234442e64 100644 --- a/man/lvm.8_main +++ b/man/lvm.8_main @@ -328,7 +328,7 @@ UUID of the intended VG: --select vg_uuid=<uuid> .P An exception is if all but one of the VGs with the shared name is foreign (see -.BR lvmsystemid (7).) +.BR lvmsystemid (7)). In this case, the one VG that is not foreign is assumed to be the intended VG and is processed. .P diff --git a/man/lvmdevices.8_des b/man/lvmdevices.8_des index 52885fb59..015aa1122 100644 --- a/man/lvmdevices.8_des +++ b/man/lvmdevices.8_des @@ -2,18 +2,18 @@ The LVM devices file lists devices that lvm can use. The default file is \fI#DEFAULT_SYS_DIR#/devices/system.devices\fP, and the \fBlvmdevices\fP(8) command is used to add or remove device entries. If the file does not exist, or if lvm.conf includes use_devicesfile=0, then lvm will not use a devices file. - +.P To use a device with lvm, add it to the devices file with the command lvmdevices --adddev, and to prevent lvm from seeing or using a device, remove it from the devices file with lvmdevices --deldev. The vgimportdevices(8) command adds all PVs from a VG to the devices file, and updates the VG metadata to include device IDs of the PVs. - +.P Commands adding new devices to the devices file necessarily look outside the existing devices file to find the devices to add. pvcreate, vgcreate, and vgextend also look outside the devices file to create new PVs and add them to the devices file. - +.P LVM records devices in the devices file using hardware-specific IDs, such as the WWID, and attempts to use subsystem-specific IDs for virtual device types (which also aim to be as unique and stable as possible.) @@ -21,42 +21,41 @@ These device IDs are also written in the VG metadata. When no hardware or virtual ID is available, lvm falls back using the unstable device name as the device ID. When devnames are used, lvm performs extra scanning to find devices if their devname changes, e.g. after reboot. - +.P When proper device IDs are used, an lvm command will not look at devices outside the devices file, but when devnames are used as a fallback, lvm will scan devices outside the devices file to locate PVs on renamed devices. A config setting search_for_devnames can be used to control the scanning for renamed devname entries. - +.P Related to the devices file, the new command option --devices <devnames> allows a list of devices to be specified for the command to use, overriding the devices file. The listed devices act as a sort of devices file in terms of limiting which devices lvm will see and use. Devices that are not listed will appear to be missing to the lvm command. - +.P Multiple devices files can be kept in \fI#DEFAULT_SYS_DIR#/devices\fP, which allows lvm to be used with different sets of devices, e.g. system devices do not need to be exposed to a specific application, and the application can use lvm on its own devices that are not exposed to the system. The option --devicesfile <filename> is used to select the devices file to use with the command. Without the option set, the default system devices file is used. - +.P Setting --devicesfile "" causes lvm to not use a devices file. - +.P With no devices file, lvm will use any device on the system, and applies the filter to limit the full set of system devices. With a devices file, the regex filter is not used, and the filter settings in lvm.conf or the command line are ignored. The vgimportdevices command is one exception which does apply the regex filter when looking for a VG to import. - +.P If a devices file exists, lvm will use it, even if it's empty. An empty devices file means lvm will see no devices. - +.P If the system devices file does not yet exist, the pvcreate or vgcreate commands will create it if they see no existing VGs on the system. lvmdevices --addev and vgimportdevices will always create a new devices file if it does not yet exist. - +.P It is recommended to use lvm commands to make changes to the devices file to ensure proper updates. - diff --git a/man/lvmdiskscan.8_des b/man/lvmdiskscan.8_des index c1e87cca5..70df55d31 100644 --- a/man/lvmdiskscan.8_des +++ b/man/lvmdiskscan.8_des @@ -2,6 +2,5 @@ lvmdiskscan scans all SCSI, (E)IDE disks, multiple devices and a bunch of other block devices in the system looking for LVM PVs. The size reported is the real device size. Define a filter in \fBlvm.conf\fP(5) to restrict the scan to avoid a CD ROM, for example. - +.P This command is deprecated, use \fBpvs\fP instead. - diff --git a/man/lvreduce.8_des b/man/lvreduce.8_des index af6735843..5a7d4e92f 100644 --- a/man/lvreduce.8_des +++ b/man/lvreduce.8_des @@ -3,16 +3,16 @@ to the VG to be used by other LVs. A copy-on-write snapshot LV can also be reduced if less space is needed to hold COW blocks. Use \fBlvconvert\fP(8) to change the number of data images in a RAID or mirrored LV. - +.P Be careful when reducing an LV's size, because data in the reduced area is lost. Ensure that any file system on the LV is resized \fBbefore\fP running lvreduce so that the removed extents are not in use by the file system. - +.P Sizes will be rounded if necessary. For example, the LV size must be an exact number of extents, and the size of a striped segment must be a multiple of the number of stripes. - +.P In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See both descriptions the options section. diff --git a/man/lvreduce.8_end b/man/lvreduce.8_end index 53f1ac78e..a92e77222 100644 --- a/man/lvreduce.8_end +++ b/man/lvreduce.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. Reduce the size of an LV by 3 logical extents: .br .B lvreduce -l -3 vg00/lvol1 diff --git a/man/lvremove.8_des b/man/lvremove.8_des index a9b481307..9e8f78d00 100644 --- a/man/lvremove.8_des +++ b/man/lvremove.8_des @@ -1,18 +1,18 @@ lvremove removes one or more LVs. For standard LVs, this returns the logical extents that were used by the LV to the VG for use by other LVs. - +.P Confirmation will be requested before deactivating any active LV prior to removal. LVs cannot be deactivated or removed while they are open (e.g. if they contain a mounted filesystem). Removing an origin LV will also remove all dependent snapshots. - +.P When a single force option is used, LVs are removed without confirmation, and the command will try to deactivate unused LVs. - +.P To remove damaged LVs, two force options may be required (\fB-ff\fP). - +.P \fBHistorical LVs\fP - +.P If the configuration setting \fBmetadata/record_lvs_history\fP is enabled and the LV being removed forms part of the history of at least one LV that is still present, then a simplified representation of the LV will be diff --git a/man/lvremove.8_end b/man/lvremove.8_end index e74601564..1f0c80103 100644 --- a/man/lvremove.8_end +++ b/man/lvremove.8_end @@ -1,8 +1,10 @@ +. .SH EXAMPLES +. Remove an active LV without asking for confirmation. .br .B lvremove -f vg00/lvol1 - +.P Remove all LVs the specified VG. .br .B lvremove vg00 diff --git a/man/lvrename.8_end b/man/lvrename.8_end index ab7c7bd3d..386faabbb 100644 --- a/man/lvrename.8_end +++ b/man/lvrename.8_end @@ -1,9 +1,10 @@ +. .SH EXAMPLES - +. Rename "lvold" to "lvnew": .br .B lvrename /dev/vg02/lvold vg02/lvnew - +.P An alternate syntax to rename "lvold" to "lvnew": .br .B lvrename vg02 lvold lvnew diff --git a/man/lvresize.8_des b/man/lvresize.8_des index dcc42aa0d..2ff5e563b 100644 --- a/man/lvresize.8_des +++ b/man/lvresize.8_des @@ -1,6 +1,6 @@ lvresize resizes an LV in the same way as lvextend and lvreduce. See \fBlvextend\fP(8) and \fBlvreduce\fP(8) for more information. - +.P In the usage section below, \fB--size\fP \fISize\fP can be replaced with \fB--extents\fP \fINumber\fP. See both descriptions the options section. diff --git a/man/lvresize.8_end b/man/lvresize.8_end index 563ea5716..b69d6acd3 100644 --- a/man/lvresize.8_end +++ b/man/lvresize.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. Extend an LV by 16MB using specific physical extents: .br .B lvresize -L+16M vg1/lv1 /dev/sda:0-1 /dev/sdb:0-1 diff --git a/man/lvs.8_end b/man/lvs.8_end index 6fdb80459..dc3a27446 100644 --- a/man/lvs.8_end +++ b/man/lvs.8_end @@ -1,3 +1,4 @@ +. .SH NOTES . The lv_attr bits are: diff --git a/man/pvchange.8_des b/man/pvchange.8_des index e914e1373..d67bca12b 100644 --- a/man/pvchange.8_des +++ b/man/pvchange.8_des @@ -1,4 +1,4 @@ pvchange changes PV attributes in the VG. - +.P For options listed in parentheses, any one is required, after which the others are optional. diff --git a/man/pvchange.8_end b/man/pvchange.8_end index f1cac15a3..617f828c1 100644 --- a/man/pvchange.8_end +++ b/man/pvchange.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. Disallow the allocation of physical extents on a PV (e.g. because of disk errors, or because it will be removed after freeing it). .br diff --git a/man/pvck.8_des b/man/pvck.8_des index 1d9b30a02..3adda4672 100644 --- a/man/pvck.8_des +++ b/man/pvck.8_des @@ -1,7 +1,7 @@ pvck checks and repairs LVM metadata on PVs. - +.P .SS Dump options - +.P .B headers .br Print LVM on-disk headers and structures: label_header, pv_header, @@ -12,7 +12,7 @@ a 512 byte sector at offset 4096 bytes. A second mda_header can optionally exist near the end of the device. The metadata text exists in an area (about 1MiB by default) immediately following the mda_header sector. The metadata text is checked but not printed (see other options). - +.P .B metadata .br Print the current LVM VG metadata text (or save to a file), using headers @@ -20,7 +20,7 @@ to locate the latest copy of metadata. If headers are damaged, metadata may not be found (see metadata_search). Use --settings "mda_num=2" to look in mda2 (the second mda at the end of the device, if used). The metadata text is printed to stdout or saved to a file with --file. - +.P .B metadata_all .br List all versions of VG metadata found in the metadata area, using headers @@ -28,7 +28,7 @@ to locate metadata. Full copies of all metadata are saved to a file with the --file option. If headers are damaged, metadata may not be found (see metadata_search). Use --settings "mda_num=2" as above. Use -v to include descriptions and dates when listing metadata versions. - +.P .B metadata_search .br List all versions of VG metadata found in the metadata area, searching @@ -38,20 +38,20 @@ save one specific version of metadata, use --settings "metadata_offset=<offset>", where the offset is taken from the list of versions found. Use -v to include descriptions and dates when listing metadata versions. - +.P .B metadata_area .br Save the entire text metadata area to a file without processing. - +.P .SS Repair options - +.P .B --repair .br Repair headers and metadata on a PV. This uses a metadata input file that was extracted by --dump, or a backup file (from \fI#DEFAULT_BACKUP_DIR#\fP). When possible, use metadata saved by --dump from another PV in the same VG (or from a second metadata area on the PV). - +.P There are cases where the PV UUID needs to be specified for the PV being repaired. It is specified using --settings "pv_uuid=<UUID>". In particular, if the device name for the PV being repaired does not match @@ -60,52 +60,52 @@ the correct PV UUID. When headers are damaged on more than one PV in a VG, it is important for the user to determine the correct PV UUID and specify it in --settings. Otherwise, the wrong PV UUID could be used if device names have been swapped since the metadata was last written. - +.P If a PV has no metadata areas and the pv_header is damaged, then the repair will not know to create no metadata areas during repair. It will by default repair metadata in mda1. To repair with no metadata areas, use --settings "mda_offset=0 mda_size=0". - +.P There are cases where repair should be run on all PVs in the VG (using the same metadata file): if all PVs in the VG are damaged, if using an old metadata version, or if a backup file is used instead of raw metadata (taken from pvck dump.) - +.P Using --repair is equivalent to running --repairtype pv_header followed by --repairtype metadata. - +.P .B --repairtype pv_header .br Repairs the header sector, containing the pv_header and label_header. - +.P .B --repairtype metadata .br Repairs the mda_header and metadata text. It requires the headers to be correct (having been undamaged or already repaired). - +.P .B --repairtype label_header .br Repairs label_header fields, leaving the pv_header (in the same sector) unchanged. (repairtype pv_header should usually be used instead.) - +.P .SS Settings - +.P The --settings option controls or overrides certain dump or repair behaviors. All offset and size values in settings are in bytes (units are not recognized.) These settings are subject to change. - +.P .B mda_num=1|2 .br Select which metadata area should be used. By default the first metadata area (1) is used. mda1 is always located at offset 4096. mda2, at the end of the device, often does not exist (it's not created by default.) If mda1 is erased, mda2, if it exists, will often still have metadata. - +.P \fBmetadata_offset=\fP\fIbytes\fP .br Select metadata text at this offset. Use with metadata_search to print/save one instance of metadata text. - +.P \fBmda_offset=\fP\fIbytes\fP \fBmda_size=\fP\fIbytes\fP .br Refers to a metadata area (mda) location and size. An mda includes an @@ -113,18 +113,18 @@ mda_header and circular metadata text buffer. Setting this forces metadata_search look for metadata in the given area instead of the standard locations. When set to zero with repair, it indicates no metadata areas should exist. - +.P \fBmda2_offset=\fP\fIbytes\fP \fBmda2_size=\fP\fIbytes\fP .br When repairing a pv_header, this forces a specific offset and size for mda2 that should be recorded in the pv_header. - +.P \fBpv_uuid=\fP\fIuuid\fP .br Specify the PV UUID of the device being repaired. When not specified, repair will attempt to determine the correct PV UUID by matching a device name in the metadata. - +.P \fBdevice_size=\fP\fIbytes\fP .br \fBdata_offset=\fP\fIbytes\fP @@ -134,4 +134,3 @@ be specified directly, in which case these values are not taken from a metadata file (where they usually come from), and the metadata file can be omitted. data_offset is the starting location of the first physical extent (data), which follows the first metadata area. - diff --git a/man/pvck.8_end b/man/pvck.8_end index 4b9c6d0f6..2d05dccaa 100644 --- a/man/pvck.8_end +++ b/man/pvck.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. If the partition table is corrupted or lost on /dev/sda, and you suspect there was an LVM partition at approximately 100 MiB, then this area of the disk can be scanned using the \fB--labelsector\fP diff --git a/man/pvcreate.8_des b/man/pvcreate.8_des index 22fb26bf3..69bd133aa 100644 --- a/man/pvcreate.8_des +++ b/man/pvcreate.8_des @@ -2,25 +2,25 @@ pvcreate initializes a Physical Volume (PV) on a device so the device is recognized as belonging to LVM. This allows the PV to be used in a Volume Group (VG). An LVM disk label is written to the device, and LVM metadata areas are initialized. A PV can be placed on a whole device or partition. - +.P Use \fBvgcreate\fP(8) to create a new VG on the PV, or \fBvgextend\fP(8) to add the PV to an existing VG. Use \fBpvremove\fP(8) to remove the LVM disk label from the device. - +.P The force option will create a PV without confirmation. Repeating the force option (\fB-ff\fP) will forcibly create a PV, overriding checks that normally prevent it, e.g. if the PV is already in a VG. - +.P .B Metadata location, size, and alignment - +.P The LVM disk label begins 512 bytes from the start of the device, and is 512 bytes in size. - +.P The LVM metadata area begins at an offset (from the start of the device) equal to the page size of the machine creating the PV (often 4 KiB.) The metadata area contains a 512 byte header and a multi-KiB circular buffer that holds text copies of the VG metadata. - +.P With default settings, the first physical extent (PE), which contains LV data, is 1 MiB from the start of the device. This location is controlled by \fBdefault_data_alignment\fP in lvm.conf, which is set to 1 (MiB) by @@ -29,7 +29,7 @@ can be checked with: .br .B pvs -o pe_start .I PV - +.P The size of the LVM metadata area is the space between the the start of the metadata area and the first PE. When metadata begins at 4 KiB and the first PE is at 1024 KiB, the metadata area size is 1020 KiB. This can be @@ -37,7 +37,7 @@ checked with: .br .B pvs -o mda_size .I PV - +.P The mda_size cannot be increased after pvcreate, so if larger metadata is needed, it must be set during pvcreate. Two copies of the VG metadata must always fit within the metadata area, so the maximum VG metadata size @@ -45,7 +45,7 @@ is around half the mda_size. This can be checked with: .br .B vgs -o mda_free .I VG - +.P A larger metadata area can be set with --metadatasize. The resulting mda_size may be larger than specified due to default_data_alignment placing pe_start on a MiB boundary, and the fact that the metadata area @@ -53,12 +53,12 @@ extends to the first PE. With metadata starting at 4 KiB and default_data_alignment 1 (MiB), setting --metadatasize 2048k results in pe_start of 3 MiB and mda_size of 3068 KiB. Alternatively, --metadatasize 2044k results in pe_start at 2 MiB and mda_size of 2044 KiB. - +.P The alignment of pe_start described above may be automatically overridden based on md device properties or device i/o properties reported in sysfs. These automatic adjustments can be enabled/disabled using lvm.conf settings md_chunk_alignment and data_alignment_offset_detection. - +.P To use a different pe_start alignment, use the --dataalignment option. The --metadatasize option would also typically be used in this case because the metadata area size also determines the location of pe_start. @@ -71,7 +71,7 @@ The pe_start of 2176 KiB is the nearest even multiple of 128 KiB that provides at least 2048 KiB of metadata space. Always check the resulting alignment and metadata size when using these options. - +.P To shift an aligned pe_start value, use the --dataalignmentoffset option. The pe_start alignment is calculated as described above, and then the value specified with --dataalignmentoffset is added to produce the final diff --git a/man/pvcreate.8_end b/man/pvcreate.8_end index e89decd49..2dfb7ecb5 100644 --- a/man/pvcreate.8_end +++ b/man/pvcreate.8_end @@ -1,9 +1,10 @@ +. .SH EXAMPLES - +. Initialize a partition and a full device. .br .B pvcreate /dev/sdc4 /dev/sde - +.P If a device is a 4KiB sector drive that compensates for windows partitioning (sector 7 is the lowest aligned logical block, the 4KiB sectors start at LBA -1, and consequently sector 63 is aligned on a 4KiB diff --git a/man/pvdisplay.8_des b/man/pvdisplay.8_des index 74d57ca78..68fe4a8b3 100644 --- a/man/pvdisplay.8_des +++ b/man/pvdisplay.8_des @@ -1,5 +1,5 @@ pvdisplay shows the attributes of PVs, like size, physical extent size, space used for the VG descriptor area, etc. - +.P \fBpvs\fP(8) is a preferred alternative that shows the same information and more, using a more compact and configurable output format. diff --git a/man/pvmove.8_des b/man/pvmove.8_des index 0786f9ba8..d32a68bd1 100644 --- a/man/pvmove.8_des +++ b/man/pvmove.8_des @@ -3,13 +3,13 @@ more destination PVs. You can optionally specify a source LV in which case only extents used by that LV will be moved to free (or specified) extents on the destination PV. If no destination PV is specified, the normal allocation rules for the VG are used. - +.P If pvmove is interrupted for any reason (e.g. the machine crashes) then run pvmove again without any PV arguments to restart any operations that were in progress from the last checkpoint. Alternatively, use the abort option at any time to abort the operation. The resulting location of LVs after an abort depends on whether the atomic option was used. - +.P More than one pvmove can run concurrently if they are moving data from different source PVs, but additional pvmoves will ignore any LVs already in the process of being changed, so some data might not get moved. diff --git a/man/pvmove.8_end b/man/pvmove.8_end index 8259b3f93..02f746b4b 100644 --- a/man/pvmove.8_end +++ b/man/pvmove.8_end @@ -1,9 +1,11 @@ +. .SH NOTES +. pvmove works as follows: - +.P 1. A temporary 'pvmove' LV is created to store details of all the data movements required. - +.P 2. Every LV in the VG is searched for contiguous data that need moving according to the command line arguments. For each piece of data found, a new segment is added to the end of the @@ -12,27 +14,27 @@ This segment takes the form of a temporary mirror to copy the data from the original location to a newly allocated location. The original LV is updated to use the new temporary mirror segment in the pvmove LV instead of accessing the data directly. - +.P 3. The VG metadata is updated on disk. - +.P 4. The first segment of the pvmove LV is activated and starts to mirror the first part of the data. Only one segment is mirrored at once as this is usually more efficient. - +.P 5. A daemon repeatedly checks progress at the specified time interval. When it detects that the first temporary mirror is in sync, it breaks that mirror so that only the new location for that data gets used and writes a checkpoint into the VG metadata on disk. Then it activates the mirror for the next segment of the pvmove LV. - +.P 6. When there are no more segments left to be mirrored, the temporary LV is removed and the VG metadata is updated so that the LVs reflect the new data locations. - +.P Note that this new process cannot support the original LVM1 type of on-disk metadata. Metadata can be converted using \fBvgconvert\fP(8). - +.P If the \fB--atomic\fP option is used, a slightly different approach is used for the move. Again, a temporary 'pvmove' LV is created to store the details of all the data movements required. This temporary LV contains @@ -43,48 +45,48 @@ temporary LV to the second. After a complete copy is made, the temporary LVs are removed, leaving behind the segments on the destination PV. If an abort is issued during the move, all LVs being moved will remain on the source PV. - +. .SH EXAMPLES - +. Move all physical extents that are used by simple LVs on the specified PV to free physical extents elsewhere in the VG. .br .B pvmove /dev/sdb1 - +.P Use a specific destination PV when moving physical extents. .br .B pvmove /dev/sdb1 /dev/sdc1 - +.P Move extents belonging to a single LV. .br .B pvmove -n lvol1 /dev/sdb1 /dev/sdc1 - +.P Rather than moving the contents of an entire device, it is possible to move a range of physical extents, for example numbers 1000 to 1999 inclusive on the specified PV. .br .B pvmove /dev/sdb1:1000-1999 - +.P A range of physical extents to move can be specified as start+length. For example, starting from PE 1000. (Counting starts from 0, so this refers to the 1001st to the 2000th PE inclusive.) .br .B pvmove /dev/sdb1:1000+1000 - +.P Move a range of physical extents to a specific PV (which must have sufficient free extents). .br .B pvmove /dev/sdb1:1000-1999 /dev/sdc1 - +.P Move a range of physical extents to specific new extents on a new PV. .br .B pvmove /dev/sdb1:1000-1999 /dev/sdc1:0-999 - +.P If the source and destination are on the same disk, the \fBanywhere\fP allocation policy is needed. .br .B pvmove --alloc anywhere /dev/sdb1:1000-1999 /dev/sdb1:0-999 - +.P The part of a specific LV present within in a range of physical extents can also be picked out and moved. .br diff --git a/man/pvremove.8_des b/man/pvremove.8_des index cc84148a1..01c75f1e8 100644 --- a/man/pvremove.8_des +++ b/man/pvremove.8_des @@ -1,7 +1,7 @@ pvremove wipes the label on a device so that LVM will no longer recognise it as a PV. - +.P A PV cannot be removed from a VG while it is used by an active LV. - +.P Repeat the force option (\fB-ff\fP) to forcibly remove a PV belonging to an existing VG. Normally, \fBvgreduce\fP(8) should be used instead. diff --git a/man/pvresize.8_end b/man/pvresize.8_end index a347e4ad9..4831716cc 100644 --- a/man/pvresize.8_end +++ b/man/pvresize.8_end @@ -1,11 +1,15 @@ +. .SH NOTES +. pvresize will refuse to shrink a PV if it has allocated extents beyond the new end. +. .SH EXAMPLES +. Expand a PV after enlarging the partition. .br .B pvresize /dev/sda1 - +.P Shrink a PV prior to shrinking the partition (ensure that the PV size is appropriate for the intended new partition size). .br diff --git a/man/pvs.8_end b/man/pvs.8_end index c18f5518b..3ba3d391a 100644 --- a/man/pvs.8_end +++ b/man/pvs.8_end @@ -1,3 +1,4 @@ +. .SH NOTES . The pv_attr bits are: diff --git a/man/pvscan.8_des b/man/pvscan.8_des index f685b8254..b20b987da 100644 --- a/man/pvscan.8_des +++ b/man/pvscan.8_des @@ -3,38 +3,38 @@ like .BR pvs (8) or .BR pvdisplay (8). - +.P When the --cache and -aay options are used, pvscan records which PVs are available on the system, and activates LVs in completed VGs. A VG is complete when pvscan sees that the final PV in the VG has appeared. This is used by event-based system startup (systemd, udev) to activate LVs. - +.P The four main variations of this are: - +.P .B pvscan --cache -.IR device - +.I device +.P If device is present, lvm adds a record that the PV on device is online. If device is not present, lvm removes the online record for the PV. In most cases, the pvscan will only read the named devices. - +.P .B pvscan --cache -aay .IR device ... - +.P This begins by performing the same steps as above. Afterward, if the VG for the specified PV is complete, then pvscan will activate LVs in the VG (the same as vgchange -aay vgname would do.) - +.P .B pvscan --cache - +.P This first clears all existing PV online records, then scans all devices on the system, adding PV online records for any PVs that are found. - +.P .B pvscan --cache -aay - +.P This begins by performing the same steps as pvscan --cache. Afterward, it activates LVs in any complete VGs. - +.P To prevent devices from being scanned by pvscan --cache, add them to .BR lvm.conf (5) @@ -42,19 +42,18 @@ to For more information, see: .br .B lvmconfig --withcomments devices/global_filter - +.P Auto-activation of VGs or LVs can be enabled/disabled using: .br .BR lvm.conf (5) .B activation/auto_activation_volume_list - +.P For more information, see: .br .B lvmconfig --withcomments activation/auto_activation_volume_list - +.P To disable auto-activation, explicitly set this list to an empty list, i.e. auto_activation_volume_list = [ ]. - +.P When this setting is undefined (e.g. commented), then all LVs are auto-activated. - diff --git a/man/vgcfgbackup.8_des b/man/vgcfgbackup.8_des index f96fad3eb..801b506e4 100644 --- a/man/vgcfgbackup.8_des +++ b/man/vgcfgbackup.8_des @@ -2,15 +2,15 @@ vgcfgbackup creates back up files containing metadata of VGs. If no VGs are named, back up files are created for all VGs. See \fBvgcfgrestore\fP for information on using the back up files. - +.P In a default installation, each VG is backed up into a separate file bearing the name of the VG in the directory \fI#DEFAULT_BACKUP_DIR#\fP. - +.P To use an alternative back up file, use \fB-f\fP. In this case, when backing up multiple VGs, the file name is treated as a template, with %s replaced by the VG name. - +.P NB. This DOES NOT back up the data content of LVs. - +.P It may also be useful to regularly back up the files in \fI#DEFAULT_SYS_DIR#\fP. diff --git a/man/vgcfgrestore.8_des b/man/vgcfgrestore.8_des index b79e2efba..dbc9aee16 100644 --- a/man/vgcfgrestore.8_des +++ b/man/vgcfgrestore.8_des @@ -1,11 +1,11 @@ vgcfgrestore restores the metadata of a VG from a text back up file produced by \fBvgcfgbackup\fP. This writes VG metadata onto the devices specifed in back up file. - +.P A back up file can be specified with \fB--file\fP. If no backup file is specified, the most recent one is used. Use \fB--list\fP for a list of the available back up and archive files of a VG. - +.P WARNING: When a VG contains thin pools, changes to thin metadata cannot be reverted, and data loss may occur if thin metadata has changed. The force option is required to restore in this case. diff --git a/man/vgcfgrestore.8_end b/man/vgcfgrestore.8_end index ffcb3eee0..04e18bdb8 100644 --- a/man/vgcfgrestore.8_end +++ b/man/vgcfgrestore.8_end @@ -1,5 +1,6 @@ +. .SH NOTES - +. To replace PVs, \fBvgdisplay --partial --verbose\fP will show the UUIDs and sizes of any PVs that are no longer present. If a PV in the VG is lost and you wish to substitute another of the same size, use diff --git a/man/vgchange.8_end b/man/vgchange.8_end index 828a70740..dd95d8103 100644 --- a/man/vgchange.8_end +++ b/man/vgchange.8_end @@ -1,12 +1,16 @@ +. .SH NOTES +. If vgchange recognizes COW snapshot LVs that were dropped because they ran out of space, it displays a message informing the administrator that the snapshots should be removed. +. .SH EXAMPLES +. Activate all LVs in all VGs on all existing devices. .br .B vgchange -a y - +.P Change the maximum number of LVs for an inactive VG. .br .B vgchange -l 128 vg00 diff --git a/man/vgcreate.8_des b/man/vgcreate.8_des index e2861c3a0..6e0d11bed 100644 --- a/man/vgcreate.8_des +++ b/man/vgcreate.8_des @@ -2,9 +2,8 @@ vgcreate creates a new VG on block devices. If the devices were not previously initialized as PVs with \fBpvcreate\fP(8), vgcreate will inititialize them, making them PVs. The pvcreate options for initializing devices are also available with vgcreate. - +.P When vgcreate uses an existing PV, that PV's existing values for metadata size, PE start, etc, are used, even if different values are specified in the vgcreate command. To change these values, first use pvremove on the device. - diff --git a/man/vgcreate.8_end b/man/vgcreate.8_end index e4c81e344..28b87febf 100644 --- a/man/vgcreate.8_end +++ b/man/vgcreate.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. Create a VG with two PVs, using the default physical extent size. .br .B vgcreate myvg /dev/sdk1 /dev/sdl1 diff --git a/man/vgdisplay.8_des b/man/vgdisplay.8_des index c42f8218b..fa3d29a4f 100644 --- a/man/vgdisplay.8_des +++ b/man/vgdisplay.8_des @@ -1,4 +1,4 @@ vgdisplay shows the attributes of VGs, and the associated PVs and LVs. - +.P \fBvgs\fP(8) is a preferred alternative that shows the same information and more, using a more compact and configurable output format. diff --git a/man/vgexport.8_des b/man/vgexport.8_des index 9f276afa7..0c6f4af9d 100644 --- a/man/vgexport.8_des +++ b/man/vgexport.8_des @@ -4,16 +4,16 @@ imported by \fBvgimport\fP(8). Putting a VG into an unusable, offline state can be useful when doing things like moving a VG's disks to another system. Exporting a VG provides some protection from its LVs being accidentally used, or being used by an automated system before it's ready. - +.P A VG cannot be exported until all of its LVs are inactive. - +.P LVM commands will ignore an exported VG or report an error if a command tries to use it. - +.P For an exported VG, the vgs command will display \"x\" in the third VG attribute, and the pvs command will display \"x\" in the second PV attribute. Both vgs and pvs will display \"exported\" from the export report field. - +.P vgexport clears the VG system ID, and vgimport sets the VG system ID to match the host running vgimport (if the host has a system ID). diff --git a/man/vgextend.8_des b/man/vgextend.8_des index cee2d1eb5..cf7c66129 100644 --- a/man/vgextend.8_des +++ b/man/vgextend.8_des @@ -1,10 +1,10 @@ vgextend adds one or more PVs to a VG. This increases the space available for LVs in the VG. - +.P Also, PVs that have gone missing and then returned, e.g. due to a transient device failure, can be added back to the VG without re-initializing them (see --restoremissing). - +.P If the specified PVs have not yet been initialized with pvcreate, vgextend will initialize them. In this case pvcreate options can be used, e.g. --labelsector, --metadatasize, --metadataignore, diff --git a/man/vgextend.8_end b/man/vgextend.8_end index 7cd8fd602..e63fa1343 100644 --- a/man/vgextend.8_end +++ b/man/vgextend.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. Add two PVs to a VG. .br .B vgextend vg00 /dev/sda4 /dev/sdn1 diff --git a/man/vgimport.8_des b/man/vgimport.8_des index 91196b683..22d36ce9a 100644 --- a/man/vgimport.8_des +++ b/man/vgimport.8_des @@ -1,5 +1,5 @@ vgimport makes exported VGs known to the system again, perhaps after moving the PVs from a different system. - +.P vgexport clears the VG system ID, and vgimport sets the VG system ID to match the host running vgimport (if the host has a system ID). diff --git a/man/vgimportclone.8_des b/man/vgimportclone.8_des index a5002da6d..e5d13433c 100644 --- a/man/vgimportclone.8_des +++ b/man/vgimportclone.8_des @@ -1,6 +1,6 @@ vgimportclone imports a VG from duplicated PVs, e.g. created by a hardware snapshot of existing PVs. - +.P A duplicated VG cannot used until it is made to coexist with the original VG. vgimportclone renames the VG associated with the specified PVs and changes the associated VG and PV UUIDs. diff --git a/man/vgimportclone.8_end b/man/vgimportclone.8_end index 68c57d44f..4a092974e 100644 --- a/man/vgimportclone.8_end +++ b/man/vgimportclone.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. An original VG "vg00" has PVs "/dev/sda" and "/dev/sdb". The corresponding PVs from a hardware snapshot are "/dev/sdc" and "/dev/sdd". Rename the VG associated with "/dev/sdc" and "/dev/sdd" from "vg00" to "vg00_snap" diff --git a/man/vgimportdevices.8_des b/man/vgimportdevices.8_des index 7c2287cfd..8ad3836e1 100644 --- a/man/vgimportdevices.8_des +++ b/man/vgimportdevices.8_des @@ -3,9 +3,8 @@ to using using lvmdevices --adddev to add each PV to the devices file individually. vgimportdevices will also update the VG metadata to include the device IDs of each PV. vgimportdevices will create a new devices file if none exists. - +.P When a devices file is used, the regex filter is ignored, except in the case of vgimportdevices which will apply the regex filter when looking for the VGs to import to the devices file. Use vgimportdevices -a to import all VGs on a system to the devices file. - diff --git a/man/vgmerge.8_end b/man/vgmerge.8_end index 905492dc4..c64190d86 100644 --- a/man/vgmerge.8_end +++ b/man/vgmerge.8_end @@ -1,5 +1,6 @@ +. .SH EXAMPLES - +. Merge an inactive VG named "vg00" into the active or inactive VG named "databases", giving verbose runtime information. .br diff --git a/man/vgmknodes.8_des b/man/vgmknodes.8_des index a93d629e1..14c117734 100644 --- a/man/vgmknodes.8_des +++ b/man/vgmknodes.8_des @@ -1,5 +1,5 @@ vgmknodes checks the LVM device nodes in /dev that are needed for active LVs and creates any that are missing and removes unused ones. - +.P This command should not usually be needed if all the system components are interoperating correctly. diff --git a/man/vgremove.8_des b/man/vgremove.8_des index e87666fd6..3b1c23821 100644 --- a/man/vgremove.8_des +++ b/man/vgremove.8_des @@ -1,9 +1,9 @@ vgremove removes one or more VGs. If LVs exist in the VG, a prompt is used to confirm LV removal. - +.P If one or more PVs in the VG are lost, consider \fBvgreduce --removemissing\fP to make the VG metadata consistent again. - +.P Repeat the force option (\fB-ff\fP) to forcibly remove LVs in the VG without confirmation. diff --git a/man/vgrename.8_des b/man/vgrename.8_des index 2384b6bf0..7c9802b42 100644 --- a/man/vgrename.8_des +++ b/man/vgrename.8_des @@ -1,5 +1,5 @@ vgrename renames a VG. - +.P All VGs visible to a system need to have different names, otherwise many LVM commands will refuse to run or give warning messages. VGs with the same name can occur when disks are moved between machines, or filters are diff --git a/man/vgrename.8_end b/man/vgrename.8_end index 5cdd0d02e..f66b764a8 100644 --- a/man/vgrename.8_end +++ b/man/vgrename.8_end @@ -1,9 +1,10 @@ +. .SH EXAMPLES - +. Rename VG "vg02" to "myvg": .br .B vgrename "vg02" "myvg" - +.P Rename the VG with the specified UUID to "myvg". .br .B vgrename Zvlifi-Ep3t-e0Ng-U42h-o0ye-KHu1-nl7Ns4 myvg diff --git a/man/vgs.8_end b/man/vgs.8_end index 06699187c..19727fabf 100644 --- a/man/vgs.8_end +++ b/man/vgs.8_end @@ -1,3 +1,4 @@ +. .SH NOTES . The vg_attr bits are: diff --git a/man/vgsplit.8_des b/man/vgsplit.8_des index d42ff1628..8eb5753d7 100644 --- a/man/vgsplit.8_des +++ b/man/vgsplit.8_des @@ -2,13 +2,13 @@ vgsplit moves one or more PVs from a source VG (the first VG arg) to a destination VG (the second VG arg). The PV(s) to move are named after the source and destination VGs, or an LV is named, in which case the PVs underlying the LV are moved. - +.P If the destination VG does not exist, a new VG is created (command options can be used to specify properties of the new VG, also see -\fBvgcreate\fP(8).) - +\fBvgcreate\fP(8)). +.P LVs cannot be split between VGs; each LV must be entirely on the PVs in the source or destination VG. - +.P vgsplit can only move complete PVs. (See \fBpvmove\fP(8) for moving part of a PV.)

3 years

1
0
0 / 0

main - man: typography for raid and report

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=5f75f5e2bc0f10c7415... Commit: 5f75f5e2bc0f10c74151914aa59264d29815d9ba Parent: 9164a393de449f285038811d58ade0fb3ecfba30 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Thu Apr 15 22:18:05 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:54:37 2021 +0200 man: typography for raid and report Some enhancements for better man page rendering. --- man/lvmraid.7_main | 1199 ++++++++++++++++++++++----------------------- man/lvmreport.7_main | 1312 ++++++++++++++++++++++++++------------------------ 2 files changed, 1252 insertions(+), 1259 deletions(-) diff --git a/man/lvmraid.7_main b/man/lvmraid.7_main index 2335f5dbe..26938da83 100644 --- a/man/lvmraid.7_main +++ b/man/lvmraid.7_main @@ -1,279 +1,303 @@ .TH "LVMRAID" "7" "LVM TOOLS #VERSION#" "Red Hat, Inc" "\"" - +. +.de ipbu +.PD 0 +.IP " \[bu]" +.PD +.. +. +.de ipbu_npd +.IP " \[bu]" +.. +. .SH NAME +. lvmraid \(em LVM RAID - +. .SH DESCRIPTION - +. \fBlvm\fP(8) RAID is a way to create a Logical Volume (LV) that uses multiple physical devices to improve performance or tolerate device failures. In LVM, the physical devices are Physical Volumes (PVs) in a single Volume Group (VG). - +.P How LV data blocks are placed onto PVs is determined by the RAID level. RAID levels are commonly referred to as 'raid' followed by a number, e.g. raid1, raid5 or raid6. Selecting a RAID level involves making tradeoffs among: physical device requirements, fault tolerance, and performance. A description of the RAID levels can be found at .br -www.snia.org/sites/default/files/SNIA_DDF_Technical_Position_v2.0.pdf - +.I www.snia.org/sites/default/files/SNIA_DDF_Technical_Position_v2.0.pdf +.P LVM RAID uses both Device Mapper (DM) and Multiple Device (MD) drivers from the Linux kernel. DM is used to create and manage visible LVM devices, and MD is used to place data on physical devices. - +.P LVM creates hidden LVs (dm devices) layered between the visible LV and physical devices. LVs in the middle layers are called sub LVs. For LVM raid, a sub LV pair to store data and metadata (raid superblock and write intent bitmap) is created per raid image/leg (see lvs command examples below). - -.SH Create a RAID LV - +. +.SH USAGE +. To create a RAID LV, use lvcreate and specify an LV type. The LV type corresponds to a RAID level. The basic RAID levels that can be used are: -.B raid0, raid1, raid4, raid5, raid6, raid10. - +.BR raid0 ", " raid1 ", " raid4 ", " raid5 ", " raid6 ", " raid10 . +.P .B lvcreate --type .I RaidLevel -[\fIOPTIONS\fP] +.RI [ OPTIONS ] .B --name .I Name .B --size .I Size .I VG -[\fIPVs\fP] - +.RI [ PVs ] +.P To display the LV type of an existing LV, run: - -.B lvs -o name,segtype -\fILV\fP - +.P +.B lvs -o name,segtype \fILV +.P (The LV type is also referred to as "segment type" or "segtype".) - +.P LVs can be created with the following types: - +. .SS raid0 - -\& - +. Also called striping, raid0 spreads LV data across multiple devices in units of stripe size. This is used to increase performance. LV data will be lost if any of the devices fail. - +.P .B lvcreate --type raid0 -[\fB--stripes\fP \fINumber\fP \fB--stripesize\fP \fISize\fP] -\fIVG\fP -[\fIPVs\fP] - -.HP -.B --stripes -specifies the number of devices to spread the LV across. - -.HP +.RB [ --stripes +.I Number .B --stripesize -specifies the size of each stripe in kilobytes. This is the amount of +.IR Size ] +.I VG +.RI [ PVs ] +. +.TP +.B --stripes \fINumber +specifies the \fINumber\fP of devices to spread the LV across. +. +.TP +.B --stripesize \fISize +specifies the \fISize\fP of each stripe in kilobytes. This is the amount of data that is written to one device before moving to the next. .P - \fIPVs\fP specifies the devices to use. If not specified, lvm will choose \fINumber\fP devices, one for each stripe based on the number of PVs available or supplied. - +. .SS raid1 - -\& - +. Also called mirroring, raid1 uses multiple devices to duplicate LV data. The LV data remains available if all but one of the devices fail. The minimum number of devices (i.e. sub LV pairs) required is 2. - +.P .B lvcreate --type raid1 [\fB--mirrors\fP \fINumber\fP] \fIVG\fP [\fIPVs\fP] - -.HP -.B --mirrors -specifies the number of mirror images in addition to the original LV +. +.TP +.B --mirrors \fINumber +specifies the \fINumber\fP of mirror images in addition to the original LV image, e.g. --mirrors 1 means there are two images of the data, the original and one mirror image. .P - \fIPVs\fP specifies the devices to use. If not specified, lvm will choose \fINumber\fP devices, one for each image. - +. .SS raid4 - -\& - +. raid4 is a form of striping that uses an extra, first device dedicated to storing parity blocks. The LV data remains available if one device fails. The parity is used to recalculate data that is lost from a single device. The minimum number of devices required is 3. - +.P .B lvcreate --type raid4 [\fB--stripes\fP \fINumber\fP \fB--stripesize\fP \fISize\fP] \fIVG\fP [\fIPVs\fP] - -.HP -.B --stripes -specifies the number of devices to use for LV data. This does not include +. +.TP +.B --stripes \fINumber +specifies the \fINumber\fP of devices to use for LV data. This does not include the extra device lvm adds for storing parity blocks. A raid4 LV with \fINumber\fP stripes requires \fINumber\fP+1 devices. \fINumber\fP must be 2 or more. - -.HP -.B --stripesize -specifies the size of each stripe in kilobytes. This is the amount of +. +.TP +.B --stripesize \fISize +specifies the \fISize\fP of each stripe in kilobytes. This is the amount of data that is written to one device before moving to the next. .P - \fIPVs\fP specifies the devices to use. If not specified, lvm will choose \fINumber\fP+1 separate devices. - +.P raid4 is called non-rotating parity because the parity blocks are always stored on the same device. - +. .SS raid5 - -\& - +. raid5 is a form of striping that uses an extra device for storing parity blocks. LV data and parity blocks are stored on each device, typically in a rotating pattern for performance reasons. The LV data remains available if one device fails. The parity is used to recalculate data that is lost from a single device. The minimum number of devices required is 3 (unless converting from 2 legged raid1 to reshape to more stripes; see reshaping). - +.P .B lvcreate --type raid5 [\fB--stripes\fP \fINumber\fP \fB--stripesize\fP \fISize\fP] \fIVG\fP [\fIPVs\fP] - -.HP -.B --stripes -specifies the number of devices to use for LV data. This does not include +. +.TP +.B --stripes \fINumber +specifies the \fINumber\fP of devices to use for LV data. This does not include the extra device lvm adds for storing parity blocks. A raid5 LV with \fINumber\fP stripes requires \fINumber\fP+1 devices. \fINumber\fP must be 2 or more. - -.HP -.B --stripesize -specifies the size of each stripe in kilobytes. This is the amount of +. +.TP +.B --stripesize \fISize +specifies the \fISize\fP of each stripe in kilobytes. This is the amount of data that is written to one device before moving to the next. .P - \fIPVs\fP specifies the devices to use. If not specified, lvm will choose \fINumber\fP+1 separate devices. - +.P raid5 is called rotating parity because the parity blocks are placed on different devices in a round-robin sequence. There are variations of raid5 with different algorithms for placing the parity blocks. The default variant is raid5_ls (raid5 left symmetric, which is a rotating -parity 0 with data restart.) See \fBRAID5 variants\fP below. - +parity 0 with data restart.) See \fBRAID5 VARIANTS\fP below. +. .SS raid6 - -\& - +. raid6 is a form of striping like raid5, but uses two extra devices for parity blocks. LV data and parity blocks are stored on each device, typically in a rotating pattern for performance reasons. The LV data remains available if up to two devices fail. The parity is used to recalculate data that is lost from one or two devices. The minimum number of devices required is 5. - +.P .B lvcreate --type raid6 [\fB--stripes\fP \fINumber\fP \fB--stripesize\fP \fISize\fP] \fIVG\fP [\fIPVs\fP] - -.HP -.B --stripes -specifies the number of devices to use for LV data. This does not include +. +.TP +.B --stripes \fINumber +specifies the \fINumber\fP of devices to use for LV data. This does not include the extra two devices lvm adds for storing parity blocks. A raid6 LV with \fINumber\fP stripes requires \fINumber\fP+2 devices. \fINumber\fP must be 3 or more. - -.HP -.B --stripesize -specifies the size of each stripe in kilobytes. This is the amount of +. +.TP +.B --stripesize \fISize +specifies the \fISize\fP of each stripe in kilobytes. This is the amount of data that is written to one device before moving to the next. .P - \fIPVs\fP specifies the devices to use. If not specified, lvm will choose \fINumber\fP+2 separate devices. - +.P Like raid5, there are variations of raid6 with different algorithms for placing the parity blocks. The default variant is raid6_zr (raid6 zero restart, aka left symmetric, which is a rotating parity 0 with data -restart.) See \fBRAID6 variants\fP below. - +restart.) See \fBRAID6 VARIANTS\fP below. +. .SS raid10 - -\& - +. raid10 is a combination of raid1 and raid0, striping data across mirrored devices. LV data remains available if one or more devices remains in each mirror set. The minimum number of devices required is 4. - +.TP .B lvcreate --type raid10 -.RS [\fB--mirrors\fP \fINumberMirrors\fP] .br [\fB--stripes\fP \fINumberStripes\fP \fB--stripesize\fP \fISize\fP] .br \fIVG\fP [\fIPVs\fP] -.RE - -.HP -.B --mirrors +. +.TP +.B --mirrors \fINumberMirrors specifies the number of mirror images within each stripe. e.g. --mirrors 1 means there are two images of the data, the original and one mirror image. - -.HP -.B --stripes +. +.TP +.B --stripes \fINumberStripes specifies the total number of devices to use in all raid1 images (not the number of raid1 devices to spread the LV across, even though that is the effective result). The number of devices in each raid1 mirror will be -NumberStripes/(NumberMirrors+1), e.g. mirrors 1 and stripes 4 will stripe +\fINumberStripes\fP/(\fINumberMirrors\fP+1), e.g. mirrors 1 and stripes 4 will stripe data across two raid1 mirrors, where each mirror is devices. - -.HP -.B --stripesize -specifies the size of each stripe in kilobytes. This is the amount of +. +.TP +.B --stripesize \fISize +specifies the \fISize\fP of each stripe in kilobytes. This is the amount of data that is written to one device before moving to the next. .P - \fIPVs\fP specifies the devices to use. If not specified, lvm will choose the necessary devices. Devices are used to create mirrors in the order listed, e.g. for mirrors 1, stripes 2, listing PV1 PV2 PV3 PV4 results in mirrors PV1/PV2 and PV3/PV4. - +.P RAID10 is not mirroring on top of stripes, which would be RAID01, which is less tolerant of device failures. - - -.SH Synchronization - +. +.SS Configuration Options +. +There are a number of options in the LVM configuration file that affect +the behavior of RAID LVs. The tunable options are listed +below. A detailed description of each can be found in the LVM +configuration file itself. +.RS +mirror_segtype_default +.br +raid10_segtype_default +.br +raid_region_size +.br +raid_fault_policy +.br +activation_mode +.RE +. +.SS Monitoring +. +When a RAID LV is activated the \fBdmeventd\fP(8) process is started to +monitor the health of the LV. Various events detected in the kernel can +cause a notification to be sent from device-mapper to the monitoring +process, including device failures and synchronization completion (e.g. +for initialization or scrubbing). +.P +The LVM configuration file contains options that affect how the monitoring +process will respond to failure events (e.g. raid_fault_policy). It is +possible to turn on and off monitoring with lvchange, but it is not +recommended to turn this off unless you have a thorough knowledge of the +consequences. +. +.SS Synchronization +. Synchronization is the process that makes all the devices in a RAID LV consistent with each other. - +.P In a RAID1 LV, all mirror images should have the same data. When a new mirror image is added, or a mirror image is missing data, then images need to be synchronized. Data blocks are copied from an existing image to a new or outdated image to make them match. - +.P In a RAID 4/5/6 LV, parity blocks and data blocks should match based on the parity calculation. When the devices in a RAID LV change, the data and parity blocks can become inconsistent and need to be synchronized. Correct blocks are read, parity is calculated, and recalculated blocks are written. - +.P The RAID implementation keeps track of which parts of a RAID LV are synchronized. When a RAID LV is first created and activated the first synchronization is called initialization. A pointer stored in the raid @@ -282,96 +306,86 @@ restarted after a deactivation of the RaidLV or a crash. Any writes to the RaidLV dirties the respective region of the write intent bitmap which allow for fast recovery of the regions after a crash. Without this, the entire LV would need to be synchronized every time it was activated. - +.P Automatic synchronization happens when a RAID LV is activated, but it is usually partial because the bitmaps reduce the areas that are checked. A full sync becomes necessary when devices in the RAID LV are replaced. - +.P The synchronization status of a RAID LV is reported by the following command, where "Cpy%Sync" = "100%" means sync is complete: - +.P .B lvs -a -o name,sync_percent - - +. .SS Scrubbing - +. Scrubbing is a full scan of the RAID LV requested by a user. Scrubbing can find problems that are missed by partial synchronization. - +.P Scrubbing assumes that RAID metadata and bitmaps may be inaccurate, so it verifies all RAID metadata, LV data, and parity blocks. Scrubbing can find inconsistencies caused by hardware errors or degradation. These kinds of problems may be undetected by automatic synchronization which excludes areas outside of the RAID write-intent bitmap. - +.P The command to scrub a RAID LV can operate in two different modes: - +.P .B lvchange --syncaction .BR check | repair .I LV - -.HP +. +.TP .B check Check mode is read-only and only detects inconsistent areas in the RAID LV, it does not correct them. - -.HP +. +.TP .B repair Repair mode checks and writes corrected blocks to synchronize any inconsistent areas. - .P - Scrubbing can consume a lot of bandwidth and slow down application I/O on the RAID LV. To control the I/O rate used for scrubbing, use: - -.HP -.B --maxrecoveryrate -\fISize\fP[k|UNIT] -.br +. +.TP +.BR --maxrecoveryrate " " \fISize [k|UNIT] Sets the maximum recovery rate for a RAID LV. \fISize\fP is specified as an amount per second for each device in the array. If no suffix is given, then KiB/sec/device is used. Setting the recovery rate to \fB0\fP means it will be unbounded. - -.HP -.BR --minrecoveryrate -\fISize\fP[k|UNIT] -.br +. +.TP +.BR --minrecoveryrate " " \fISize [k|UNIT] Sets the minimum recovery rate for a RAID LV. \fISize\fP is specified as an amount per second for each device in the array. If no suffix is given, then KiB/sec/device is used. Setting the recovery rate to \fB0\fP means it will be unbounded. - .P - To display the current scrubbing in progress on an LV, including the syncaction mode and percent complete, run: - +.P .B lvs -a -o name,raid_sync_action,sync_percent - +.P After scrubbing is complete, to display the number of inconsistent blocks found, run: - +.P .B lvs -o name,raid_mismatch_count - +.P Also, if mismatches were found, the lvs attr field will display the letter "m" (mismatch) in the 9th position, e.g. - +.P .nf # lvs -o name,vgname,segtype,attr vg/lv LV VG Type Attr lv vg raid1 Rwi-a-r-m- .fi - - +. .SS Scrubbing Limitations - +. The \fBcheck\fP mode can only report the number of inconsistent blocks, it cannot report which blocks are inconsistent. This makes it impossible to know which device has errors, or if the errors affect file system data, metadata or nothing at all. - +.P The \fBrepair\fP mode can make the RAID LV data consistent, but it does not know which data is correct. The result may be consistent but incorrect data. When two different blocks of data must be made @@ -379,72 +393,72 @@ consistent, it chooses the block from the device that would be used during RAID initialization. However, if the PV holding corrupt data is known, lvchange --rebuild can be used in place of scrubbing to reconstruct the data on the bad device. - +.P Future developments might include: - +.P Allowing a user to choose the correct version of data during repair. - +.P Using a majority of devices to determine the correct version of data to use in a 3-way RAID1 or RAID6 LV. - +.P Using a checksumming device to pin-point when and where an error occurs, allowing it to be rewritten. - - -.SH SubLVs - +. +.SS SubLVs +. An LV is often a combination of other hidden LVs called SubLVs. The SubLVs either use physical devices, or are built from other SubLVs themselves. SubLVs hold LV data blocks, RAID parity blocks, and RAID metadata. SubLVs are generally hidden, so the lvs -a option is required to display them: - +.P .B lvs -a -o name,segtype,devices - +.P SubLV names begin with the visible LV name, and have an automatic suffix indicating its role: - -.IP \(bu 3 +. +.ipbu_npd SubLVs holding LV data or parity blocks have the suffix _rimage_#. +.br These SubLVs are sometimes referred to as DataLVs. - -.IP \(bu 3 +. +.ipbu_npd SubLVs holding RAID metadata have the suffix _rmeta_#. RAID metadata includes superblock information, RAID type, bitmap, and device health -information. These SubLVs are sometimes referred to as MetaLVs. - +information. +.br +These SubLVs are sometimes referred to as MetaLVs. .P - SubLVs are an internal implementation detail of LVM. The way they are used, constructed and named may change. - +.P The following examples show the SubLV arrangement for each of the basic RAID LV types, using the fewest number of devices allowed for each. - -.SS Examples - +.P +.I Examples +.P .B raid0 .br Each rimage SubLV holds a portion of LV data. No parity is used. No RAID metadata is used. - +.P .nf # lvcreate --type raid0 --stripes 2 --name lvr0 ... - +.P # lvs -a -o name,segtype,devices lvr0 raid0 lvr0_rimage_0(0),lvr0_rimage_1(0) [lvr0_rimage_0] linear /dev/sda(...) [lvr0_rimage_1] linear /dev/sdb(...) .fi - +.P .B raid1 .br Each rimage SubLV holds a complete copy of LV data. No parity is used. Each rmeta SubLV holds RAID metadata. - +.P .nf # lvcreate --type raid1 --mirrors 1 --name lvr1 ... - +.P # lvs -a -o name,segtype,devices lvr1 raid1 lvr1_rimage_0(0),lvr1_rimage_1(0) [lvr1_rimage_0] linear /dev/sda(...) @@ -452,15 +466,15 @@ Each rmeta SubLV holds RAID metadata. [lvr1_rmeta_0] linear /dev/sda(...) [lvr1_rmeta_1] linear /dev/sdb(...) .fi - +.P .B raid4 .br At least three rimage SubLVs each hold a portion of LV data and one rimage SubLV holds parity. Each rmeta SubLV holds RAID metadata. - +.P .nf # lvcreate --type raid4 --stripes 2 --name lvr4 ... - +.P # lvs -a -o name,segtype,devices lvr4 raid4 lvr4_rimage_0(0),\\ lvr4_rimage_1(0),\\ @@ -472,16 +486,16 @@ holds parity. Each rmeta SubLV holds RAID metadata. [lvr4_rmeta_1] linear /dev/sdb(...) [lvr4_rmeta_2] linear /dev/sdc(...) .fi - +.P .B raid5 .br At least three rimage SubLVs each typically hold a portion of LV data and parity (see section on raid5) Each rmeta SubLV holds RAID metadata. - +.P .nf # lvcreate --type raid5 --stripes 2 --name lvr5 ... - +.P # lvs -a -o name,segtype,devices lvr5 raid5 lvr5_rimage_0(0),\\ lvr5_rimage_1(0),\\ @@ -493,16 +507,16 @@ Each rmeta SubLV holds RAID metadata. [lvr5_rmeta_1] linear /dev/sdb(...) [lvr5_rmeta_2] linear /dev/sdc(...) .fi - +.P .B raid6 .br At least five rimage SubLVs each typically hold a portion of LV data and parity. (see section on raid6) Each rmeta SubLV holds RAID metadata. - +.P .nf # lvcreate --type raid6 --stripes 3 --name lvr6 - +.P # lvs -a -o name,segtype,devices lvr6 raid6 lvr6_rimage_0(0),\\ lvr6_rimage_1(0),\\ @@ -523,15 +537,15 @@ Each rmeta SubLV holds RAID metadata. [lvr6_rmeta_4] linear /dev/sde(...) [lvr6_rmeta_5] linear /dev/sdf(...) .fi - +.P .B raid10 .br At least four rimage SubLVs each hold a portion of LV data. No parity is used. Each rmeta SubLV holds RAID metadata. - +.P .nf # lvcreate --type raid10 --stripes 2 --mirrors 1 --name lvr10 - +.P # lvs -a -o name,segtype,devices lvr10 raid10 lvr10_rimage_0(0),\\ lvr10_rimage_1(0),\\ @@ -546,49 +560,46 @@ Each rmeta SubLV holds RAID metadata. [lvr10_rmeta_2] linear /dev/sdc(...) [lvr10_rmeta_3] linear /dev/sdd(...) .fi - - -.SH Device Failure - +. +.SH DEVICE FAILURE +. Physical devices in a RAID LV can fail or be lost for multiple reasons. A device could be disconnected, permanently failed, or temporarily disconnected. The purpose of RAID LVs (levels 1 and higher) is to continue operating in a degraded mode, without losing LV data, even after a device fails. The number of devices that can fail without the loss of LV data depends on the RAID level: - -.IP \[bu] 3 +. +.ipbu RAID0 (striped) LVs cannot tolerate losing any devices. LV data will be lost if any devices fail. - -.IP \[bu] 3 +. +.ipbu RAID1 LVs can tolerate losing all but one device without LV data loss. - -.IP \[bu] 3 +. +.ipbu RAID4 and RAID5 LVs can tolerate losing one device without LV data loss. - -.IP \[bu] 3 +. +.ipbu RAID6 LVs can tolerate losing two devices without LV data loss. - -.IP \[bu] 3 +. +.ipbu RAID10 is variable, and depends on which devices are lost. It stripes across multiple mirror groups with raid1 layout thus it can tolerate losing all but one device in each of these groups without LV data loss. - .P - If a RAID LV is missing devices, or has other device-related problems, lvs reports this in the health_status (and attr) fields: - +.P .B lvs -o name,lv_health_status - +. +.TP .B partial -.br Devices are missing from the LV. This is also indicated by the letter "p" (partial) in the 9th position of the lvs attr field. - +. +.TP .B refresh needed -.br A device was temporarily missing but has returned. The LV needs to be refreshed to use the device again (which will usually require partial synchronization). This is also indicated by the letter "r" (refresh @@ -596,58 +607,56 @@ needed) in the 9th position of the lvs attr field. See \fBRefreshing an LV\fP. This could also indicate a problem with the device, in which case it should be be replaced, see \fBReplacing Devices\fP. - +. +.TP .B mismatches exist -.br See .BR Scrubbing . - +.P Most commands will also print a warning if a device is missing, e.g. .br .nf WARNING: Device for PV uItL3Z-wBME-DQy0-... not found or rejected ... .fi - +.P This warning will go away if the device returns or is removed from the VG (see \fBvgreduce --removemissing\fP). - - +. .SS Activating an LV with missing devices - +. A RAID LV that is missing devices may be activated or not, depending on the "activation mode" used in lvchange: - +.P .B lvchange -ay --activationmode .BR complete | degraded | partial .I LV - +. +.TP .B complete -.br The LV is only activated if all devices are present. - +. +.TP .B degraded -.br The LV is activated with missing devices if the RAID level can tolerate the number of missing devices without LV data loss. - +. +.TP .B partial -.br The LV is always activated, even if portions of the LV data are missing because of the missing device(s). This should only be used to perform extreme recovery or repair operations. - +.P +Default activation mode when not specified by the command: +.br .BR lvm.conf (5) .B activation/activation_mode -.br -controls the activation mode when not specified by the command. - +.P The default value is printed by: -.nf -lvmconfig --type default activation/activation_mode -.fi - +.br +# lvmconfig --type default activation/activation_mode +. .SS Replacing Devices - +. Devices in a RAID LV can be replaced by other devices in the VG. When replacing devices that are no longer visible on the system, use lvconvert --repair. When replacing devices that are still visible, use lvconvert @@ -655,16 +664,16 @@ replacing devices that are no longer visible on the system, use lvconvert of data LVs that were previously in the LV. The replace option can be repeated to replace multiple PVs. Replacement devices can be optionally listed with either option. - +.P .B lvconvert --repair .I LV [\fINewPVs\fP] - +.P .B lvconvert --replace \fIOldPV\fP .I LV [\fINewPV\fP] - +.P .B lvconvert .B --replace \fIOldPV1\fP @@ -673,120 +682,86 @@ listed with either option. ... .I LV [\fINewPVs\fP] - -New devices require synchronization with existing devices, see +.P +New devices require synchronization with existing devices. +.br +See .BR Synchronization . - +. .SS Refreshing an LV - +. Refreshing a RAID LV clears any transient device failures (device was temporarily disconnected) and returns the LV to its fully redundant mode. Restoring a device will usually require at least partial synchronization (see \fBSynchronization\fP). Failure to clear a transient failure results in the RAID LV operating in degraded mode until it is reactivated. Use the lvchange command to refresh an LV: - +.P .B lvchange --refresh .I LV - +.P .nf # lvs -o name,vgname,segtype,attr,size vg LV VG Type Attr LSize lv vg raid1 Rwi-a-r-r- 100.00g - +.P # lvchange --refresh vg/lv - +.P # lvs -o name,vgname,segtype,attr,size vg LV VG Type Attr LSize lv vg raid1 Rwi-a-r--- 100.00g .fi - +. .SS Automatic repair - +. If a device in a RAID LV fails, device-mapper in the kernel notifies the .BR dmeventd (8) monitoring process (see \fBMonitoring\fP). dmeventd can be configured to automatically respond using: - +.br .BR lvm.conf (5) .B activation/raid_fault_policy - +.P Possible settings are: - +. +.TP .B warn -.br A warning is added to the system log indicating that a device has failed in the RAID LV. It is left to the user to repair the LV, e.g. replace failed devices. - +. +.TP .B allocate -.br dmeventd automatically attempts to repair the LV using spare devices in the VG. Note that even a transient failure is treated as a permanent failure under this setting. A new device is allocated and full synchronization is started. - -The specific command run by dmeventd to warn or repair is: +.P +The specific command run by \fBdmeventd\fP(8) to warn or repair is: .br .B lvconvert --repair --use-policies .I LV - - +. .SS Corrupted Data - +. Data on a device can be corrupted due to hardware errors without the device ever being disconnected or there being any fault in the software. This should be rare, and can be detected (see \fBScrubbing\fP). - - +. .SS Rebuild specific PVs - +. If specific PVs in a RAID LV are known to have corrupt data, the data on those PVs can be reconstructed with: - +.P .B lvchange --rebuild .I PV .I LV - +.P The rebuild option can be repeated with different PVs to replace the data on multiple PVs. - - -.SH Monitoring - -When a RAID LV is activated the \fBdmeventd\fP(8) process is started to -monitor the health of the LV. Various events detected in the kernel can -cause a notification to be sent from device-mapper to the monitoring -process, including device failures and synchronization completion (e.g. -for initialization or scrubbing). - -The LVM configuration file contains options that affect how the monitoring -process will respond to failure events (e.g. raid_fault_policy). It is -possible to turn on and off monitoring with lvchange, but it is not -recommended to turn this off unless you have a thorough knowledge of the -consequences. - - -.SH Configuration Options - -There are a number of options in the LVM configuration file that affect -the behavior of RAID LVs. The tunable options are listed -below. A detailed description of each can be found in the LVM -configuration file itself. -.br - mirror_segtype_default -.br - raid10_segtype_default -.br - raid_region_size -.br - raid_fault_policy -.br - activation_mode - - -.SH Data Integrity - +. +.SH DATA INTEGRITY +. The device mapper integrity target can be used in combination with RAID levels 1,4,5,6,10 to detect and correct data corruption in RAID images. A dm-integrity layer is placed above each RAID image, and an extra sub LV is @@ -795,30 +770,28 @@ When data is read from an image, integrity checksums are used to detect corruption. If detected, dm-raid reads the data from another (good) image to return to the caller. dm-raid will also automatically write the good data back to the image with bad data to correct the corruption. - +.P When creating a RAID LV with integrity, or adding integrity, space is required for integrity metadata. Every 500MB of LV data requires an additional 4MB to be allocated for integrity metadata, for each RAID image. - +.P Create a RAID LV with integrity: - -.B lvcreate \-\-type raidN \-\-raidintegrity y - +.br +.B lvcreate --type raidN --raidintegrity y +.P Add integrity to an existing RAID LV: - -.B lvconvert --raidintegrity y -.I LV - +.br +.B lvconvert --raidintegrity y \fILV +.P Remove integrity from a RAID LV: - -.B lvconvert --raidintegrity n -.I LV - +.br +.B lvconvert --raidintegrity n \fILV +. .SS Integrity options - -.B --raidintegritymode journal|bitmap - +. +.TP +.BR --raidintegritymode " " journal | bitmap Use a journal (default) or bitmap for keeping integrity checksums consistent in case of a crash. The bitmap areas are recalculated after a crash, so corruption in those areas would not be detected. A journal does @@ -827,181 +800,175 @@ can improve performance for scattered writes packed into a single journal write. bitmap mode can in theory achieve full write throughput of the device, but would not benefit from the potential scattered write optimization. - -.B --raidintegrityblocksize 512|1024|2048|4096 - +. +.TP +.BR --raidintegrityblocksize " " 512 | 1024 | 2048 | 4096 The block size to use for dm-integrity on raid images. The integrity block size should usually match the device logical block size, or the file system sector/block sizes. It may be less than the file system sector/block size, but not less than the device logical block size. Possible values: 512, 1024, 2048, 4096. - +. .SS Integrity initialization - +. When integrity is added to an LV, the kernel needs to initialize the integrity metadata (checksums) for all blocks in the LV. The data corruption checking performed by dm-integrity will only operate on areas of the LV that are already initialized. The progress of integrity initialization is reported by the "syncpercent" LV reporting field (and under the Cpy%Sync lvs column.) - +. .SS Integrity limitations - +. To work around some limitations, it is possible to remove integrity from the LV, make the change, then add integrity again. (Integrity metadata would need to initialized when added again.) - +.P LVM must be able to allocate the integrity metadata sub LV on a single PV that is already in use by the associated RAID image. This can potentially cause a problem during lvextend if the original PV holding the image and integrity metadata is full. To work around this limitation, remove integrity, extend the LV, and add integrity again. - +.P Additional RAID images can be added to raid1 LVs, but not to other raid levels. - +.P A raid1 LV with integrity cannot be converted to linear (remove integrity to do this.) - +.P RAID LVs with integrity cannot yet be used as sub LVs with other LV types. - +.P The following are not yet permitted on RAID LVs with integrity: lvreduce, pvmove, snapshots, splitmirror, raid syncaction commands, raid rebuild. - -.SH RAID1 Tuning - +. +.SH RAID1 TUNING +. A RAID1 LV can be tuned so that certain devices are avoided for reading while all devices are still written to. - +.P .B lvchange .BR -- [ raid ] writemostly \fIPV\fP[\fB:y\fP|\fBn\fP|\fBt\fP] .I LV - +.P The specified device will be marked as "write mostly", which means that reading from this device will be avoided, and other devices will be preferred for reading (unless no other devices are available.) This minimizes the I/O to the specified device. - +.P If the PV name has no suffix, the write mostly attribute is set. If the PV name has the suffix \fB:n\fP, the write mostly attribute is cleared, and the suffix \fB:t\fP toggles the current setting. - +.P The write mostly option can be repeated on the command line to change multiple devices at once. - +.P To report the current write mostly setting, the lvs attr field will show the letter "w" in the 9th position when write mostly is set: - +.P .B lvs -a -o name,attr - +.P When a device is marked write mostly, the maximum number of outstanding writes to that device can be configured. Once the maximum is reached, further writes become synchronous. When synchronous, a write to the LV will not complete until writes to all the mirror images are complete. - +.P .B lvchange .BR -- [ raid ] writebehind .I Number .I LV - +.P To report the current write behind setting, run: - +.P .B lvs -o name,raid_write_behind - +.P When write behind is not configured, or set to 0, all LV writes are synchronous. - - -.SH RAID Takeover - +. +.SH RAID TAKEOVER +. RAID takeover is converting a RAID LV from one RAID level to another, e.g. raid5 to raid6. Changing the RAID level is usually done to increase or decrease resilience to device failures or to restripe LVs. This is done using lvconvert and specifying the new RAID level as the LV type: - +.P .B lvconvert --type .I RaidLevel .I LV [\fIPVs\fP] - +.P The most common and recommended RAID takeover conversions are: - -.HP -\fBlinear\fP to \fBraid1\fP -.br +. +.TP +.BR linear " to " raid1 Linear is a single image of LV data, and converting it to raid1 adds a mirror image which is a direct copy of the original linear image. - -.HP -\fBstriped\fP/\fBraid0\fP to \fBraid4/5/6\fP -.br +. +.TP +.BR striped / raid0 " to " raid4 / 5 / 6 Adding parity devices to a striped volume results in raid4/5/6. - .P - Unnatural conversions that are not recommended include converting between striped and non-striped types. This is because file systems often optimize I/O patterns based on device striping values. If those values change, it can decrease performance. - +.P Converting to a higher RAID level requires allocating new SubLVs to hold RAID metadata, and new SubLVs to hold parity blocks for LV data. Converting to a lower RAID level removes the SubLVs that are no longer needed. - +.P Conversion often requires full synchronization of the RAID LV (see \fBSynchronization\fP). Converting to RAID1 requires copying all LV data blocks to N new images on new devices. Converting to a parity RAID level requires reading all LV data blocks, calculating parity, and writing the new parity blocks. Synchronization can take a long time depending on the throughpout of the devices used and the size of the RaidLV. It can degrade -performance (rate controls also apply to conversion; see -\fB--minrecoveryrate\fP -and -\fB--maxrecoveryrate\fP.) - +performance. Rate controls also apply to conversion; see +\fB--minrecoveryrate\fP and \fB--maxrecoveryrate\fP. +.P Warning: though it is possible to create \fBstriped\fP LVs with up to 128 stripes, a maximum of 64 stripes can be converted to \fBraid0\fP, 63 to \fBraid4/5\fP and 62 to \fBraid6\fP because of the added parity SubLVs. A \fBstriped\fP LV with a maximum of 32 stripes can be converted to \fBraid10\fP. - +. .P - +. The following takeover conversions are currently possible: .br -.IP \(bu 3 +.ipbu between striped and raid0. -.IP \(bu 3 +.ipbu between linear and raid1. -.IP \(bu 3 +.ipbu between mirror and raid1. -.IP \(bu 3 +.ipbu between raid1 with two images and raid4/5. -.IP \(bu 3 +.ipbu between striped/raid0 and raid4. -.IP \(bu 3 +.ipbu between striped/raid0 and raid5. -.IP \(bu 3 +.ipbu between striped/raid0 and raid6. -.IP \(bu 3 +.ipbu between raid4 and raid5. -.IP \(bu 3 +.ipbu between raid4/raid5 and raid6. -.IP \(bu 3 +.ipbu between striped/raid0 and raid10. -.IP \(bu 3 +.ipbu between striped and raid4. - +.PD +. .SS Indirect conversions - +. Converting from one raid level to another may require multiple steps, converting first to intermediate raid levels. - -.B linear to raid6 - +.P +.BR linear " to " raid6 +.P To convert an LV from linear to raid6: .br 1. convert to raid1 with two images @@ -1013,7 +980,7 @@ To convert an LV from linear to raid6: 4. convert to raid6 (internally raid6_ls_6) .br 5. convert to raid6 (internally raid6_zr, reshape) - +.P The commands to perform the steps above are: .br 1. lvconvert --type raid1 --mirrors 1 LV @@ -1025,14 +992,14 @@ The commands to perform the steps above are: 4. lvconvert --type raid6 LV .br 5. lvconvert --type raid6 LV - +.P The final conversion from raid6_ls_6 to raid6_zr is done to avoid the potential write/recovery performance reduction in raid6_ls_6 because of the dedicated parity device. raid6_zr rotates data and parity blocks to avoid this. - -.B linear to striped - +.P +.BR linear " to " striped +.P To convert an LV from linear to striped: .br 1. convert to raid1 with two images @@ -1042,7 +1009,7 @@ To convert an LV from linear to striped: 3. convert to raid5_n with five 128k stripes (reshape) .br 4. convert raid5_n to striped - +.P The commands to perform the steps above are: .br 1. lvconvert --type raid1 --mirrors 1 LV @@ -1052,41 +1019,40 @@ The commands to perform the steps above are: 3. lvconvert --stripes 5 --stripesize 128k LV .br 4. lvconvert --type striped LV - +.P The raid5_n type in step 2 is used because it has dedicated parity SubLVs at the end, and can be converted to striped directly. The stripe size is increased in step 3 to add extra space for the conversion process. This step grows the LV size by a factor of five. After conversion, this extra space can be reduced (or used to grow the file system using the LV). - +.P Reversing these steps will convert a striped LV to linear. - -.B raid6 to striped - +.P +.BR raid6 " to " striped +.P To convert an LV from raid6_nr to striped: .br 1. convert to raid6_n_6 .br 2. convert to striped - +.P The commands to perform the steps above are: .br 1. lvconvert --type raid6_n_6 LV .br 2. lvconvert --type striped LV - - -.SS Examples - +.P +.I Examples +.P Converting an LV from \fBlinear\fP to \fBraid1\fP. - +.P .nf # lvs -a -o name,segtype,size vg LV Type LSize lv linear 300.00g - +.P # lvconvert --type raid1 --mirrors 1 vg/lv - +.P # lvs -a -o name,segtype,size vg LV Type LSize lv raid1 300.00g @@ -1095,9 +1061,9 @@ Converting an LV from \fBlinear\fP to \fBraid1\fP. [lv_rmeta_0] linear 3.00m [lv_rmeta_1] linear 3.00m .fi - +.P Converting an LV from \fBmirror\fP to \fBraid1\fP. - +.P .nf # lvs -a -o name,segtype,size vg LV Type LSize @@ -1105,9 +1071,9 @@ Converting an LV from \fBmirror\fP to \fBraid1\fP. [lv_mimage_0] linear 100.00g [lv_mimage_1] linear 100.00g [lv_mlog] linear 3.00m - +.P # lvconvert --type raid1 vg/lv - +.P # lvs -a -o name,segtype,size vg LV Type LSize lv raid1 100.00g @@ -1116,20 +1082,20 @@ Converting an LV from \fBmirror\fP to \fBraid1\fP. [lv_rmeta_0] linear 3.00m [lv_rmeta_1] linear 3.00m .fi - +.P Converting an LV from \fBlinear\fP to \fBraid1\fP (with 3 images). - +.P .nf # lvconvert --type raid1 --mirrors 2 vg/lv .fi - +.P Converting an LV from \fBstriped\fP (with 4 stripes) to \fBraid6_n_6\fP. - +.P .nf # lvcreate --stripes 4 -L64M -n lv vg - +.P # lvconvert --type raid6 vg/lv - +.P # lvs -a -o lv_name,segtype,sync_percent,data_copies LV Type Cpy%Sync #Cpy lv raid6_n_6 100.00 3 @@ -1146,42 +1112,41 @@ Converting an LV from \fBstriped\fP (with 4 stripes) to \fBraid6_n_6\fP. [lv_rmeta_4] linear [lv_rmeta_5] linear .fi - +.P This convert begins by allocating MetaLVs (rmeta_#) for each of the existing stripe devices. It then creates 2 additional MetaLV/DataLV pairs (rmeta_#/rimage_#) for dedicated raid6 parity. - +.P If rotating data/parity is required, such as with raid6_nr, it must be done by reshaping (see below). - - -.SH RAID Reshaping - +. +.SH RAID RESHAPING +. RAID reshaping is changing attributes of a RAID LV while keeping the same RAID level. This includes changing RAID layout, stripe size, or number of stripes. - +.P When changing the RAID layout or stripe size, no new SubLVs (MetaLVs or DataLVs) need to be allocated, but DataLVs are extended by a small amount (typically 1 extent). The extra space allows blocks in a stripe to be updated safely, and not be corrupted in case of a crash. If a crash occurs, reshaping can just be restarted. - +.P (If blocks in a stripe were updated in place, a crash could leave them partially updated and corrupted. Instead, an existing stripe is quiesced, read, changed in layout, and the new stripe written to free space. Once that is done, the new stripe is unquiesced and used.) - -.SS Examples - +.P +.I Examples +.br (Command output shown in examples may change.) - +.P Converting raid6_n_6 to raid6_nr with rotating data/parity. - +.P This conversion naturally follows a previous conversion from striped/raid0 to raid6_n_6 (shown above). It completes the transition to a more traditional RAID6. - +.P .nf # lvs -o lv_name,segtype,sync_percent,data_copies LV Type Cpy%Sync #Cpy @@ -1198,9 +1163,9 @@ traditional RAID6. [lv_rmeta_3] linear [lv_rmeta_4] linear [lv_rmeta_5] linear - +.P # lvconvert --type raid6_nr vg/lv - +.P # lvs -a -o lv_name,segtype,sync_percent,data_copies LV Type Cpy%Sync #Cpy lv raid6_nr 100.00 3 @@ -1221,10 +1186,10 @@ traditional RAID6. [lv_rmeta_4] linear [lv_rmeta_5] linear .fi - +.P The DataLVs are larger (additional segment in each) which provides space for out-of-place reshaping. The result is: - +.P .nf # lvs -a -o lv_name,segtype,seg_pe_ranges,dataoffset LV Type PE Ranges DOff @@ -1243,14 +1208,14 @@ for out-of-place reshaping. The result is: [lv_rmeta_2] linear /dev/sdab:0-0 [lv_rmeta_3] linear /dev/sdac:0-0 .fi - +.P All segments with PE ranges '33-33' provide the out-of-place reshape space. The dataoffset column shows that the data was moved from initial offset 0 to 2048 sectors on each component DataLV. - +.P For performance reasons the raid6_nr RaidLV can be restriped. Convert it from 3-way striped to 5-way-striped. - +.P .nf # lvconvert --stripes 5 vg/lv Using default stripesize 64.00 KiB. @@ -1259,11 +1224,11 @@ Convert it from 3-way striped to 5-way-striped. Run "lvresize -l99 vg/lv" to shrink it or use the additional \\ capacity. Logical volume vg/lv successfully converted. - +.P # lvs vg/lv LV VG Attr LSize Cpy%Sync lv vg rwi-a-r-s- 652.00m 52.94 - +.P # lvs -a -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff lv rwi-a-r--- raid6_nr lv_rimage_0:0-33 \\ @@ -1289,12 +1254,12 @@ Convert it from 3-way striped to 5-way-striped. [lv_rmeta_5] ewi-aor--- linear /dev/sdae:0-0 [lv_rmeta_6] ewi-aor--- linear /dev/sdaf:0-0 .fi - +.P Stripes also can be removed from raid5 and 6. Convert the 5-way striped raid6_nr LV to 4-way-striped. The force option needs to be used, because removing stripes (i.e. image SubLVs) from a RaidLV will shrink its size. - +.P .nf # lvconvert --stripes 4 vg/lv Using default stripesize 64.00 KiB. @@ -1307,7 +1272,7 @@ The force option needs to be used, because removing stripes WARNING: to remove freed stripes after the conversion has finished,\\ you have to run "lvconvert --stripes 4 vg/lv" Logical volume vg/lv successfully converted. - +.P # lvs -a -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff lv rwi-a-r-s- raid6_nr lv_rimage_0:0-33 \\ @@ -1333,10 +1298,10 @@ The force option needs to be used, because removing stripes [lv_rmeta_5] ewi-aor--- linear /dev/sdae:0-0 [lv_rmeta_6] ewi-aor-R- linear /dev/sdaf:0-0 .fi - +.P The 's' in column 9 of the attribute field shows the RaidLV is still reshaping. The 'R' in the same column of the attribute field shows the freed image Sub LVs which will need removing once the reshaping finished. - +.P .nf # lvs -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff @@ -1346,9 +1311,9 @@ The 'R' in the same column of the attribute field shows the freed image Sub LVs lv_rimage_5:0-33 \\ lv_rimage_6:0-33 8192 .fi - +.P Now that the reshape is finished the 'R' attribute on the RaidLV shows images can be removed. - +.P .nf # lvs -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff @@ -1358,14 +1323,14 @@ Now that the reshape is finished the 'R' attribute on the RaidLV shows images ca lv_rimage_5:0-33 \\ lv_rimage_6:0-33 8192 .fi - +.P This is achieved by repeating the command ("lvconvert --stripes 4 vg/lv" would be sufficient). - +.P .nf # lvconvert --stripes 4 vg/lv Using default stripesize 64.00 KiB. Logical volume vg/lv successfully converted. - +.P # lvs -a -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff lv rwi-a-r--- raid6_nr lv_rimage_0:0-33 \\ @@ -1387,7 +1352,7 @@ This is achieved by repeating the command ("lvconvert --stripes 4 vg/lv" would b [lv_rmeta_3] ewi-aor--- linear /dev/sdac:0-0 [lv_rmeta_4] ewi-aor--- linear /dev/sdad:0-0 [lv_rmeta_5] ewi-aor--- linear /dev/sdae:0-0 - +.P # lvs -a -o lv_name,attr,segtype,reshapelen vg LV Attr Type RSize lv rwi-a-r--- raid6_nr 24.00m @@ -1407,17 +1372,17 @@ This is achieved by repeating the command ("lvconvert --stripes 4 vg/lv" would b [lv_rmeta_4] ewi-aor--- linear [lv_rmeta_5] ewi-aor--- linear .fi - +.P Future developments might include automatic removal of the freed images. - +.P If the reshape space shall be removed any lvconvert command not changing the layout can be used: - +.P .nf # lvconvert --stripes 4 vg/lv Using default stripesize 64.00 KiB. No change in RAID LV vg/lv layout, freeing reshape space. Logical volume vg/lv successfully converted. - +.P # lvs -a -o lv_name,attr,segtype,reshapelen vg LV Attr Type RSize lv rwi-a-r--- raid6_nr 0 @@ -1437,9 +1402,9 @@ If the reshape space shall be removed any lvconvert command not changing the lay [lv_rmeta_4] ewi-aor--- linear [lv_rmeta_5] ewi-aor--- linear .fi - +.P In case the RaidLV should be converted to striped: - +.P .nf # lvconvert --type striped vg/lv Unable to convert LV vg/lv from raid6_nr to striped. @@ -1453,11 +1418,11 @@ In case the RaidLV should be converted to striped: raid6_rs_6 raid6_n_6 .fi - +.P A direct conversion isn't possible thus the command informed about the possible ones. raid6_n_6 is suitable to convert to striped so convert to it first (this is a reshape changing the raid6 layout from raid6_nr to raid6_n_6). - +.P .nf # lvconvert --type raid6_n_6 Using default stripesize 64.00 KiB. @@ -1465,13 +1430,13 @@ changing the raid6 layout from raid6_nr to raid6_n_6). Are you sure you want to convert raid6_nr LV vg/lv? [y/n]: y Logical volume vg/lv successfully converted. .fi - +.P Wait for the reshape to finish. - +.P .nf # lvconvert --type striped vg/lv Logical volume vg/lv successfully converted. - +.P # lvs -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff lv -wi-a----- striped /dev/sda:2-32 \\ @@ -1483,14 +1448,14 @@ Wait for the reshape to finish. /dev/sdab:34-35 \\ /dev/sdac:34-35 .fi - +.P From striped we can convert to raid10 - +.P .nf # lvconvert --type raid10 vg/lv Using default stripesize 64.00 KiB. Logical volume vg/lv successfully converted. - +.P # lvs -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg LV Attr Type PE Ranges DOff lv rwi-a-r--- raid10 lv_rimage_0:0-32 \\ @@ -1498,7 +1463,7 @@ From striped we can convert to raid10 lv_rimage_1:0-32 ... \\ lv_rimage_3:0-32 \\ lv_rimage_7:0-32 0 - +.P # lvs -a -o lv_name,attr,segtype,seg_pe_ranges,dataoffset vg WARNING: Cannot find matching striped segment for vg/lv_rimage_3. LV Attr Type PE Ranges DOff @@ -1527,29 +1492,28 @@ From striped we can convert to raid10 [lv_rmeta_6] ewi-aor--- linear /dev/sdaf:0-0 [lv_rmeta_7] ewi-aor--- linear /dev/sdag:0-0 .fi - +.P raid10 allows to add stripes but can't remove them. - - +.P A more elaborate example to convert from linear to striped with interim conversions to raid1 then raid5 followed by restripe (4 steps). - +.P We start with the linear LV. - +.P .nf # lvs -a -o name,size,segtype,syncpercent,datastripes,\\ stripesize,reshapelenle,devices vg LV LSize Type Cpy%Sync #DStr Stripe RSize Devices lv 128.00m linear 1 0 /dev/sda(0) .fi - +.P Then convert it to a 2-way raid1. - +.P .nf # lvconvert --mirrors 1 vg/lv Logical volume vg/lv successfully converted. - +.P # lvs -a -o name,size,segtype,datastripes,\\ stripesize,reshapelenle,devices vg LV LSize Type #DStr Stripe RSize Devices @@ -1560,17 +1524,17 @@ Then convert it to a 2-way raid1. [lv_rmeta_0] 4.00m linear 1 0 /dev/sda(32) [lv_rmeta_1] 4.00m linear 1 0 /dev/sdhx(0) .fi - +.P Once the raid1 LV is fully synchronized we convert it to raid5_n (only 2-way raid1 LVs can be converted to raid5). We select raid5_n here because it has dedicated parity SubLVs at the end and can be converted to striped directly without any additional conversion. - +.P .nf # lvconvert --type raid5_n vg/lv Using default stripesize 64.00 KiB. Logical volume vg/lv successfully converted. - +.P # lvs -a -o name,size,segtype,syncpercent,datastripes,\\ stripesize,reshapelenle,devices vg LV LSize Type #DStr Stripe RSize Devices @@ -1581,12 +1545,12 @@ conversion. [lv_rmeta_0] 4.00m linear 1 0 /dev/sda(32) [lv_rmeta_1] 4.00m linear 1 0 /dev/sdhx(0) .fi - +.P Now we'll change the number of data stripes from 1 to 5 and request 128K stripe size in one command. This will grow the size of the LV by a factor of 5 (we add 4 data stripes to the one given). That additional space can be used by e.g. growing any contained filesystem or the LV can be reduced in size after the reshaping conversion has finished. - +.P .nf # lvconvert --stripesize 128k --stripes 5 vg/lv Converting stripesize 64.00 KiB of raid5_n LV vg/lv to 128.00 KiB. @@ -1594,7 +1558,7 @@ or the LV can be reduced in size after the reshaping conversion has finished. it from 32 to 160 extents! Run "lvresize -l32 vg/lv" to shrink it or use the additional capacity. Logical volume vg/lv successfully converted. - +.P # lvs -a -o name,size,segtype,datastripes,\\ stripesize,reshapelenle,devices LV LSize Type #DStr Stripe RSize Devices @@ -1623,13 +1587,13 @@ or the LV can be reduced in size after the reshaping conversion has finished. [lv_rmeta_4] 4.00m linear 1 0 /dev/sdhu(0) [lv_rmeta_5] 4.00m linear 1 0 /dev/sdht(0) .fi - +.P Once the conversion has finished we can can convert to striped. - +.P .nf # lvconvert --type striped vg/lv Logical volume vg/lv successfully converted. - +.P # lvs -a -o name,size,segtype,datastripes,\\ stripesize,reshapelenle,devices vg LV LSize Type #DStr Stripe RSize Devices @@ -1644,194 +1608,168 @@ Once the conversion has finished we can can convert to striped. /dev/sdhv(1),\\ /dev/sdhu(1) .fi - +.P Reversing these steps will convert a given striped LV to linear. - +.P Mind the facts that stripes are removed thus the capacity of the RaidLV will shrink and that changing the RaidLV layout will influence its performance. - +.P "lvconvert --stripes 1 vg/lv" for converting to 1 stripe will inform upfront about the reduced size to allow for resizing the content or growing the RaidLV before actually converting to 1 stripe. The \fB--force\fP option is needed to allow stripe removing conversions to prevent data loss. - -Of course any interim step can be the intended last one (e.g. striped -> raid1). -.. - -.SH RAID5 Variants - +.P +Of course any interim step can be the intended last one (e.g. striped \[->] raid1). +. +.SH RAID5 VARIANTS +. +.TP raid5_ls -.br -\[bu] +.ipbu RAID5 left symmetric -.br -\[bu] +.ipbu Rotating parity N with data restart - +. +.TP raid5_la -.br -\[bu] -RAID5 left symmetric -.br -\[bu] +.ipbu +RAID5 left asymmetric +.ipbu Rotating parity N with data continuation - +. +.TP raid5_rs -.br -\[bu] +.ipbu RAID5 right symmetric -.br -\[bu] +.ipbu Rotating parity 0 with data restart - +. +.TP raid5_ra -.br -\[bu] +.ipbu RAID5 right asymmetric -.br -\[bu] +.ipbu Rotating parity 0 with data continuation - +. +.TP raid5_n -.br -\[bu] +.ipbu RAID5 parity n -.br -\[bu] +.ipbu Dedicated parity device n used for striped/raid0 conversions -.br -\[bu] +.ipbu Used for RAID Takeover - -.SH RAID6 Variants - -raid6 -.br -\[bu] +. +.SH RAID6 VARIANTS +. +.TP +.RB raid6\ \ " " +.ipbu RAID6 zero restart (aka left symmetric) -.br -\[bu] +.ipbu Rotating parity 0 with data restart -.br -\[bu] +.ipbu Same as raid6_zr - +. +.TP raid6_zr -.br -\[bu] +.ipbu RAID6 zero restart (aka left symmetric) -.br -\[bu] +.ipbu Rotating parity 0 with data restart - +. +.TP raid6_nr -.br -\[bu] +.ipbu RAID6 N restart (aka right symmetric) -.br -\[bu] +.ipbu Rotating parity N with data restart - +. +.TP raid6_nc -.br -\[bu] +.ipbu RAID6 N continue -.br -\[bu] +.ipbu Rotating parity N with data continuation - +. +.TP raid6_n_6 -.br -\[bu] +.ipbu RAID6 last parity devices -.br -\[bu] +.ipbu Fixed dedicated last devices (P-Syndrome N-1 and Q-Syndrome N) -.RS 2 with striped data used for striped/raid0 conversions -.RE -.br -\[bu] +.ipbu Used for RAID Takeover - +. +.TP raid6_{ls,rs,la,ra}_6 -.br -\[bu] +.ipbu RAID6 last parity device -.br -\[bu] +.ipbu Dedicated last parity device used for conversions from/to -.RS 2 raid5_{ls,rs,la,ra} -.RE - +. +.TP raid6_ls_6 -.br -\[bu] +.ipbu RAID6 N continue -.br -\[bu] +.ipbu Same as raid5_ls for N-1 devices with fixed Q-Syndrome N -.br -\[bu] +.ipbu Used for RAID Takeover - +. +.TP raid6_la_6 -.br -\[bu] +.ipbu RAID6 N continue -.br -\[bu] +.ipbu Same as raid5_la for N-1 devices with fixed Q-Syndrome N -.br -\[bu] +.ipbu Used forRAID Takeover - +. +.TP raid6_rs_6 -.br -\[bu] +.ipbu RAID6 N continue -.br -\[bu] +.ipbu Same as raid5_rs for N-1 devices with fixed Q-Syndrome N -.br -\[bu] +.ipbu Used for RAID Takeover - +. +.TP raid6_ra_6 -.br -\[bu] +.ipbu RAID6 N continue -.br -\[bu] -ame as raid5_ra for N-1 devices with fixed Q-Syndrome N -.br -\[bu] +.ipbu +Same as raid5_ra for N-1 devices with fixed Q-Syndrome N +.ipbu Used for RAID Takeover - - +. +. .ig -.SH RAID Duplication - +. +.SH RAID DUPLICATION +. RAID LV conversion (takeover or reshaping) can be done out-of-place by copying the LV data onto new devices while changing the RAID properties. Copying avoids modifying the original LV but requires additional devices. Once the LV data has been copied/converted onto the new devices, there are multiple options: - +.P 1. The RAID LV can be switched over to run from just the new devices, and the original copy of the data removed. The converted LV then has the new RAID properties, and exists on new devices. The old devices holding the original data can be removed or reused. - +.P 2. The new copy of the data can be dropped, leaving the original RAID LV unchanged and using its original devices. - +.P 3. The new copy of the data can be separated and used as a new independent LV, leaving the original RAID LV unchanged on its original devices. - +.P The command to start duplication is: - +.P .B lvconvert --type .I RaidLevel [\fB--stripes\fP \fINumber\fP \fB--stripesize\fP \fISize\fP] @@ -1840,76 +1778,72 @@ The command to start duplication is: .I LV [\fIPVs\fP] .RE - -.HP +.P +.TP .B --duplicate .br Specifies that the LV conversion should be done out-of-place, copying LV data to new devices while converting. - -.HP +.P +.TP .BR --type , --stripes , --stripesize .br Specifies the RAID properties to use when creating the copy. - .P \fIPVs\fP specifies the new devices to use. - +.P The steps in the duplication process: - -.IP \(bu 3 +.P +.ipbu LVM creates a new LV on new devices using the specified RAID properties (type, stripes, etc) and optionally specified devices. - -.IP \(bu 3 +.P +.ipbu LVM changes the visible RAID LV to type raid1, making the original LV the first raid1 image (SubLV 0), and the new LV the second raid1 image (SubLV 1). - -.IP \(bu 3 +.P +.ipbu The RAID1 synchronization process copies data from the original LV image (SubLV 0) to the new LV image (SubLV 1). - -.IP \(bu 3 +.P +.ipbu When synchronization is complete, the original and new LVs are mirror images of each other and can be separated. - .P - The duplication process retains both the original and new LVs (both SubLVs) until an explicit unduplicate command is run to separate them. The unduplicate command specifies if the original LV should use the old devices (SubLV 0) or the new devices (SubLV 1). - +.P To make the RAID LV use the data on the old devices, and drop the copy on the new devices, specify the name of SubLV 0 (suffix _dup_0): - +.P .B lvconvert --unduplicate .BI --name .IB LV _dup_0 .I LV - +.P To make the RAID LV use the data copy on the new devices, and drop the old devices, specify the name of SubLV 1 (suffix _dup_1): - +.P .B lvconvert --unduplicate .BI --name .IB LV _dup_1 .I LV - +.P FIXME: To make the LV use the data on the original devices, but keep the data copy as a new LV, ... - +.P FIXME: include how splitmirrors can be used. - - -.SH RAID1E - +. +.SS RAID1E +. TODO .. - -.SH History - +. +.SH HISTORY +. The 2.6.38-rc1 version of the Linux kernel introduced a device-mapper target to interface with the software RAID (MD) personalities. This provided device-mapper with RAID 4/5/6 capabilities and a larger @@ -1919,4 +1853,15 @@ added to LVM version 2.02.87. The capabilities of the LVM \fBraid1\fP type have surpassed the old \fBmirror\fP type. raid1 is now recommended instead of mirror. raid1 became the default for mirroring in LVM version 2.02.100. - +. +.SH SEE ALSO +. +.nh +.ad l +.BR lvm (8), +.BR lvm.conf (5), +.BR lvcreate (8), +.BR lvconvert (8), +.BR lvchange (8), +.BR lvextend (8), +.BR dmeventd (8) diff --git a/man/lvmreport.7_main b/man/lvmreport.7_main index c13e7789c..f0f04ad1c 100644 --- a/man/lvmreport.7_main +++ b/man/lvmreport.7_main @@ -1,24 +1,32 @@ .TH "LVMREPORT" "7" "LVM TOOLS #VERSION#" "Red Hat, Inc" "\"" - +. .SH NAME +. lvmreport \(em LVM reporting and related features - +. .SH DESCRIPTION +. LVM uses single reporting infrastructure that sets standard on LVM command's output and it provides wide range of configuration settings and command line options to customize report and filter the report's output. - -.SH Categorization based on reporting facility - +. +.SH USAGE +. +.SS Categorization based on reporting facility +. Based on functionality, commands which make use of the reporting infrastructure are divided in two groups: -.IP \fBReport-oriented commands\fP +. +.TP +.B Report-oriented commands These commands inform about current LVM state and their primary role is to display this information in compendious way. To make a distinction, we will name this report as \fBmain report\fP. The set of report-only commands include: pvs, vgs, lvs, pvdisplay, vgdisplay, lvdisplay, lvm devtypes, lvm fullreport. -For further information about main report, see \fBmain report specifics\fP. -.IP \fBProcessing-oriented commands\fP +For further information about main report, see \fBMain report specifics\fP. +. +.TP +.B Processing-oriented commands These commands are responsible for changing LVM state and they do not contain any main report as identified for report-oriented commands, they only perform some kind of processing. The set of processing-oriented commands includes: @@ -26,18 +34,17 @@ pvcreate, vgcreate, lvcreate, pvchange, vgchange, lvchange, pvremove, vgremove, lvremove, pvresize, vgextend, vgreduce, lvextend, lvreduce, lvresize, lvrename, pvscan, vgscan, lvscan, pvmove, vgcfgbackup, vgck, vgconvert, vgexport, vgimport, vgmknodes. - +.P .RE If enabled, so called \fBlog report\fP is either displayed solely (for processing-oriented commands) or in addition to main report (for report-oriented commands). The log report contains a log of operations, messages and per-object status with complete object identification collected -during LVM command execution. See \fBlog report specifics\fP for more +during LVM command execution. See \fBLog report specifics\fP for more information about this report type. - - -.SH Terms - +. +.SS Terms +. When describing reporting functionality and features in this text, we will use terms \fBrow\fP and \fBcolumn\fP. By row we mean series of values reported for single entity (for example single PV, VG or LV). Each value from the row @@ -46,66 +53,55 @@ which are short descriptions for the columns. The columns are referenced by \fBcolumn names\fP. Please note that this text is also using term \fBfield\fP interchangeably with the term \fBcolumn\fP. Most of the time the term columns is abbreviated as \fBcol\fP in configuration. - -.SH Common report configuration settings and command line options - +. +.SS Common report configuration settings and command line options +. There are common configuration settings and command line options which apply to both \fBmain report\fP and \fBlog report\fP. Following lists contain all of them, separated into groups based on their use. - -.RS -\fBCommon configuration settings:\fP - -.RS - -.IP \[bu] 3 +. +.SS Common configuration settings +. +.ad l +.TP Changing report output format, composition and other output modifiers: -.RS -.IP - 3 -global/units -.IP - 3 -global/suffix -.IP - 3 -report/output_format -.IP - 3 -report/compact_output -.IP - 3 -report/compact_output_cols -.IP - 3 -report/aligned -.IP - 3 -report/headings -.IP - 3 -report/separator -.IP - 3 -report/list_item_separator -.IP - 3 -report/prefixes -.IP - 3 -report/quoted -.IP - 3 -report/columns_as_rows -.IP - 3 -report/binary_values_as_numeric -.IP - 3 -report/time_format -.IP - 3 -report/mark_hidden_devices -.IP - 3 -report/two_word_unknown_device -.RE - -.IP \[bu] 3 +- global/suffix +.br +- global/units +.br +- report/aligned +.br +- report/binary_values_as_numeric +.br +- report/columns_as_rows +.br +- report/compact_output +.br +- report/compact_output_cols +.br +- report/headings +.br +- report/list_item_separator +.br +- report/mark_hidden_devices +.br +- report/output_format +.br +- report/prefixes +.br +- report/quoted +.br +- report/separator +.br +- report/time_format +.br +- report/two_word_unknown_device +. +.TP Special settings -.RS -.IP - 3 -report/buffered -.RE - -.RE - -.RE - +- report/buffered +.ad b +.P This document does not describe these settings in more detail - if you need detailed information, including values which are accepted for the settings, please run \fBlvmconfig --type default --withcomments <setting>\fP. There are @@ -115,285 +111,286 @@ see \fBmain report specifics\fP and \fBlog report specifics\fP for these settings. Besides configuring reports globally by using configuration settings, there are also command line options you can use to extend, override or further specify the report configuration. - +. +.SS Common command line options +. +.TP +Definition of the set of fields to use .RS -\fBCommon command line options:\fP - -.RS - -.IP \[bu] 3 -Definition of the set set of fields to use -.RS -.IP - 3 ---options|-o FieldSet -.br +. +.TP +.BR -o | --options " " \fIFieldSet Field set to use. See \fBmain report specifics\fP and \fBlog report specifics\fP for information about field sets configured with global configuration settings that this option overrides. -.IP - 3 ---options|-o+ FieldSet -.br +. +.TP +.BR -o | --options " " +\fIFieldSet Fields to include to current field set. See \fBmain report specifics\fP\ and \fBlog report specifics\fP for information about field sets configured with global configuration settings that this option extends. -.IP - 3 ---options|-o- FieldSet -.br +. +.TP +.BR -o | --options " " -\fIFieldSet Fields to exclude from current field set. See \fBmain report specifics\fP and \fBlog report specifics\fP for information about field sets configured with global configuration settings that this option reduces. -.IP - 3 ---options|-o# FieldSet -.br +. +.TP +.BR -o | --options " " # \fIFieldSet Compaction of unused fields. Overrides report/compact_output_cols configuration setting. .RE - -.IP \[bu] 3 +. +.TP Sorting .RS -.IP - 3 ---sort|-O+ FieldSet -.br +. +.TP +.BR -O | --sort " " +\fIFieldSet Fields to sort by in ascending order. See \fBmain report specifics\fP and \fBlog report specifics\fP for information about field sets configured with global configuration settings that this option overrides. -.IP - 3 ---sort|-O- FieldSet -.br +. +.TP +.BR -O | --sort " " -\fIFieldSet Fields to sort by in descending order. See \fBmain report specifics\fP and \fBlog report specifics\fP for information about fields sets configured with global configuration settings that this options overrides. .RE - -.IP \[bu] 3 +. +.TP Selection .RS -.IP - 3 ---select|-S Selection -.br +.TP +.BR -S | --select " " \fISelection Define selection criteria for report output. For \fBlog report\fP, this also overrides log/command_log_selection configuration setting, see also \fBlog report specifics\fP. .RE - -.IP \[bu] 3 +. +.TP Changing output format and composition .RS -.IP - 3 ---reportformat -.br +.TP +.B --reportformat Overrides report/output_format configuration setting. -.IP - 3 ---aligned -.br +.TP +.B --aligned Overrides report/aligned configuration setting. -.IP - 3 ---binary -.br +.TP +.B --binary Overrides report/binary_values_as_numeric configuration setting. -.IP - 3 ---nameprefixes -.br +.TP +.B --nameprefixes Overrides report/prefixes configuration setting. -.IP - 3 ---noheadings -.br +.TP +.B --noheadings Overrides report/noheadings configuration setting. -.IP - 3 ---nosuffix -.br +.TP +.B --nosuffix Overrides global/suffix configuration setting. -.IP - 3 ---rows -.br +.TP +.B --rows Overrides report/columns_as_rows configuration setting. -.IP - 3 ---separator -.br +.TP +.B --separator Overrides report/separator configuration setting. -.IP - 3 ---units -.br +.TP +.B --units Overrides global/units configuration setting. -.IP - 3 ---unquoted -.br +.TP +.B --unquoted Overrides report/quoted configuration setting. .RE - -.IP \[bu] 3 +. +.TP Special options .RS -.IP - 3 ---configreport \fBReportName\fP -.br -This defines the \fBReportName\fP for which any subsequent -o|--columns, --O|--sort or -S|--select applies to. See also \fBmain report specifics\fP -and \fBlog report specifics\fP for possible \fBReportName\fP values. -.IP - 3 ---logonly -.br +. +.TP +.B --configreport \fIReportName +This defines the \fIReportName\fP for which any subsequent +.BR -o | --columns , +.BR -O | --sort +or +.BR -S | --select +applies to. See also +.B Main report specifics +and +.B Log report specifics +for possible \fIReportName\fP values. +. +.TP +.B --logonly When an LVM command contains both \fBmain report\fP and \fBlog report\fP, this option suppresses the \fBmain report\fP output and it causes the \fBlog report\fP output to be displayed only. -.IP - 3 ---unbuffered -.br +. +.TP +.B --unbuffered Overrides report/buffered configuration setting. .RE - -.RE - -.RE - -The \fBFieldSet\fP mentioned in the lists above is a set of field names where -each field name is delimited by "," character. Field set definition, sorting -and selection may be repeated on command line (-o+/-o- includes/excludes fields +.P +The \fIFieldSet\fP mentioned in the lists above is a set of field names where +each field name is delimited by "\fB,\fP" character. Field set definition, sorting +and selection may be repeated on command line (\fB-o\fP\fB+\fP/\fB-o\fP\fB-\fP +includes/excludes fields to/from current list, for all the other repeatable options, the last value typed for the option on the command line is used). The \fBSelection\fP is a string with \fBselection criteria\fP, see also \fBSelection\fP paragraph below for more information about constructing these criteria. - - -.SH Main report specifics - +. +.SS Main report specifics +. The \fBmain report\fP currently encompasses these distinct subtypes, referenced -by their name - \fBReportName\fP as listed below. The command in parenthesis is +by their name - \fIReportName\fP as listed below. The command in parenthesis is representative command that uses the main report subtype by default. Each subtype has its own configuration setting for global field set definition -as well as sort field definition (listed below each individual \fBReportName\fP): - +as well as sort field definition (listed below each individual \fIReportName\fP): +. +.ad l +.nh .RS - -.IP \[bu] 3 -\fBpv\fP representing report about Physical Volumes (\fBpvs\fP) +.TP +.B pv +representing report about Physical Volumes +(pvs) .RS -.IP - 3 -report/pvs_cols -.IP - 3 -report/pvs_sort +- report/pvs_cols +.br +- report/pvs_sort +.br .RE - -.IP \[bu] 3 -\fBpvseg\fP representing report about Physical Volume Segments (\fBpvs --segments\fP) +. +.TP +.B pvseg +representing report about Physical Volume Segments +(pvs\ --segments) .RS -.IP - 3 -report/pvseg_cols -.IP - 3 -report/pvseg_sort +- report/pvseg_cols +.br +- report/pvseg_sort +.br .RE - -.IP \[bu] 3 -\fBvg\fP representing report about Volume Groups (\fBvgs\fP) +. +.TP +.B vg +representing report about Volume Groups (vgs) .RS -.IP - 3 -report/vgs_cols -.IP - 3 -report/vgs_sort +- report/vgs_cols +.br +- report/vgs_sort .RE - -.IP \[bu] 3 -\fBlv\fP representing report about Logical Volumes (\fBlvs\fP) +. +.TP +.B lv +representing report about Logical Volumes (lvs) .RS -.IP - 3 -report/lvs_cols -.IP - 3 -report/lvs_sort +- report/lvs_cols +.br +- report/lvs_sort .RE - -.IP \[bu] 3 -\fBseg\fP representing report about Logical Volume Segments (\fBlvs --segments\fP) +. +.TP +.B seg +representing report about Logical Volume Segments +(lvs\ --segments) .RS -.IP - 3 -report/segs_cols -.IP - 3 -report/segs_sort +- report/segs_cols +.br +- report/segs_sort .RE - -.IP \[bu] 3 -\fBfull\fP representing report combining all of the above as a whole (\fBlvm fullreport\fP) +. +.TP +.B full +representing report combining all of the above as a whole +(lvm\ fullreport) .RS -.IP - 3 -report/pvs_cols_full -.IP - 3 -report/pvs_sort_full -.IP - 3 -report/pvsegs_cols_full -.IP - 3 -report/pvseg_sort_full -.IP - 3 -report/vgs_cols_full -.IP - 3 -report/vgs_sort_full -.IP - 3 -report/lvs_cols_full -.IP - 3 -report/lvs_sort_full -.IP - 3 -report/segs_cols_full -.IP - 3 -report/segs_sort_full +- report/pvs_cols_full +.br +- report/pvs_sort_full +.br +- report/pvsegs_cols_full +.br +- report/pvseg_sort_full +.br +- report/vgs_cols_full +.br +- report/vgs_sort_full +.br +- report/lvs_cols_full +.br +- report/lvs_sort_full +.br +- report/segs_cols_full +.br +- report/segs_sort_full .RE - -.IP \[bu] 3 -\fBdevtype\fP representing report about device types (\fBlvm devtypes\fP) +. +.TP +.B devtype +representing report about device types +(lvm\ devtypes) .RS -.IP - 3 -report/devtypes_cols -.IP - 3 -report/devtypes_sort +- report/devtypes_cols +.br +- report/devtypes_sort .RE - .RE - +.ad b +.hy +.P Use \fBpvs, vgs, lvs -o help\fP or \fBlvm devtypes -o help\fP to get complete list of fields that you can use for main report. The list of fields in the help output is separated in groups based on which report type they belong to. Note that LVM can change final report type used if fields from different groups are combined together. Some of these combinations are not allowed in which case LVM will issue an error. - +.P For all main report subtypes except \fBfull\fP, it's not necessary to use -\fB--configreport ReportName\fP to denote which report any subsequent -\fB-o, -O or -S\fP option applies to as they always apply to the single main +\fB--configreport\fP \fIReportName\fP to denote which report any subsequent +.BR -o ", " -O +or \fB-S\fP option applies to as they always apply to the single main report type. Currently, \fBlvm fullreport\fP is the only command that -includes more than one \fBmain report\fP subtype. Therefore, the --configreport +includes more than one \fBmain report\fP subtype. Therefore, the \fB--configreport\fP is particularly suitable for the full report if you need to configure each of its subreports in a different way. - - -.SH Log report specifics - +. +.SS Log report specifics +. You can enable log report with \fBlog/report_command_log\fP configuration setting - this functionality is disabled by default. The \fBlog report\fP contains a log collected during LVM command execution and then the log is displayed just like any other report known from main report. There is only one log report subtype as shown below together with related configuration settings for fields, sorting and selection: - +. .RS - -.IP \[bu] 3 -\fBlog\fP representing log report -.RS -.IP - 3 -log/command_log_cols -.IP - 3 -log/command_log_sort -.IP - 3 -log/command_log_selection -.RE - +. +.TP +.B log +representing log report +.br +- log/command_log_cols +.br +- log/command_log_sort +.br +- log/command_log_selection .RE - -You always need to use \fB--configreport log\fP together with \fB-o|--options, --O|--sort or -S|--selection\fP to override configuration settings directly on +.P +You always need to use \fB--configreport log\fP together with +.BR -o | --options ", " -O | --sort +or +.BR -S | --selection +to override configuration settings directly on command line for \fBlog report\fP. When compared to \fBmain report\fP, in addition to usual configuration settings for report fields and sorting, the \fBlog report\fP has also configuration option for selection - \fBreport/command_log_selection\fP. This configuration setting is provided for -convenience so it's not necessary to use \fB-S|--select\fP on command line +convenience so it's not necessary to use +.BR -S | --select +on command line each time an LVM command is executed and we need the same selection criteria to be applied for \fBlog report\fP. Default selection criteria used for \fBlog report\fP are @@ -402,7 +399,7 @@ This means that, by default, \fBlog report\fP doesn't display status messages about successful operation and it displays only rows with error, warning, print-type messages and messages about failure states (for more information, see \fBlog report content\fP below). - +.P .B Log report coverage .br Currently, when running LVM commands directly (not in LVM shell), the log @@ -413,7 +410,7 @@ out of log report's coverage range, such message goes directly to output, bypassing the \fBlog report\fP. By default, that is \fBstandard error output\fP for error and warning messages and \fBstandard output\fP for common print-like messages. - +.P When running LVM commands in \fBLVM shell\fP, the log report covers the whole LVM command's execution, including command's \fBprocessing\fP as well as \fBinitialization\fP and \fBfinalization stage\fP. So from this point of view, @@ -425,13 +422,13 @@ next command executed in the shell and then, after the command's run, the shell needs to display the log report for that recently executed command. If there is a failure or any other message issued during this time, the LVM will bypass \fBlog report\fP and display messages on output directly. - +.P For these reasons and for completeness, it's not possible to rely fully on \fBlog report\fP as the only indicator of LVM command's status and the only place where all messages issued during LVM command execution are collected. You always need to check whether the command has not failed out of log report's range by checking the non-report output too. - +.P To help with this, LVM can separate output which you can then redirect to any \fBcustom file descriptor\fP that you prepare before running an LVM command or LVM shell and then you make LVM to use these file descriptors @@ -439,143 +436,155 @@ for different kinds of output by defining environment variables with file descriptor numbers. See also \fBLVM_OUT_FD\fP, \fBLVM_ERR_FD\fP and \fBLVM_REPORT_FD\fP environment variable description in \fBlvm\fP(8) man page. - +.P Also note that, by default, reports use the same file descriptor as common print-like messages, which is \fBstandard output\fP. If you plan to use \fBlog report\fP in your scripts or any external tool, you should use \fBLVM_OUT_FD\fP, \fBLVM_ERR_FD\fP and \fBLVM_REPORT_FD\fP to separate all output types to different file descriptors. For example, with bash, that would be: - +.P .RS LVM_OUT_FD=3 LVM_ERR_FD=4 LVM_REPORT_FD=5 <lvm command> 3>out_file 4>err_file 5>report_file .RE - +.P Where the <lvm_command> is either direct LVM command or LVM shell. You can collect all three types of output in particular files then. - +.P .B Log report content -.br +.P Each item in the log report consists of these set of fields providing various information: - -.RS - -.IP \[bu] 3 +. +.TP Basic information (mandatory): .RS -.IP - 3 -log_seq_num -.br +.TP +.I log_seq_num Item sequence number. The sequence number is unique for each log item and it increases in the order of the log items as they appeared during LVM command execution. - -.IP - 3 -log_type -.br +. +.TP +.I log_type Type of log for the item. Currently, these types are used: .RS -.IP -\fBstatus\fP for any status information that is logged -.IP -\fBprint\fP for any common message printed while the log is collected -.IP -\fBerror\fP for any error message printed while the log is collected -.IP -\fBwarn\fP for any warning message printed while the log is collected +. +.TP +.B status +for any status information that is logged +. +.TP +.B print +for any common message printed while the log is collected +. +.TP +.B error +for any error message printed while the log is collected +. +.TP +.B warn +for any warning message printed while the log is collected .RE - -.IP - 3 -log_context -.br +. +.TP +.I log_context Context of the log for the item. Currently, two contexts are identified: .RS -.IP -\fBshell\fP for the log collected in the outermost code before and after +. +.TP +.B shell +for the log collected in the outermost code before and after executing concrete LVM commands -.IP -\fBprocessing\fP for the log collected while processing LVM entities during +. +.TP +.B processing +for the log collected while processing LVM entities during LVM command execution .RE - .RE - -.IP \[bu] 3 +. +.TP Message (mandatory): .RS -.IP - 3 -log_message -.br +. +.TP +.I log_message Any message associated with current item. For \fBstatus\fP log type, the message contains either \fBsuccess\fP or \fBfailure\fP denoting current state. For \fBprint\fP, \fBerror\fP and \fBwarn\fP log types, the message contains the exact message of that type that got issued. .RE - -.IP \[bu] 3 +. +.TP Object information (used only if applicable): .RS -.IP - 3 -log_object_type field -.br +. +.TP +.I log_object_type field Type of the object processed. Currently, these object types are recognized: .RS -.IP -\fBcmd\fP for command as a whole -.IP -\fBorphan\fP for processing group of PVs not in any VG yet -.IP -\fBpv\fP for PV processing -.IP -\fBlabel\fP for direct PV label processing (without VG metadata) -.IP -\fBvg\fP for VG processing -.IP -\fBlv\fP for LV processing +. +.TP +.B cmd +for command as a whole +. +.TP +.B orphan +for processing group of PVs not in any VG yet +. +.TP +.B pv +for PV processing +. +.TP +.B label +for direct PV label processing (without VG metadata) +. +.TP +.B vg +for VG processing +. +.TP +.B lv +for LV processing .RE - -.IP - 3 -log_object_name -.br +. +.TP +.I log_object_name Name of the object processed. - -.IP - 3 -log_object_id -.br +. +.TP +.I log_object_id ID of the object processed. - -.IP - 3 -log_object_group -.br +. +.TP +.I log_object_group A group where the processed object belongs to. - -.IP - 3 -log_object_group_id -.br +. +.TP +.I log_object_group_id An ID of a group where the processed object belongs to. .RE - -.IP \[bu] 3 -Numeric status (used only if applicable) +. +.TP +Numeric status (used only if applicable): .RS -.IP - 3 -log_errno -.br +. +.TP +.I log_errno Error number associated with current item. -.IP - 3 -log_ret_code -.br -Rreturn code associated with current item. +. +.TP +.I log_ret_code +Return code associated with current item. .RE - -.RE - - -You can also run \fB<lvm_command> --configreport log -o help\fP to +.P +You can also run \fBlvm --configreport log -o help\fP to to display complete list of fields that you may use for the \fBlog report\fP. - -.SH Selection +. +.SS Selection +. Selection is used for a report to display only rows that match \fBselection criteria\fP. All rows are displayed with the additional \fBselected\fP field (\fB-o selected\fP) displaying 1 if the row matches the @@ -584,193 +593,218 @@ Selection is used for a report to display only rows that match The \fBstatement\fP consists of a \fBfield\fP name for which a set of valid \fBvalues\fP is defined using \fBcomparison operators\fP. For complete list of fields names that you can use in selection, see the output of -\fB<lvm_command> -S help\fP. The help output also contains type of values +\fBlvm -S help\fP. The help output also contains type of values that each field displays enclosed in brackets. - +.P .B List of operators recognized in selection criteria +.P .RS -.IP \[bu] 3 -Comparison operators (cmp_op) +.TP +Comparison operators (\fIcmp_op\fP) +.PD 0 .RS -.IP -\fB=~\fP matching regular expression. -.IP -\fB!~\fP not matching regular expression. -.IP -\fB= \fP equal to. -.IP -\fB!=\fP not equal to. -.IP -\fB>=\fP greater than or equal to. -.IP -\fB> \fP greater than -.IP -\fB<=\fP less than or equal to. -.IP -\fB< \fP less than. +.TP +.B =~ +matching regular expression. +.TP +.B !~ +not matching regular expression. +.TP +.B = +equal to. +.TP +.B != +not equal to. +.TP +.B >= +greater than or equal to. +.TP +.B > +greater than +.TP +.B <= +less than or equal to. +.TP +.B < +less than. .RE - -.IP \[bu] 3 -Binary logical operators (cmp_log) +.PD +. +.TP +Binary logical operators (\fIcmp_log\fP) +.PD 0 .RS -.IP -\fB&&\fP all fields must match -.IP -\fB, \fP all fields must match -.IP -\fB||\fP at least one field must match -.IP -\fB# \fP at least one field must match +.TP +.B && +all fields must match +.TP +.B , +all fields must match +.TP +.B || +at least one field must match +.TP +.B # +at least one field must match .RE - -.IP \[bu] 3 +.PD +. +.TP Unary logical operators +.PD 0 .RS -.IP -\fB! \fP logical negation +.TP +.B ! +logical negation .RE - -.IP \[bu] 3 +.PD +. +.TP Grouping operators +.PD 0 .RS -.IP -\fB( \fP left parenthesis -.IP -\fB) \fP right parenthesis -.IP -\fB[ \fP list start -.IP -\fB] \fP list end -.IP -\fB{ \fP list subset start -.IP -\fB} \fP list subset end +.TP +.B ( +left parenthesis +.TP +.B ) +right parenthesis +.TP +.B [ +list start +.TP +.B ] +list end +.TP +.B { +list subset start +.TP +.B } +list subset end .RE - +.PD .RE - +.P .B Field types and selection operands -.br +.P Field type restricts the set of operators and values that you may use with the field when defining selection criteria. You can see field type for each -field if you run \fB<lvm command> -S help\fP where you can find the type name +field if you run \fBlvm -S help\fP where you can find the type name enclosed in square brackets. Currently, LVM recognizes these field types in reports: - +. .RS -.IP \[bu] 3 -\fBstring\fP for set of characters (for each string field type, you can use +.TP +.B string +for set of characters (for each string field type, you can use either string or regular expression - regex for the value used in selection criteria) -.IP \[bu] 3 -\fBstring list\fP for set of strings -.IP \[bu] 3 -\fBnumber\fP for integer value -.IP \[bu] 3 -\fBsize\fP for integer or floating point number with size unit suffix +.TP +.B string list +for set of strings +.TP +.B number +for integer value +.TP +.B size +for integer or floating point number with size unit suffix (see also \fBlvcreate\fP(8) man page and description for "-L|--size" option for the list of recognized suffixes) -.IP \[bu] 3 -\fBpercent\fP for floating point number with or without "%" suffix +.TP +.B percent\fP for floating point number with or without "%" suffix (e.g. 50 or 50%) -.IP \[bu] 3 -\fBtime\fP for time values +.TP +.B time +for time values .RE - +.P When using \fBstring list\fP in selection criteria, there are several ways how LVM can match string list fields from report, depending on what list grouping operator is used and what item separator is used within that set of items. Also, note that order of items does not matter here. - -.RS +.P .IP \[bu] 3 \fBmatching the set strictly\fP where all items must match - use [ ], e.g. ["a","b","c"] -.IP \[bu] 3 +.IP \[bu] \fBmatching a subset of the set\fP - use { } with "," or "&&" as item delimiter, e.g. {"a","b","c"} -.IP \[bu] 3 +.IP \[bu] \fBmatching an intersection with the set\fP - use { } with "#" or "||" as item delimiter, e.g. {"a" || "b" || "c"} -.RE - +.P When using \fBtime\fP in your selection criteria, LVM can recognize various time formats using standard, absolute or freeform expressions. For examples demonstrating time expressions in selection criteria, see \fBEXAMPLES\fP section. - -.RS - +. .IP \[bu] 3 -\fBStandard time format\fP - +.B Standard time format .RS .IP - 3 date .RS -.IP +.RS YYYY-MM-DD -.IP +.br YYYY-MM, auto DD=1 -.IP +.br YYYY, auto MM=01 and DD=01 .RE - -.IP - 3 +.RE +. +.IP - time .RS -.IP +.RS hh:mm:ss -.IP +.br hh:mm, auto ss=0 -.IP +.br hh, auto mm=0, auto ss=0 .RE - -.IP - 3 +.RE +. +.IP - timezone .RS -.IP +.RS +hh:mm or -hh:mm -.IP +.br +hh or -hh .RE - +.RE +.P The full date/time specification is YYYY-MM-DD hh:mm:ss. Users are able to leave date/time parts from right to left. Whenever these parts are left out, a range is assumed automatically with second granularity. For example: - -.RS -.IP -"2015-07-07 9:51" means range of "2015-07-07 9:51:00" - "2015-07-07 9:51:59". -.IP +.P +.nf +"2015-07-07 9:51" means range of "2015-07-07 9:51:00" - "2015-07-07 9:51:59" "2015-07" means range of "2015-07-01 0:00:00" - "2015-07-31 23:59:59" -.IP "2015" means range of "2015-01-01 0:00:00" - "2015-12-31 23:59:59" +.fi .RE - -.RE - +.P .IP \[bu] 3 -\fBAbsolute time format\fP - +.B Absolute time format +.br Absolute time is defined as number of seconds since the Epoch (1970:01:01 00:00 +00:00). - .RS .IP - 3 @seconds .RE - .IP \[bu] 3 -\fBFreeform time format\fP +.B Freeform time format .RS +.PD 0 .IP - 3 weekday names ("Sunday" - "Saturday" or abbreviated as "Sun" - "Sat") -.IP - 3 +.IP - labels for points in time ("noon", "midnight") -.IP - 3 +.IP - labels for a day relative to current day ("today", "yesterday") -.IP - 3 +.IP - points back in time with relative offset from today (N is a number) .RS .IP @@ -782,41 +816,40 @@ points back in time with relative offset from today (N is a number) .RE .IP - 3 time specification either in hh:mm:ss format or with AM/PM suffixes -.IP - 3 +.IP - month names ("January" - "December" or abbreviated as "Jan" - "Dec") .RE - -.RE - +.PD +.P .B Informal grammar specification -.RS -.IP -.BR STATEMENT " = " column " cmp_op " VALUE " | " \%STATEMENT " log_op " STATEMENT " | " \%(STATEMENT) " | " \%!(STATEMENT) -.IP -.BR VALUE " = " [VALUE " log_op " VALUE] +.IP - 2 +.B STATEMENT = column \fIcmp_op\fP VALUE \fR| +.B STATEMENT \fIlog_op\fP STATEMENT \fR| +.B (STATEMENT) \fR|\fP !(STATEMENT) +.IP - +.B VALUE = [VALUE \fIlog_op\fP VALUE] .br For list-based types: string list. Matches strictly. The log_op must always be of one type within the whole list value. -.IP -.BR VALUE " = " {VALUE " log_op " VALUE} +.IP - +.B VALUE = {VALUE \fIlog_op\fP VALUE} .br For list-based types: string list. Matches a subset. The log_op must always be of one type within the whole list value. -.IP +.IP - .BR VALUE " = " value .br For scalar types: number, size, percent, string (or string regex). -.RE - +. .SH EXAMPLES - +. .SS Basic usage - +. We start our examples with default configuration - \fBlvmconfig\fP(8) is helpful command to display configuration settings which are currently used, including all configuration related to reporting. We will use it throughout examples below to display current configuration. - +.P .nf # lvmconfig --type full global/units global/suffix \\ report/output_format report/compact_output \\ @@ -845,14 +878,14 @@ mark_hidden_devices=1 two_word_unknown_device=0 buffered=1 .fi - +.P Also, we start with simple LVM layout with two PVs (/dev/sda, /dev/sdb), VG (vg) and two LVs (lvol0 and lvol1) in the VG. We display all possible reports as single commands here, see also \fBpvs\fP(8), \fBvgs\fP(8), \fBlvs\fP(8) man pages for more information. The field set for each report type is configured with configuration settings as we already mentioned in \fBmain report specifics\fP section in this man page. - +.P .nf # lvmconfig --type full report/pvs_cols report/pvs_sort \\ report/pvsegs_cols report/pvsegs_sort report/vgs_cols \\ @@ -871,13 +904,13 @@ lvs_sort="vg_name,lv_name" segs_cols="lv_name,vg_name,lv_attr,stripes,segtype,seg_size" segs_sort="vg_name,lv_name,seg_start" .fi - +.P .nf # pvs PV VG Fmt Attr PSize PFree /dev/sda vg lvm2 a-- 100.00m 88.00m /dev/sdb vg lvm2 a-- 100.00m 92.00m - +.P # pvs --segments PV VG Fmt Attr PSize PFree Start SSize /dev/sda vg lvm2 a-- 100.00m 88.00m 0 1 @@ -887,74 +920,76 @@ segs_sort="vg_name,lv_name,seg_start" /dev/sdb vg lvm2 a-- 100.00m 92.00m 0 1 /dev/sdb vg lvm2 a-- 100.00m 92.00m 1 1 /dev/sdb vg lvm2 a-- 100.00m 92.00m 2 23 - +.P # vgs VG #PV #LV #SN Attr VSize VFree vg 2 2 0 wz--n- 200.00m 180.00m - +.P # lvs LV VG Attr LSize Pool Origin Move Log Cpy%Sync Convert lvol0 vg -wi-a----- 4.00m lvol1 vg rwi-a-r--- 4.00m 100.00 - +.P # lvs --segments LV VG Attr #Str Type SSize lvol0 vg -wi-a----- 1 linear 4.00m lvol1 vg rwi-a-r--- 2 raid1 4.00m .fi - +.P We will use \fBreport/lvs_cols\fP and \fBreport/lvs_sort\fP configuration settings to define our own list of fields to use and to sort by that is different from defaults. You can do this for other reports in same manner with \fBreport/{pvs,pvseg,vgs,seg}_{cols,sort}\fP configuration settings. Also note that in the example below, we don't display the "lv_time" field even though we're using it for sorting - this is allowed. - +.P .nf # lvmconfig --type full report/lvs_cols report/lvs_sort lvs_cols="lv_name,lv_size,origin,pool_lv,copy_percent" lvs_sort="-lv_time" - +.P # lvs LV LSize Origin Pool Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m .fi - -You can use \fB-o|--options\fP command line option to override current +.P +You can use +.BR -o | --options +command line option to override current configuration directly on command line. - +.P .nf # lvs -o lv_name,lv_size LV LSize lvol1 4.00m lvol0 4.00m - +.P # lvs -o+lv_layout LV LSize Origin Pool Cpy%Sync Layout lvol1 4.00m 100.00 raid,raid1 lvol0 4.00m linear - +.P # lvs -o-origin LV LSize Pool Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m - +.P # lvs -o lv_name,lv_size,origin -o+lv_layout -o-origin -O lv_name LV LSize Layout lvol0 4.00m linear lvol1 4.00m raid,raid1 .fi - +.P You can obtain the same information with single command where all the information about PVs, PV segments, LVs and LV segments are obtained -per VG under a single VG lock for consistency, see also \fBlvm-fullreport\fP(8) +per VG under a single VG lock for consistency, see also \fBlvm fullreport\fP(8) man page for more information. The fullreport has its own configuration settings to define field sets to use, similar to individual reports as displayed above, but configuration settings have "_full" suffix now. This way, it's possible to configure different sets of fields to display and to sort by for individual reports as well as the full report. - +.P .nf # lvmconfig --type full report/pvs_cols_full \\ report/pvs_sort_full report/pvsegs_cols_full \\ @@ -973,7 +1008,7 @@ lvs_sort_full="vg_name,lv_name" segs_cols_full="lv_name,seg_start,seg_size" segs_sort_full="lv_uuid,seg_start" .fi - +.P .nf # lvm fullreport VG @@ -996,81 +1031,82 @@ segs_sort_full="lv_uuid,seg_start" lvol0 0 4.00m lvol1 0 4.00m .fi - +. .SS Automatic output compaction - +. If you look at the lvs output above, you can see that the report also contains fields for which there is no information to display (e.g. the columns under "Origin" and "Pool" heading - the "origin" and "pool_lv" fields). LVM can automatically compact report output so such fields are not included in final output. To enable this feature and to compact all fields, use \fBreport/compact_output=1\fP in your configuration. - +.P .nf # lvmconfig --type full report/compact_output compact_output=1 - +.P # lvs LV LSize Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m - +.P # lvs vg/lvol0 LV LSize lvol0 4.00m .fi - +.P Alternatively, you can define which fields should be compacted by configuring -\fBreport/compact_output_cols\fP configuration setting (or \fB-o|--options #\fP +\fBreport/compact_output_cols\fP configuration setting (or +.BR -o | --options " " # command line option). - +.P .nf # lvmconfig --type full report/compact_output report/compact_output_cols compact_output=0 compact_output_cols="origin" - +.P # lvs LV LSize Pool Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m - +.P # lvs vg/lvol0 LV LSize Pool lvol0 4.00m - +.P # lvs -o#pool_lv LV LSize Origin Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m .fi - +.P We will use \fBreport/compact_output=1\fP for subsequent examples. - +. .SS Further formatting options - +. By default, LVM displays sizes in reports in human-readable form which means that the most suitable unit is used so it's easy to read. You can use \fBreport/units\fP configuration setting (or \fB--units\fP option directly on command line) and \fBreport/suffix\fP configuration setting (or \fB--nosuffix\fP command line option) to change this. - +.P .nf # lvs --units b --nosuffix LV LSize Cpy%Sync lvol1 4194304 100.00 lvol0 4194304 .fi - +.P If you want to configure whether report headings are displayed or not, use \fBreport/headings\fP configuration settings (or \fB--noheadings\fP command line option). - +.P .nf # lvs --noheadings lvol1 4.00m 100.00 lvol0 4.00m .fi - +.P In some cases, it may be useful to display report content as key=value pairs where key here is actually the field name. Use \fBreport/prefixes\fP configuration setting (or \fB--nameprefixes\fP command line option) to switch @@ -1078,122 +1114,122 @@ between standard output and the key=value output. The key=value pair is the output that is suitable for use in scripts and for other tools to parse easily. Usually, you also don't want to display headings with the output that has these key=value pairs. - +.P .nf # lvs --noheadings --nameprefixes LVM2_LV_NAME='lvol1' LVM2_LV_SIZE='4.00m' LVM2_COPY_PERCENT='100.00' LVM2_LV_NAME='lvol0' LVM2_LV_SIZE='4.00m' LVM2_COPY_PERCENT='' .fi - +.P To define whether quotation marks in key=value pairs should be used or not, use \fBreport/quoted\fP configuration setting (or \fB--unquoted\fP command line option). - +.P .nf # lvs --noheadings --nameprefixes --unquoted LVM2_LV_NAME=lvol1 LVM2_LV_SIZE=4.00m LVM2_COPY_PERCENT=100.00 LVM2_LV_NAME=lvol0 LVM2_LV_SIZE=4.00m LVM2_COPY_PERCENT= .fi - +.P For easier parsing, you can even transpose the report so each column now becomes a row in the output. This is done with \fBreport/output_as_rows\fP configuration setting (or \fB--rows\fP command line option). - +.P .nf # lvs --noheadings --nameprefixes --unquoted --rows LVM2_LV_NAME=lvol1 LVM2_LV_NAME=lvol0 LVM2_LV_SIZE=4.00m LVM2_LV_SIZE=4.00m LVM2_COPY_PERCENT=100.00 LVM2_COPY_PERCENT= .fi - +.P Use \fBreport/separator\fP configuration setting (or \fB--separator\fP command line option) to define your own field separator to use. - +.P .nf # lvs --noheadings --nameprefixes --unquoted --separator " | " LVM2_LV_NAME=lvol1 | LVM2_LV_SIZE=4.00m | LVM2_COPY_PERCENT=100.00 LVM2_LV_NAME=lvol0 | LVM2_LV_SIZE=4.00m | LVM2_COPY_PERCENT= .fi - +.P If you are using your own separator, the columns in the output are not aligned by default. Use \fBreport/aligned\fP configuration setting (or \fB--aligned\fP command line option) for LVM to add extra spaces in report to align the output properly. - +.P .nf # lvs --separator " | " LV | LSize | Cpy%Sync lvol1 | 4.00m | 100.00 lvol0 | 4.00m | - +.P # lvs --separator " | " --aligned LV | LSize | Cpy%Sync lvol1 | 4.00m | 100.00 lvol0 | 4.00m | .fi - +.P Let's display one one more field in addition ("lv_tags" in this example) for the lvs report output. - +.P .nf # lvs -o+lv_tags LV LSize Cpy%Sync LV Tags lvol1 4.00m 100.00 lvol0 4.00m tagA,tagB .fi - +.P The "LV Tags" column in the example above displays two list values, separated by "," character for LV lvol0. If you need different list item separator, use \fBreport/list_item_separator\fP configuration setting its definition. - +.P .nf # lvmconfig --type full report/list_item_separator list_item_separator=";" - +.P # lvs -o+tags LV LSize Cpy%Sync LV Tags lvol1 4.00m 100.00 lvol0 4.00m tagA;tagB .fi - +.P But let's still use the original "," character for list_item_separator for subsequent examples. - +.P Format for any of time values displayed in reports can be configured with \fBreport/time_format\fP configuretion setting. By default complete date and time is displayed, including timezone. - +.P .nf # lvmconfig --type full report/time_format time_format="%Y-%m-%d %T %z" - +.P # lvs -o+time LV LSize Cpy%Sync CTime lvol1 4.00m 100.00 2016-08-29 12:53:36 +0200 lvol0 4.00m 2016-08-29 10:15:17 +0200 .fi - +.P We can change time format in similar way as we do when using \fBdate\fP(1) command or \fBstrftime\fP(3) function (\fBlvmconfig --type default --withcomments report/time_format\fP will give you complete list of available formatting options). In the example below, we decided to use %s for number of seconds since Epoch (1970-01-01 UTC). - +.P .nf # lvmconfig --type full report/time_format time_format="%s" - +.P # lvs LV Attr LSize Cpy%Sync LV Tags CTime lvol1 rwi-a-r--- 4.00m 100.00 1472468016 lvol0 -wi-a----- 4.00m tagA,tagB 1472458517 .fi - +.P The \fBlvs\fP does not display hidden LVs by default - to include these LVs in the output, you need to use \fB-a|--all\fP command line option. Names for these hidden LVs are displayed within square brackets. - +.P .nf # lvs -a LV LSize Cpy%Sync @@ -1204,14 +1240,14 @@ these hidden LVs are displayed within square brackets. [lvol1_rmeta_1] 4.00m lvol0 4.00m .fi - +.P You can configure LVM to display the square brackets for hidden LVs or not with \fBreport/mark_hidden_devices\fP configuration setting. - +.P .nf # lvmconfig --type full report/mark_hidden_devices mark_hidden_devices=0 - +.P # lvs -a LV LSize Cpy%Sync lvol1 4.00m 100.00 @@ -1221,12 +1257,12 @@ mark_hidden_devices=0 lvol1_rmeta_1 4.00m lvol0 4.00m .fi - +.P It's not recommended to use LV marks for hidden devices to decide whether the LV is the one to use by end users or not. Please, use "lv_role" field instead which can report whether the LV is "public" or "private". The private LVs are used by LVM only and they should not be accessed directly by end users. - +.P .nf # lvs -a -o+lv_role LV LSize Cpy%Sync Role @@ -1237,39 +1273,39 @@ used by LVM only and they should not be accessed directly by end users. lvol1_rmeta_1 4.00m private,raid,metadata lvol0 4.00m public .fi - +.P Some of the reporting fields that LVM reports are of binary nature. For such fields, it's either possible to display word representation of the value (this is used by default) or numeric value (0/1 or -1 in case the value is undefined). - +.P .nf # lvs -o+lv_active_locally LV LSize Cpy%Sync ActLocal lvol1 4.00m 100.00 active locally lvol0 4.00m active locally .fi - +.P We can change the way how these binary values are displayed with \fBreport/binary_values_as_numeric\fP configuration setting. - +.P .nf # lvmconfig --type full report/binary_values_as_numeric binary_values_as_numeric=1 - +.P # lvs -o+lv_active_locally LV LSize Cpy%Sync ActLocal lvol1 4.00m 100.00 1 lvol0 4.00m 1 .fi - +. .SS Changing output format - +. LVM can output reports in different formats - use \fBreport/output_format\fP configuration setting (or \fB--reportformat\fP command line option) to swith the report output format. Currently, LVM supports \fB"basic"\fP (all the examples we used above used this format) and \fB"JSON"\fP output format. - +.P .nf # lvs -o lv_name,lv_size --reportformat json { @@ -1283,7 +1319,7 @@ we used above used this format) and \fB"JSON"\fP output format. ] } .fi - +.P Note that some configuration settings and command line options have no effect with certain report formats. For example, with \fBJSON\fP output, it doesn't have any meaning to use \fBreport/aligned\fP (\fB--aligned\fP), @@ -1291,26 +1327,26 @@ it doesn't have any meaning to use \fBreport/aligned\fP (\fB--aligned\fP), (\fB--rows\fP) or \fBreport/buffered\fP (\fB--unbuffered\fP). All these configuration settings and command line options are ignored if using the \fBJSON\fP report output format. - +. .SS Selection - +. If you need to select only specific rows from report, you can use LVM's -report selection feature. If you call \fB<lvm_command> -S help\fP, you'll get +report selection feature. If you call \fBlvm -S help\fP, you'll get quick help on selection. The help contains list of all fields that LVM can use in reports together with its type enclosed in square brackets. The example below contains a line from lvs -S help. - +.P .nf # lvs -S help ... lv_size - Size of LV in current units. [size] ... .fi - +.P This line tells you you that the "lv_size" field is of "size" type. If you look at the bottom of the help output, you can see section about "Selection operators" and its "Comparison operators". - +.P .nf # lvs -S help ... @@ -1328,18 +1364,18 @@ Comparison operators: since - Since specified time (same as '>='). [time] after - After specified time (same as '>'). [time] until - Until specified time (same as '<='). [time] -before - Before specified time (same as '<'). [time] +before - Before specified time (same as '<'). [time] ... .fi - +.P Here you can match comparison operators that you may use with the "lv_size" field which is of type "size" - it's =, !=, >=, >, <= and <. You can find applicable comparison operators for other fields and other field types the same way. - +.P To demonstrate selection functionality in LVM, we will create more LVs in addition to lvol0 and lvol1 we used in our previous examples. - +.P .nf # lvs -o name,size,origin,snap_percent,tags,time LV LSize Origin Snap% LV Tags CTime @@ -1349,132 +1385,132 @@ addition to lvol0 and lvol1 we used in our previous examples. lvol1 4.00m 2016-08-29 12:53:36 +0200 lvol0 4.00m tagA,tagB 2016-08-29 10:15:17 +0200 .fi - +.P When selecting size and percent fields, we don't need to use units. For sizes, default "m" (for MiB) is used - this is the same behaviour as already used for LVM commands when specifying sizes (e.g. lvcreate -L). For percent fields, "%" is assumed automatically if it's not specified. The example below also demonstrates how several criteria can be combined together. - +.P .nf # lvs -o name,size,snap_percent -S 'size=8m' LV LSize lvol2 8.00m - +.P # lvs -o name,size,snap_percent -S 'size=8' LV LSize lvol2 8.00m - +.P # lvs -o name,size,snap_percent -S 'size < 5000k' LV LSize Snap% lvol4 4.00m 24.61 lvol3 4.00m 5.08 lvol1 4.00m lvol0 4.00m - +.P # lvs -o name,size,snap_percent -S 'size < 5000k && snap_percent > 20' LV LSize Snap% lvol4 4.00m 24.61 - +.P # lvs -o name,size,snap_percent \\ -S '(size < 5000k && snap_percent > 20%) || name=lvol2' LV LSize Snap% lvol4 4.00m 24.61 lvol2 8.00m .fi - +.P You can also use selection together with processing-oriented commands. - +.P .nf # lvchange --addtag test -S 'size < 5000k' Logical volume vg/lvol1 changed. Logical volume vg/lvol0 changed. Logical volume vg/lvol3 changed. Logical volume vg/lvol4 changed. - +.P # lvchange --deltag test -S 'tags = test' Logical volume vg/lvol1 changed. Logical volume vg/lvol0 changed. Logical volume vg/lvol3 changed. Logical volume vg/lvol4 changed. .fi - +.P LVM can recognize more complex values used in selection criteria for string list and time field types. For string lists, you can match whole list strictly, its subset or intersection. Let's take "lv_tags" field as an example - we select only rows which contain "tagA" within tags field. We're using { } to denote that we're interested in subset that matches. If the subset has only one item, we can leave out { }. - +.P .nf # lvs -o name,tags -S 'tags={tagA}' LV LV Tags lvol2 tagA,tagC,tagD lvol0 tagA,tagB - +.P # lvs -o name,tags -S 'tags=tagA' LV LV Tags lvol2 tagA,tagC,tagD lvol0 tagA,tagB .fi - +.P Depending on whether we use "&&" (or ",") or "||" ( or "#") as delimiter for items in the set we define in selection criterion for string list, we either match subset ("&&" or ",") or even intersection ("||" or "#"). - +.P .nf # lvs -o name,tags -S 'tags={tagA,tagC,tagD}' LV LV Tags lvol2 tagA,tagC,tagD - +.P # lvs -o name,tags -S 'tags={tagA || tagC || tagD}' LV LV Tags lvol2 tagA,tagC,tagD lvol0 tagA,tagB .fi - +.P To match the complete set, use [ ] with "&&" (or ",") as delimiter for items. Also note that the order in which we define items in the set is not relevant. - +.P .nf # lvs -o name,tags -S 'tags=[tagA]' - +.P # lvs -o name,tags -S 'tags=[tagB,tagA]' LV LV Tags lvol0 tagA,tagB .fi - +.P If you use [ ] with "||" (or "#"), this is exactly the same as using { }. - +.P .nf # lvs -o name,tags -S 'tags=[tagA || tagC || tagD]' LV LV Tags lvol2 tagA,tagC,tagD lvol0 tagA,tagB .fi - +.P To match a set with no items, use "" to denote this (note that we have output compaction enabled so the "LV Tags" column is not displayed in the example below because it's blank and so it gets compacted). - +.P .nf # lvs -o name,tags -S 'tags=""' LV lvol4 lvol3 lvol1 - +.P # lvs -o name,tags -S 'tags!=""' LV LV Tags lvol2 tagA,tagC,tagD lvol0 tagA,tagB .fi - +.P When doing selection based on time fields, we can use either standard, absolute or freeform time expressions in selection criteria. Examples below are using standard forms. - +.P .nf # lvs -o name,time LV CTime @@ -1483,39 +1519,39 @@ are using standard forms. lvol2 2016-09-09 16:55:12 +0200 lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 - +.P # lvs -o name,time -S 'time since "2016-09-01"' LV CTime lvol4 2016-09-09 16:57:44 +0200 lvol3 2016-09-09 16:56:48 +0200 lvol2 2016-09-09 16:55:12 +0200 - +.P # lvs -o name,time -S 'time since "2016-09-09 16:56"' LV CTime lvol4 2016-09-09 16:57:44 +0200 lvol3 2016-09-09 16:56:48 +0200 - +.P # lvs -o name,time -S 'time since "2016-09-09 16:57:30"' LV CTime lvol4 2016-09-09 16:57:44 +0200 - +.P # lvs -o name,time \\ -S 'time since "2016-08-29" && time until "2016-09-09 16:55:12"' LV CTime lvol2 2016-09-09 16:55:12 +0200 lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 - +.P # lvs -o name,time \\ -S 'time since "2016-08-29" && time before "2016-09-09 16:55:12"' LV CTime lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 .fi - +.P Time operators have synonyms: ">=" for since, "<=" for until, ">" for "after" and "<" for "before". - +.P .nf # lvs -o name,time \\ -S 'time >= "2016-08-29" && time <= "2016-09-09 16:55:30"' @@ -1523,16 +1559,16 @@ Time operators have synonyms: ">=" for since, "<=" for until, lvol2 2016-09-09 16:55:12 +0200 lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 - +.P # lvs -o name,time \\ -S 'time since "2016-08-29" && time < "2016-09-09 16:55:12"' LV CTime lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 .fi - +.P Example below demonstrates using absolute time expression. - +.P .nf # lvs -o name,time --config report/time_format="%s" LV CTime @@ -1541,15 +1577,15 @@ Example below demonstrates using absolute time expression. lvol2 1473432912 lvol1 1472468016 lvol0 1472458517 - +.P # lvs -o name,time -S 'time since @1473433008' LV CTime lvol4 2016-09-09 16:57:44 +0200 lvol3 2016-09-09 16:56:48 +0200 .fi - +.P Examples below demonstrates using freeform time expressions. - +.P .nf # lvs -o name,time -S 'time since "2 weeks ago"' LV CTime @@ -1558,29 +1594,29 @@ Examples below demonstrates using freeform time expressions. lvol2 2016-09-09 16:55:12 +0200 lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 - +.P # lvs -o name,time -S 'time since "1 week ago"' LV CTime lvol4 2016-09-09 16:57:44 +0200 lvol3 2016-09-09 16:56:48 +0200 lvol2 2016-09-09 16:55:12 +0200 - +.P # lvs -o name,time -S 'time since "2 weeks ago"' LV CTime lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 - +.P # lvs -o name,time -S 'time before "1 week ago"' LV CTime lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 - +.P # lvs -o name,time -S 'time since "68 hours ago"' LV CTime lvol4 2016-09-09 16:57:44 +0200 lvol3 2016-09-09 16:56:48 +0200 lvol2 2016-09-09 16:55:12 +0200 - +.P # lvs -o name,time -S 'time since "1 year 3 months ago"' LV CTime lvol4 2016-09-09 16:57:44 +0200 @@ -1589,9 +1625,9 @@ Examples below demonstrates using freeform time expressions. lvol1 2016-08-29 12:53:36 +0200 lvol0 2016-08-29 10:15:17 +0200 .fi - +. .SS Command log reporting - +. As described in \fBcategorization based on reporting facility\fP section at the beginning of this document, both \fBreport-oriented\fP and \fBprocessing-oriented\fP LVM commands can report the command log if @@ -1599,7 +1635,7 @@ this is enabled with \fBlog/report_command_log\fP configuration setting. Just like any other report, we can set the set of fields to display (\fBlog/command_log_cols\fP) and to sort by (\fBlog/command_log_sort\fP) for this report. - +.P .nf # lvmconfig --type full log/report_command_log log/command_log_cols \\ log/command_log_sort log/command_log_selection @@ -1609,45 +1645,44 @@ command_log_cols="log_seq_num,log_type,log_context,log_object_type, log_errno,log_ret_code" command_log_sort="log_seq_num" command_log_selection="!(log_type=status && message=success)" - - +.P # lvs Logical Volume ============== LV LSize Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m - +.P Command Log =========== Seq LogType Context ObjType ObjName ObjGrp Msg Errno RetCode .fi - +.P As you can see, the command log is empty (it contains only field names). By default, LVM uses selection on the command log report and this case no row matched the selection criteria, see also \fBlog report specifics\fP section in this document for more information. We're displaying complete log report in the example below where we can see that both LVs lvol0 and lvol1 were successfully processed as well as the VG vg they are part of. - +.P .nf # lvmconfig --type full log/command_log_selection command_log_selection="all" - +.P # lvs Logical Volume ============== LV LSize Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m - +.P Command Log =========== Seq LogType Context ObjType ObjName ObjGrp Msg Errno RetCode 1 status processing lv lvol0 vg success 0 1 2 status processing lv lvol1 vg success 0 1 3 status processing vg vg success 0 1 - +.P # lvchange -an vg/lvol1 Command Log =========== @@ -1655,13 +1690,17 @@ command_log_selection="all" 1 status processing lv lvol1 vg success 0 1 2 status processing vg vg success 0 1 .fi - +. .SS Handling multiple reports per single command - +. To configure the log report directly on command line, we need to use -\fB--configreport\fP option before we start any \fB-o|--options\fP, -\fB-O|--sort\fP or \fB-S|--select\fP that is targeted for log report. - +\fB--configreport\fP option before we start any +.BR -o | --options , +.BR -O | --sort +or +.BR -S | --select +that is targeted for log report. +.P .nf # lvs -o lv_name,lv_size --configreport log -o log_object_type, \\ log_object_name,log_message,log_ret_code @@ -1670,7 +1709,7 @@ To configure the log report directly on command line, we need to use LV LSize lvol1 4.00m lvol0 4.00m - +.P Command Log =========== ObjType ObjName Msg RetCode @@ -1678,11 +1717,11 @@ To configure the log report directly on command line, we need to use lv lvol1 success 1 vg vg success 1 .fi - +.P The \fBlvm fullreport\fP, with or without log report, consists of several reports - the \fB--configreport\fP is also used to target particular subreport here. - +.P Below is an extended example with \fBlvm fullreport\fP to illustrate combination of various options. The report output is in JSON format. Also, we configure "vg", "pvseg", "seg" and "log" subreport to contain @@ -1691,7 +1730,7 @@ in PV names having "sda" in their name. For the "log" subreport we're interested only in log lines related to either "lvol0" object or object having "sda" in its name. Also, for the log subreport we define ordering to be based on "log_object_type" field. - +.P .nf # lvm fullreport --reportformat json \\ --configreport vg -o vg_name,vg_size \\ @@ -1741,22 +1780,22 @@ to be based on "log_object_type" field. ] } .fi - +. .SS Report extensions for LVM shell - +. As already stated in \fBlog report coverage\fP paragraph under \fBlog report specifics\fP in this documentation, when using \fBLVM shell\fP the \fBlog report\fP coverage is wider. There's also special command designed to query last command's log report in the \fBLVM shell\fP - the \fBlastlog\fP command. - +.P The example below illustrates a situation where we called lvs command. After that, we inspected the log report with the \fBlastlog\fP, without any selection so all the log report is displayed on output. Then we called \fBlastlog\fP further, giving various selection criteria. Then we ran unknown LVM command "abc" for which the log report displays appropriate failure state. - +.P .nf # lvm lvm> lvs @@ -1765,7 +1804,7 @@ lvm> lvs LV LSize Cpy%Sync lvol1 4.00m 100.00 lvol0 4.00m - +.P Command Log =========== Seq LogType Context ObjType ObjName ObjGrp Msg Errno RetCode @@ -1773,7 +1812,7 @@ lvm> lvs 2 status processing lv lvol1 vg success 0 1 3 status processing vg vg success 0 1 4 status shell cmd lvs success 0 1 - +.P lvm> lastlog Command Log =========== @@ -1782,20 +1821,20 @@ lvm> lastlog 2 status processing lv lvol1 vg success 0 1 3 status processing vg vg success 0 1 4 status shell cmd lvs success 0 1 - +.P lvm> lastlog -S log_object_type=lv Command Log =========== Seq LogType Context ObjType ObjName ObjGrp Msg Errno RetCode 1 status processing lv lvol0 vg success 0 1 2 status processing lv lvol1 vg success 0 1 - +.P lvm> lastlog -S log_context=shell Command Log =========== Seq LogType Context ObjType ObjName ObjGrp Msg Errno RetCode 4 status shell cmd lvs success 0 1 - +.P lvm> abc Command Log =========== @@ -1803,8 +1842,17 @@ lvm> abc 1 error shell cmd abc No such command 'abc'. Try 'help'. -1 0 2 status shell cmd abc failure -1 2 .fi - +. .SH SEE ALSO +. .BR lvm (8), .BR lvmconfig (8), -.BR "lvm fullreport" (8) +.BR "lvm fullreport" (8), +.BR lvcreate (8), +.br +.BR lvs (8), +.BR pvs (8), +.BR vgs (8), +.P +.BR date (1), +.BR strftime (3)

3 years

1
0
0 / 0

main - man: typography fixes

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=9164a393de449f28503... Commit: 9164a393de449f285038811d58ade0fb3ecfba30 Parent: 0f87b015b5f4251f9584244176b9f7c0579755e3 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Thu Apr 15 13:16:41 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:54:37 2021 +0200 man: typography fixes Correcting some usage of Bold and Italics (files). Adding some missing SEE ALSO. Fixing missed replaceable paths that are configurable. Be careful about .P in .TP sections - need to use .sp for space line. Use .UR/.UE for URL references. --- man/blkdeactivate.8_main | 41 +++++++++++---------- man/dmeventd.8_main | 13 ++++--- man/dmfilemapd.8_main | 24 ++++++------- man/dmsetup.8_main | 55 +++++++++++++++-------------- man/dmstats.8_main | 92 ++++++++++++++++++++++++++---------------------- man/lvconvert.8_des | 4 +-- man/lvcreate.8_end | 2 +- man/lvm.8_main | 30 +++++++++++++--- man/lvm.conf.5_main | 20 +++++------ man/lvmcache.7_main | 46 ++++++++++++++---------- man/lvmdevices.8_des | 4 +-- man/lvmdump.8_main | 26 ++++++++------ man/lvmlockctl.8_main | 34 +++++++++--------- man/lvmpolld.8_main | 6 ++-- man/lvmthin.7_main | 8 +++-- man/lvmvdo.7_main | 57 ++++++++++++++++-------------- man/lvs.8_end | 82 +++++++++++++++++++++--------------------- man/pvck.8_des | 2 +- man/pvs.8_end | 6 ++-- man/see_also.end | 14 ++++---- man/vgs.8_end | 12 +++---- 21 files changed, 314 insertions(+), 264 deletions(-) diff --git a/man/blkdeactivate.8_main b/man/blkdeactivate.8_main index a832b1af1..398db37cd 100644 --- a/man/blkdeactivate.8_main +++ b/man/blkdeactivate.8_main @@ -45,9 +45,11 @@ MD devices are handled using the \fBmdadm\fP(8) command. Comma separated list of device-mapper specific options. Accepted \fBdmsetup\fP(8) options are: .RS -.IP \fIretry\fP +.TP +.B retry Retry removal several times in case of failure. -.IP \fIforce\fP +.TP +.B force Force device removal. .RE . @@ -66,19 +68,32 @@ Display the help text. .BR -l | --lvmoptions " " \fIlvm_options Comma-separated list of LVM specific options: .RS -.IP \fIretry\fP +.TP +.B retry Retry removal several times in case of failure. -.IP \fIwholevg\fP +.TP +.B wholevg Deactivate the whole LVM Volume Group when processing a Logical Volume. Deactivating the Volume Group as a whole is quicker than deactivating each Logical Volume separately. .RE . .TP +.BR -r | --mdraidoptions " " \fImdraid_options +Comma-separated list of MD RAID specific options: +.RS +.TP +.B wait +Wait MD device's resync, recovery or reshape action to complete +before deactivation. +.RE +. +.TP .BR -m | --mpathoptions " " \fImpath_options Comma-separated list of device-mapper multipath specific options: .RS -.IP \fIdisablequeueing\fP +.TP +.B disablequeueing Disable queueing on all multipath devices before deactivation. This avoids a situation where blkdeactivate may end up waiting if all the paths are unavailable for any underlying device-mapper multipath @@ -86,19 +101,11 @@ device. .RE . .TP -.BR -r | --mdraidoptions " " \fImdraid_options -Comma-separated list of MD RAID specific options: -.RS -.IP \fIwait\fP -Wait MD device's resync, recovery or reshape action to complete -before deactivation. -.RE -. -.TP .BR -o | --vdooptions " " \fIvdo_options Comma-separated list of VDO specific options: .RS -.IP \fIconfigfile=file\fP +.TP +.BR configfile = \fIfile Use specified VDO configuration file. .RE . @@ -118,21 +125,18 @@ devices. .br # .B blkdeactivate -.br .P Deactivate all supported block devices found in the system, unmounting any mounted devices first, if possible. .br # .B blkdeactivate -u -.br .P Deactivate the device /dev/vg/lvol0 together with all its holders, unmounting any mounted devices first, if possible. .br # .B blkdeactivate -u /dev/vg/lvol0 -.br .P Deactivate all supported block devices found in the system. If the deactivation of a device-mapper device fails, retry it. Deactivate the whole @@ -140,7 +144,6 @@ Volume Group at once when processing an LVM Logical Volume. .br # .B blkdeactivate -u -d retry -l wholevg -.br .P Deactivate all supported block devices found in the system. If the deactivation of a device-mapper device fails, retry it and force removal. diff --git a/man/dmeventd.8_main b/man/dmeventd.8_main index 123073b18..c03605d9c 100644 --- a/man/dmeventd.8_main +++ b/man/dmeventd.8_main @@ -96,11 +96,11 @@ The warning is repeated when more then 85%, 90% and 95% of the thin pool is filled. See .BR lvm.conf (5). When a thin pool fills over 50% (data or metadata) thin plugin calls -configured \fIdmeventd/thin_command\fP with every 5% increase. +configured \fBdmeventd/thin_command\fP with every 5% increase. With default setting it calls internal \fBlvm lvextend --use-policies\fP to resize thin pool when it's been filled above configured threshold -\fIactivation/thin_pool_autoextend_threshold\fP. +\fBactivation/thin_pool_autoextend_threshold\fP. If the command fails, dmeventd thin plugin will keep retrying execution with increasing time delay between retries upto 42 minutes. @@ -126,11 +126,11 @@ The warning is repeated when more then 85%, 90% and 95% of the VDO pool is filled. See .BR lvm.conf (5). When a VDO pool fills over 50% vdo plugin calls -configured \fIdmeventd/vdo_command\fP with every 5% increase. +configured \fBdmeventd/vdo_command\fP with every 5% increase. With default setting it calls internal \fBlvm lvextend --use-policies\fP to resize VDO pool when it's been filled above the configured threshold -\fIactivation/vdo_pool_autoextend_threshold\fP. +\fBactivation/vdo_pool_autoextend_threshold\fP. If the command fails, dmeventd vdo plugin will keep retrying execution with increasing time delay between retries upto 42 minutes. @@ -173,4 +173,7 @@ a thin_command, vdo_command environment. .SH SEE ALSO . .BR lvm (8), -.BR lvm.conf (5) +.BR lvm.conf (5), +.BR lvextend (8), +.br +.BR fstrim (8) diff --git a/man/dmfilemapd.8_main b/man/dmfilemapd.8_main index 864933609..e317166b6 100644 --- a/man/dmfilemapd.8_main +++ b/man/dmfilemapd.8_main @@ -44,7 +44,7 @@ dmfilemapd \(em device-mapper filemap monitoring daemon . .SH DESCRIPTION . -The dmfilemapd daemon monitors groups of \fBdmstats\fP regions that +The dmfilemapd daemon monitors groups of \fBdmstats\fP(8) regions that correspond to the extents of a file, adding and removing regions to reflect the changing state of the file on-disk. .P @@ -174,28 +174,20 @@ verbose logging .ad l # .B dmfilemapd 3 0 /var/tmp/data inode 1 3 3< /var/tmp/data -.br +.nf Starting dmfilemapd with fd=3, group_id=0 mode=inode, path=/var/tmp/data -.br dm version [ opencount flush ] [16384] (*1) -.br dm info (253:0) [ opencount flush ] [16384] (*1) -.br dm message (253:0) [ opencount flush ] @stats_list dmstats [16384] (*1) -.br Read alias 'data' from aux_data -.br Found group_id 0: alias="data" -.br dm_stats_walk_init: initialised flags to 4000000000000 -.br starting stats walk with GROUP -.br exiting _filemap_monitor_get_events() with deleted=0, check=0 -.br Waiting for check interval -.br +.fi .ad b + . .SH AUTHORS . @@ -205,6 +197,10 @@ Bryn M. Reeves <bmr(a)redhat.com> . .BR dmstats (8) .P -LVM2 resource page: https://www.sourceware.org/lvm2/ +LVM2 resource page: +.UR https://www.sourceware.org/lvm2 +.UE .br -Device-mapper resource page: http://sources.redhat.com/dm/ +Device-mapper resource page: +.UR http://sources.redhat.com/dm +.UE diff --git a/man/dmsetup.8_main b/man/dmsetup.8_main index aa60a0153..359b06ce3 100644 --- a/man/dmsetup.8_main +++ b/man/dmsetup.8_main @@ -389,9 +389,10 @@ dmsetup \(em low level logical volume management . ad b .. .CMD_WIPE_TABLE -.PD -.P -.PD 0 +. +.TP +\ \& +. .TP .B devmap_name \fImajor minor .TP @@ -423,7 +424,7 @@ Ensure \fI/dev/mapper\fP node exists after \fBdmsetup create\fP. . .TP .B --addnodeonresume -Ensure \fI/dev/mapper\fP node exists after \fBdmsetup resume\fP (default with udev). +Ensure \fI/dev/mapper\fP node exists after \fBdmsetup\ resume\fP (default with udev). . .TP .B --checks @@ -473,7 +474,7 @@ if already mangled, error on mixed), \fBhex\fP (always do the mangling) and \fBnone\fP (no mangling). Default mode is \fB#DEFAULT_MANGLING#\fP. -Character whitelist: 0-9, A-Z, a-z, #+-.:=@_. This whitelist is +Character whitelist: 0-9, A-Z, a-z, #+\-.:=@_. This whitelist is also supported by udev. Any character not on a whitelist is replaced with its hex value (two digits) prefixed by \\x. Mangling mode could be also set through @@ -924,10 +925,10 @@ e.g. striped 2 32 /dev/hda1 0 /dev/hdb1 0 will map the first chunk (16k) as follows: .RS .IP - LV chunk 1 -> hda1, chunk 1 - LV chunk 2 -> hdb1, chunk 1 - LV chunk 3 -> hda1, chunk 2 - LV chunk 4 -> hdb1, chunk 2 + LV chunk 1 \[->] hda1, chunk 1 + LV chunk 2 \[->] hdb1, chunk 1 + LV chunk 3 \[->] hda1, chunk 2 + LV chunk 4 \[->] hdb1, chunk 2 etc. .RE .TP @@ -980,21 +981,17 @@ documentation directory for the device-mapper package.) . .SH EXAMPLES . +.nf # A table to join two disks together -.br 0 1028160 linear /dev/hda 0 -.br 1028160 3903762 linear /dev/hdb 0 -.br +.P # A table to stripe across the two disks, -.br # and add the spare space from -.br # hdb to the back of the volume -.br 0 2056320 striped 2 32 /dev/hda 0 /dev/hdb 0 -.br 2056320 2875602 linear /dev/hdb 1028160 +.fi . .SH CONCISE FORMAT . @@ -1026,33 +1023,33 @@ The minor number of the device. If empty, the kernel assigns a suitable minor n .TP .B flags Supported flags are: -.sp +.br +.ad l .B ro Sets the table being loaded for the device read-only .br .B rw Sets the table being loaded for the device read-write (default) +.ad b .TP .B table One line of the table. See TABLE FORMAT above. . .SH EXAMPLES . -# A simple linear read-only device -.br +.PD 0 .ad l .nh +# A simple linear read-only device +.TP test-linear-small,,,ro,\:0 2097152 linear /dev/loop0 0,\:2097152 2097152 linear /dev/loop1 0 -.hy -.ad b -.sp +.P # Two linear devices -.br -.ad l -.nh +.TP test-linear-small,,,,\:0 2097152 linear /dev/loop0 0;\:test-linear-large,\:,,,\:0 2097152 linear /dev/loop1 0, 2097152 2097152 linear /dev/loop2 0 .hy .ad b +.PD . .SH ENVIRONMENT VARIABLES . @@ -1079,6 +1076,10 @@ Original version: Joe Thornber <thornber(a)redhat.com> .BR udev (7), .BR udevadm (8) .P -LVM2 resource page: https://www.sourceware.org/lvm2/ +LVM2 resource page: +.UR https://www.sourceware.org/lvm2 +.UE .br -Device-mapper resource page: http://sources.redhat.com/dm/ +Device-mapper resource page: +.UR http://sources.redhat.com/dm +.UE diff --git a/man/dmstats.8_main b/man/dmstats.8_main index f77ca05c8..bf492c554 100644 --- a/man/dmstats.8_main +++ b/man/dmstats.8_main @@ -90,7 +90,7 @@ dmstats \(em device-mapper statistics management . ad l . nh . BR create -. IR device_name... | file_path... | \fB--alldevices +. IR device_name ...| file_path ...| \fB--alldevices . RB [ --areas . IR nr_areas | \fB--areasize . IR area_size ] @@ -334,7 +334,7 @@ groups. Normally the device-mapper filemap monitoring daemon, \fBdmfilemapd\fP, is started for each file mapped group to update the set of regions as the file changes on-disk: use of this option disables this behaviour. -.P +.sp Regions in the group may still be updated with the \fBupdate_filemap\fP command, or by starting the daemon manually. . @@ -345,29 +345,29 @@ monitoring daemon can monitor files in two distinct ways: the mode affects the behaviour of the daemon when a file under monitoring is renamed or unlinked, and the conditions which cause the daemon to terminate. -.P +.sp The \fBfollow_mode\fP argument is either "inode", for follow-inode mode, or "path", for follow-path. -.P +.sp If follow-inode mode is used, the daemon will hold the file open, and continue to update regions from the same file descriptor. This means that the mapping will follow rename, move (within the same file system), and unlink operations. This mode is useful if the file is expected to be moved, renamed, or unlinked while it is being monitored. -.P +.sp In follow-inode mode, the daemon will exit once it detects that the file has been unlinked and it is the last holder of a reference to it. -.P +.sp If follow-path is used, the daemon will re-open the provided path on each monitoring iteration. This means that the group will be updated to reflect a new file being moved to the same path as the original file. This mode is useful for files that are expected to be updated via unlink and rename. -.P +.sp In follow-path mode, the daemon will exit if the file is removed and not replaced within a brief tolerance interval. -.P +.sp In either mode, the daemon exits automatically if the monitored group is removed. . @@ -494,7 +494,7 @@ optional suffix selects units of: When used with \fBcreate\fP, create a new statistics region for each target contained in the given device(s). This causes a separate region to be allocated for each segment of the device. -.P +.sp The newly created regions are automatically placed into a group unless the \fB--nogroup\fP option is given. When grouping is enabled a group alias may be specified using the \fB--alias\fP option. @@ -537,23 +537,23 @@ regions (with the exception of in-flight IO counters). .CMD_CREATE .br Creates one or more new statistics regions on the specified device(s). -.P +.sp The region will span the entire device unless \fB--start\fP and \fB--length\fP or \fB--segments\fP are given. The \fB--start\fP an \fB--length\fP options allow a region of arbitrary length to be placed at an arbitrary offset into the device. The \fB--segments\fP option causes a new region to be created for each target in the corresponding device-mapper device's table. -.P +.sp If the \fB--precise\fP option is used the command will attempt to create a region using nanosecond precision counters. -.P +.sp If \fB--bounds\fP is given a latency histogram will be tracked for the new region. The boundaries of the histogram bins are given as a comma separated list of latency values. There is an implicit lower bound of zero on the first bin and an implicit upper bound of infinity (or the configured interval duration) on the final bin. -.P +.sp Latencies are given in nanoseconds. An optional unit suffix of ns, us, ms, or s may be given after each value to specify units of nanoseconds, microseconds, miliseconds or seconds respectively, so for example, 10ms @@ -561,19 +561,19 @@ is equivalent to 10000000. Latency values with a precision of less than one milisecond can only be used when precise timestamps are enabled: if \fB--precise\fP is not given and values less than one milisecond are used it will be enabled automatically. -.P +.sp An optional \fBprogram_id\fP or \fBuser_data\fP string may be associated with the region. A \fBprogram_id\fP may then be used to select regions for subsequent list, print, and report operations. The \fBuser_data\fP stores an arbitrary string and is not used by dmstats or the device-mapper kernel statistics subsystem. -.P +.sp By default dmstats creates regions with a \fBprogram_id\fP of "dmstats". -.P +.sp On success the \fBregion_id\fP of the newly created region is printed to stdout. -.P +.sp If the \fB--filemap\fP option is given with a regular file, or list of files, as the \fBfile_path\fP argument, instead of creating regions with parameters specified on the command line, \fBdmstats\fP will open @@ -581,20 +581,20 @@ the files located at \fBfile_path\fP and create regions corresponding to the physical extents allocated to the file. This can be used to monitor statistics for individual files in the file system, for example, virtual machine images, swap areas, or large database files. -.P +.sp To work with the \fB--filemap\fP option, files must be located on a local file system, backed by a device-mapper device, that supports physical extent data using the FIEMAP ioctl (Ext4 and XFS for e.g.). -.P +.sp By default regions that map a file are placed into a group and the group alias is set to the basename of the file. This behaviour can be overridden with the \fB--alias\fP and \fB--nogroup\fP options. -.P +.sp Creating a group that maps a file automatically starts a daemon, \fBdmfilemapd\fP to monitor the file and update the mapping as the extents allocated to the file change. This behaviour can be disabled using the \fB--nomonitor\fP option. -.P +.sp Use the \fB--group\fP option to only display information for groups when listing and reporting. . @@ -604,17 +604,17 @@ when listing and reporting. Delete the specified statistics region. All counters and resources used by the region are released and the region will not appear in the output of subsequent list, print, or report operations. -.P +.sp All regions registered on a device may be removed using \fB--allregions\fP. -.P +.sp To remove all regions on all devices both \fB--allregions\fP and \fB--alldevices\fP must be used. -.P +.sp If a \fB--groupid\fP is given instead of a \fB--regionid\fP the command will attempt to delete the group and all regions that it contains. -.P +.sp If a deleted region is the first member of a group of regions the group will also be removed. . @@ -623,19 +623,19 @@ will also be removed. .br Combine one or more statistics regions on the specified device into a group. -.P +.sp The list of regions to be grouped is specified with \fB--regions\fP and an optional alias may be assigned with \fB--alias\fP. The set of regions is given as a comma-separated list of region identifiers. A continuous range of identifers spanning from \fBR1\fP to \fBR2\fP may be expressed as '\fBR1\fP-\fBR2\fP'. -.P +.sp Regions that have a histogram configured can be grouped: in this case the number of histogram bins and their bounds must match exactly. -.P +.sp On success the group list and newly created \fBgroup_id\fP are printed to stdout. -.P +.sp The group metadata is stored with the first (lowest numbered) \fBregion_id\fP in the group: deleting this region will also delete the group and other group members will be returned to their prior @@ -653,20 +653,21 @@ the list of report fields. List the statistics regions, areas, or groups registered on the device. If the \fB--allprograms\fP switch is given all regions will be listed regardless of region program ID values. -.P +.sp By default only regions and groups are included in list output. If \fB-v\fP or \fB--verbose\fP is given the report will also include a row of information for each configured group and for each area contained in each region displayed. -.P +.sp Regions that contain a single area are by default omitted from the verbose list since their properties are identical to the area that they contain - to view all regions regardless of the number of areas present use \fB--region\fP). To also view the areas contained within regions use \fB--area\fP. -.P +.sp If \fB--histogram\fP is given the report will include the bin count and latency boundary values for any configured histograms. +. .HP .CMD_PRINT .br @@ -680,16 +681,16 @@ Start a report for the specified object or for all present objects. If the count argument is specified, the report will repeat at a fixed interval set by the \fB--interval\fP option. The default interval is one second. -.P +.sp If the \fB--allprograms\fP switch is given, all regions will be listed, regardless of region program ID values. -.P +.sp If the \fB--histogram\fP is given the report will include the histogram values and latency boundaries. -.P +.sp If the \fB--relative\fP is used the default histogram field displays bin values as a percentage of the total number of I/Os. -.P +.sp Object types (areas, regions and groups) to include in the report are selected using the \fB--area\fP, \fB--region\fP, and \fB--group\fP options. @@ -699,27 +700,28 @@ options. .br Remove an existing group and return all the group's regions to their original state. -.P +.sp The group to be removed is specified using \fB--groupid\fP. +. .HP .CMD_UPDATE_FILEMAP .br Update a group of \fBdmstats\fP regions specified by \fBgroup_id\fP, that were previously created with \fB--filemap\fP, either directly, or by starting the monitoring daemon, \fBdmfilemapd\fP. -.P +.sp This will add and remove regions to reflect changes in the allocated extents of the file on-disk, since the time that it was crated or last updated. -.P +.sp Use of this command is not normally needed since the \fBdmfilemapd\fP daemon will automatically monitor filemap groups and perform these updates when required. -.P +.sp If a filemapped group was created with \fB--nomonitor\fP, or the daemon has been killed, the \fBupdate_filemap\fP can be used to manually force an update or start a new daemon. -.P +.sp Use \fB--nomonitor\fP to force a direct update and disable starting the monitoring daemon. . @@ -1229,9 +1231,13 @@ Bryn M. Reeves <bmr(a)redhat.com> . .BR dmsetup (8) .P -LVM2 resource page: https://www.sourceware.org/lvm2/ +LVM2 resource page: +.UR https://www.sourceware.org/lvm2 +.UE .br -Device-mapper resource page: http://sources.redhat.com/dm/ +Device-mapper resource page: +.UR http://sources.redhat.com/dm +.UE .P Device-mapper statistics kernel documentation .br diff --git a/man/lvconvert.8_des b/man/lvconvert.8_des index 6fd1ed9cd..cc233fb1d 100644 --- a/man/lvconvert.8_des +++ b/man/lvconvert.8_des @@ -67,5 +67,5 @@ Striped raid types support converting the layout, their stripesize and their number of stripes. The striped raid types combined with raid1 allow for conversion from -linear -> striped/raid0/raid0_meta and vice-versa by e.g. linear <-> raid1 -<-> raid5_n (then adding stripes) <-> striped/raid0/raid0_meta. +linear \[->] striped/raid0/raid0_meta and vice-versa by e.g. linear \[<>] raid1 +\[<>] raid5_n (then adding stripes) \[<>] striped/raid0/raid0_meta. diff --git a/man/lvcreate.8_end b/man/lvcreate.8_end index 19e24610a..9be3426da 100644 --- a/man/lvcreate.8_end +++ b/man/lvcreate.8_end @@ -66,7 +66,7 @@ to the first image). Create a 1TiB thin LV mythin, with 256GiB thinpool tpool0 in vg00. .br -.B lvcreate --T --size 256G --name mythin vg00/tpool0 +.B lvcreate -T -V 1T --size 256G --name mythin vg00/tpool0 Create a 1TiB thin LV, first creating a new thin pool for it, where the thin pool has 100MiB of space, uses 2 stripes, has a 64KiB stripe diff --git a/man/lvm.8_main b/man/lvm.8_main index 08af2ee33..509a635ef 100644 --- a/man/lvm.8_main +++ b/man/lvm.8_main @@ -258,7 +258,7 @@ The valid characters for VG and LV names are: .BR a - z .BR A - Z .BR 0 - 9 -.BR "+ _ . -" +.B + _ . - .P VG names cannot begin with a hyphen. The name of a new LV also cannot begin with a hyphen. However, if the @@ -274,11 +274,31 @@ argument.) .P There are also various reserved names that are used internally by lvm that can not be used as LV or VG names. A VG cannot be called anything that exists in -\fI/dev/\fP at the time of creation, nor can it be called '.' or '..'. -An LV cannot be called '.', '..', 'snapshot' or 'pvmove'. +\fI/dev/\fP at the time of creation, nor can it be called +.RB ' . ' +or +.RB ' .. '. +An LV cannot be called +.RB ' . ', +.RB ' .. ', +.RB ' snapshot ' +or +.RB ' pvmove '. The LV name may also not contain any of the following strings: -\fR'_cdata', '_cmeta', '_corig', '_mlog', '_mimage', '_pmspare', -\fR'_rimage', '_rmeta', '_tdata', '_tmeta', '_vorigin' or '_vdata'. +.RB ' _cdata ', +.RB ' _cmeta ', +.RB ' _corig ', +.RB ' _mimage ', +.RB ' _mlog ', +.RB ' _pmspare ', +.RB ' _rimage ', +.RB ' _rmeta ', +.RB ' _tdata ', +.RB ' _tmeta ', +.RB ' _vdata ', +.RB ' _vorigin ' +or +.RB ' _wcorig '. A directory bearing the name of each Volume Group is created under \fI/dev\fP when any of its Logical Volumes are activated. Each active Logical Volume is accessible from this directory as a symbolic diff --git a/man/lvm.conf.5_main b/man/lvm.conf.5_main index 63945ea2f..4289a94d6 100644 --- a/man/lvm.conf.5_main +++ b/man/lvm.conf.5_main @@ -1,4 +1,4 @@ -.TH LVM.CONF 5 "LVM TOOLS #VERSION#" "Red Hat, Inc." \" -*- nroff -*- +.TH LVM.CONF 5 "LVM TOOLS #VERSION#" "Red Hat, Inc." . .SH NAME . @@ -6,7 +6,7 @@ lvm.conf \(em Configuration file for LVM2 . .SH SYNOPSIS . -.B #DEFAULT_SYS_DIR#/lvm.conf +.I #DEFAULT_SYS_DIR#/lvm.conf . .SH DESCRIPTION . @@ -16,7 +16,7 @@ being loaded - settings read in later override earlier settings. File timestamps are checked between commands and if any have changed, all the files are reloaded. .P -For a description of each lvm.conf setting, run: +For a description of each \fBlvm.conf\fP(5) setting, run: .P .B lvmconfig --typeconfig default --withcomments --withspaces .P @@ -97,11 +97,11 @@ When several configuration methods are used at the same time and when LVM looks for the value of a particular setting, it traverses this \fBconfig cascade\fP from left to right: .P -\fBdirect config override on command line\fP -> -\fBcommand profile config\fP -> -\fBmetadata profile config\fP -> -\fBtag config\fP -> -\fBlvmlocal.conf\fP -> +\fBdirect config override on command line\fP \[->] +\fBcommand profile config\fP \[->] +\fBmetadata profile config\fP \[->] +\fBtag config\fP \[->] +\fBlvmlocal.conf\fP \[->] \fBlvm.conf\fP .P No part of this cascade is compulsory. If there's no setting value found at @@ -214,9 +214,9 @@ e.g. umask: .br .I #DEFAULT_CACHE_DIR#/.cache .br -.I #DEFAULT_LOCK_DIR# -.br .I #DEFAULT_PROFILE_DIR# +.br +.I #DEFAULT_LOCK_DIR# . .SH SEE ALSO . diff --git a/man/lvmcache.7_main b/man/lvmcache.7_main index 20463a548..48cf7b492 100644 --- a/man/lvmcache.7_main +++ b/man/lvmcache.7_main @@ -341,7 +341,8 @@ caching the main LV. .nf # lvcreate -n fast -L DataSize vg /dev/fast_ssd1 # lvcreate -n fastmeta -L MetadataSize vg /dev/fast_ssd2 -# lvconvert --type cache --cachepool fast --poolmetadata fastmeta vg/main +# lvconvert --type cache --cachepool fast \\ + --poolmetadata fastmeta vg/main .fi . .SS dm-cache cache modes @@ -397,7 +398,7 @@ Command to display the chunk size: .B lvs -o+chunksize VG/LV .P .BR lvm.conf (5) -.B cache_pool_chunk_size +.B allocation/cache_pool_chunk_size .P controls the default chunk size. .P @@ -470,7 +471,7 @@ defines the default cache settings. . Cache pools allows to set a variety of options. Lots of these settings can be specified in lvm.conf or profile settings. You can prepare -a number of different profiles in the #DEFAULT_SYS_DIR#/profile directory +a number of different profiles in the \fI#DEFAULT_SYS_DIR#/profile\fP directory and just specify the metadata profile file name when caching LV or creating cache-pool. Check the output of \fBlvmconfig --type default --withcomments\fP for a detailed description of all individual cache settings. @@ -479,22 +480,31 @@ for a detailed description of all individual cache settings. .nf # cat <<EOF > #DEFAULT_SYS_DIR#/profile/cache_big_chunk.profile allocation { - cache_pool_metadata_require_separate_pvs=0 - cache_pool_chunk_size=512 - cache_metadata_format=2 - cache_mode="writethrough" - cache_policy="smq" - cache_settings { - smq { - migration_threshold=8192 - random_threshold=4096 - } - } +.RS +cache_pool_metadata_require_separate_pvs=0 +cache_pool_chunk_size=512 +cache_metadata_format=2 +cache_mode="writethrough" +cache_policy="smq" +cache_settings { +.RS +smq { +.RS +migration_threshold=8192 +random_threshold=4096 +.RE +} +.RE +} +.RE } EOF .P -# lvcreate --cache -L10G --metadataprofile cache_big_chunk vg/main /dev/fast_ssd -# lvcreate --cache -L10G --config 'allocation/cache_pool_chunk_size=512' vg/main /dev/fast_ssd + +# lvcreate --cache -L10G --metadataprofile cache_big_chunk vg/main \\ + /dev/fast_ssd +# lvcreate --cache -L10G vg/main --config \\ + 'allocation/cache_pool_chunk_size=512' /dev/fast_ssd .fi . .SS dm-cache spare metadata LV @@ -538,7 +548,7 @@ or the longer variant .P .nf # lvcreate --type cache --size CacheDataSize \\ - --name NameCachePool VG/LV [FastPVs] + --name NameCachePool VG/LV [FastPVs] .fi .P In this command, the specified LV already exists, and is the main LV to be @@ -575,6 +585,6 @@ and the existing main LV is being converted to type cache.) .BR vgreduce (8), .BR vgsplit (8), .P -.BR cache_dump (8), .BR cache_check (8), +.BR cache_dump (8), .BR cache_repair (8) diff --git a/man/lvmdevices.8_des b/man/lvmdevices.8_des index a04a66683..52885fb59 100644 --- a/man/lvmdevices.8_des +++ b/man/lvmdevices.8_des @@ -1,5 +1,5 @@ The LVM devices file lists devices that lvm can use. The default file is -/etc/lvm/devices/system.devices, and the lvmdevices(8) command is used to +\fI#DEFAULT_SYS_DIR#/devices/system.devices\fP, and the \fBlvmdevices\fP(8) command is used to add or remove device entries. If the file does not exist, or if lvm.conf includes use_devicesfile=0, then lvm will not use a devices file. @@ -34,7 +34,7 @@ overriding the devices file. The listed devices act as a sort of devices file in terms of limiting which devices lvm will see and use. Devices that are not listed will appear to be missing to the lvm command. -Multiple devices files can be kept in /etc/lvm/devices, which allows lvm +Multiple devices files can be kept in \fI#DEFAULT_SYS_DIR#/devices\fP, which allows lvm to be used with different sets of devices, e.g. system devices do not need to be exposed to a specific application, and the application can use lvm on its own devices that are not exposed to the system. The option diff --git a/man/lvmdump.8_main b/man/lvmdump.8_main index 1fa6d817d..22675905d 100644 --- a/man/lvmdump.8_main +++ b/man/lvmdump.8_main @@ -32,15 +32,15 @@ dmsetup info .IP \[bu] table of currently running processes .IP \[bu] -recent entries from /var/log/messages (containing system messages) +recent entries from \fI/var/log/messages\fP (containing system messages) .IP \[bu] -complete lvm configuration and cache (content of #DEFAULT_SYS_DIR#) +complete lvm configuration and cache (content of \fI#DEFAULT_SYS_DIR#\fP) .IP \[bu] -list of device nodes present under /dev +list of device nodes present under \fI/dev\fP .IP \[bu] -list of files present /sys/block +list of files present \fI/sys/block\fP .IP \[bu] -list of files present /sys/devices/virtual/block +list of files present \fI/sys/devices/virtual/block\fP .IP \[bu] if enabled with -m, metadata dump will be also included .IP \[bu] @@ -99,9 +99,9 @@ controlling LVM functionality and the content of systemd journal for current boot. .TP .B -u -Gather udev info and context: /etc/udev/udev.conf file, udev daemon version +Gather udev info and context: \fI/etc/udev/udev.conf\fP file, udev daemon version (output of 'udevadm info --version' command), udev rules currently used in the system -(content of /lib/udev/rules.d and /etc/udev/rules.d directory), +(content of \fI/lib/udev/rules.d\fP and \fI/etc/udev/rules.d\fP directory), list of files in /lib/udev directory and dump of current udev database content (the output of 'udevadm info --export-db' command). . @@ -110,13 +110,17 @@ database content (the output of 'udevadm info --export-db' command). .TP .B LVM_BINARY The LVM2 binary to use. -Defaults to "lvm". -Sometimes you might need to set this to "#LVM_PATH#.static", for example. +Defaults to "\fBlvm\fP". +Sometimes you might need to set this to "\fI#LVM_PATH#.static\fP", for example. .TP .B DMSETUP_BINARY The dmsetup binary to use. -Defaults to "dmsetup". +Defaults to "\fBdmsetup\fP". . .SH SEE ALSO . -.BR lvm (8) +.BR lvm (8), +.BR lvmpolld (8), +.P +.BR udev (8), +.BR udevadm (8) diff --git a/man/lvmlockctl.8_main b/man/lvmlockctl.8_main index 8b7b00977..d5b9e927c 100644 --- a/man/lvmlockctl.8_main +++ b/man/lvmlockctl.8_main @@ -61,54 +61,54 @@ Stop all lockspaces. . .SH USAGE . -.SS info -. +.TP +.B --info This collects and displays lock state from lvmlockd. The display is primitive, incomplete and will change in future version. To print the raw lock state from lvmlockd, combine this option with --dump|-d. . -.SS dump -. +.TP +.B --dump This collects the circular log buffer of debug statements from lvmlockd and prints it. . -.SS kill -. +.TP +.B --kill This is run by sanlock when it loses access to the storage holding leases for a VG. It runs the command specified in lvm.conf lvmlockctl_kill_command to deactivate LVs in the VG. If the specified command is successful, locks will be dropped for the VG in lvmlockd -(the equivalent of lvmlockctl --drop will be run.) If no command +(the equivalent of \fBlvmlockctl --drop\fP will be run.) If no command is specified, or the command fails, then the user must intervene to forcefully deactivate LVs in the VG, and if successful, run -lvmlockctl --drop. For more, see +\fBlvmlockctl --drop\fP. For more, see .BR lvmlockd (8). . -.SS drop -. +.TP +.B --drop This should only be run after a VG has been successfully deactivated following an lvmlockctl --kill command. It clears the stale lockspace from lvmlockd. When lvmlockctl_kill_command is used, the --kill command may run drop automatically. For more, see .BR lvmlockd (8). . -.SS gl-enable -. +.TP +.B --gl-enable This enables the global lock in a sanlock VG. This is necessary if the VG that previously held the global lock is removed. For more, see .BR lvmlockd (8). . -.SS gl-disable -. +.TP +.B --gl-disable This disables the global lock in a sanlock VG. This is necessary if the global lock has mistakenly been enabled in more than one VG. The global lock should be disabled in all but one sanlock VG. For more, see .BR lvmlockd (8). . -.SS stop-lockspaces -. +.TP +.B --stop-lockspaces This tells lvmlockd to stop all lockspaces. It can be useful to stop -lockspaces for VGs that the vgchange --lock-stop comand can no longer +lockspaces for VGs that the \fBvgchange --lock-stop\fP command can no longer see, or to stop the dlm global lockspace which is not directly stopped by the vgchange command. The wait and force options can be used with this command. diff --git a/man/lvmpolld.8_main b/man/lvmpolld.8_main index 885c4a2ea..a8d99c9cd 100644 --- a/man/lvmpolld.8_main +++ b/man/lvmpolld.8_main @@ -68,14 +68,14 @@ and is equivalent to a comma-separated list \fB-l wire,debug\fP. .TP .BR -p | --pidfile " " \fIpidfile_path Path to the pidfile. This overrides both the built-in default -(#DEFAULT_PID_DIR#/lvmpolld.pid) and the environment variable +(\fI#DEFAULT_PID_DIR#/lvmpolld.pid\fP) and the environment variable \fBLVM_LVMPOLLD_PIDFILE\fP. This file is used to prevent more than one instance of the daemon running simultaneously. . .TP .BR -s | --socket " " \fIsocket_path Path to the socket file. This overrides both the built-in default -(#DEFAULT_RUN_DIR#/lvmpolld.socket) and the environment variable +(\fI#DEFAULT_RUN_DIR#/lvmpolld.socket\fP) and the environment variable \fBLVM_LVMPOLLD_SOCKET\fP. . .TP @@ -85,7 +85,7 @@ option is omitted or the value given is zero the daemon never shutdowns on idle. . .TP .BR -B | --binary " " \fIlvm_binary_path -Optional path to alternative LVM binary (default: #LVM_PATH#). Use for +Optional path to alternative LVM binary (default: \fI#LVM_PATH#\fP). Use for testing purposes only. . .TP diff --git a/man/lvmthin.7_main b/man/lvmthin.7_main index 0a9d4698f..8dc023cfe 100644 --- a/man/lvmthin.7_main +++ b/man/lvmthin.7_main @@ -870,7 +870,7 @@ To change these values globally, edit To change these values on a per-VG or per-LV basis, attach a "profile" to the VG or LV. A profile is a collection of config settings, saved in a local text file (using the lvm.conf format). lvm looks for profiles in -the profile_dir directory, e.g. #DEFAULT_SYS_DIR#/profile/. Once attached to a VG +the profile_dir directory, e.g. \fI#DEFAULT_SYS_DIR#/profile/\fP. Once attached to a VG or LV, lvm will process the VG or LV using the settings from the attached profile. A profile is named and referenced by its file name. .P @@ -901,8 +901,10 @@ profile_dir="#DEFAULT_SYS_DIR#/profile" .P # cat #DEFAULT_SYS_DIR#/profile/pool0extend.profile activation { - thin_pool_autoextend_threshold=50 - thin_pool_autoextend_percent=10 +.RS +thin_pool_autoextend_threshold=50 +thin_pool_autoextend_percent=10 +.RE } .P # lvchange --metadataprofile pool0extend vg/pool0 diff --git a/man/lvmvdo.7_main b/man/lvmvdo.7_main index 7bc27b189..3b77173c4 100644 --- a/man/lvmvdo.7_main +++ b/man/lvmvdo.7_main @@ -12,7 +12,8 @@ for primary storage. .P Deduplication is a technique for reducing the consumption of storage resources by eliminating multiple copies of duplicate blocks. Compression -takes the individual unique blocks and shrinks them. These reduced blocks are then efficiently packed together into +takes the individual unique blocks and shrinks them. +These reduced blocks are then efficiently packed together into physical blocks. Thin provisioning manages the mapping from logical blocks presented by VDO to where the data has actually been physically stored, and also eliminates any blocks of all zeroes. @@ -135,7 +136,7 @@ that can keep 100% incompressible data there. . VDO allows to set a large variety of options. Lots of these settings can be specified in lvm.conf or profile settings. You can prepare -a number of different profiles in the #DEFAULT_SYS_DIR#/profile directory +a number of different profiles in the \fI#DEFAULT_SYS_DIR#/profile\fP directory and just specify the profile file name. Check the output of \fBlvmconfig --type default --withcomments\fP for a detailed description of all individual VDO settings. @@ -144,25 +145,27 @@ for a detailed description of all individual VDO settings. .nf # cat <<EOF > #DEFAULT_SYS_DIR#/profile/vdo_create.profile allocation { - vdo_use_compression=1 - vdo_use_deduplication=1 - vdo_use_metadata_hints=1 - vdo_minimum_io_size=4096 - vdo_block_map_cache_size_mb=128 - vdo_block_map_period=16380 - vdo_check_point_frequency=0 - vdo_use_sparse_index=0 - vdo_index_memory_size_mb=256 - vdo_slab_size_mb=2048 - vdo_ack_threads=1 - vdo_bio_threads=1 - vdo_bio_rotation=64 - vdo_cpu_threads=2 - vdo_hash_zone_threads=1 - vdo_logical_threads=1 - vdo_physical_threads=1 - vdo_write_policy="auto" - vdo_max_discard=1 +.RS +vdo_use_compression=1 +vdo_use_deduplication=1 +vdo_use_metadata_hints=1 +vdo_minimum_io_size=4096 +vdo_block_map_cache_size_mb=128 +vdo_block_map_period=16380 +vdo_check_point_frequency=0 +vdo_use_sparse_index=0 +vdo_index_memory_size_mb=256 +vdo_slab_size_mb=2048 +vdo_ack_threads=1 +vdo_bio_threads=1 +vdo_bio_rotation=64 +vdo_cpu_threads=2 +vdo_hash_zone_threads=1 +vdo_logical_threads=1 +vdo_physical_threads=1 +vdo_write_policy="auto" +vdo_max_discard=1 +.RE } EOF .P @@ -175,7 +178,7 @@ EOF Disable or enable the compression and deduplication for VDOPoolLV (the volume that maintains all VDO LV(s) associated with it). .P -.B lvchange --compression [y|n] --deduplication [y|n] VG/VDOPoolLV +.B lvchange --compression y|n --deduplication y|n VG/VDOPoolLV .P .I Example .nf @@ -191,7 +194,7 @@ in the content of the virtual data for the VDOLV and how much space is already consumed with all the data and metadata blocks in the VDOPoolLV. For a detailed description, use the \fBvdostats\fP(8) command. .P -Note: \fBvdostats\fP(8) currently understands only /dev/mapper device names. +Note: \fBvdostats\fP(8) currently understands only \fI/dev/mapper\fP device names. .P .I Example .nf @@ -218,11 +221,11 @@ You can add more space to hold VDO data and metadata by extending the VDODataLV using the commands \fBlvresize\fP(8) and \fBlvextend\fP(8). The extension needs to add at least one new VDO slab. You can configure -the slab size with the \fBallocation/vdo_slab_size_mb\fP setting. +the slab size with the \fB\%allocation/\:vdo_slab_size_mb\fP setting. .P You can also enable automatic size extension of a monitored VDOPoolLV with the \fBactivation/vdo_pool_autoextend_percent\fP and -\fBactivation/vdo_pool_autoextend_threshold\fP settings. +\fB\%activation/\:vdo_pool_autoextend_threshold\fP settings. .P Note: You cannot reduce the size of a VDOPoolLV. .P @@ -287,9 +290,9 @@ Using a raid type LV for a VDODataLV. # lvconvert --type vdo-pool -V 10G vg/vdopool .fi . -.SS \n+[step]. Caching a VDODataLV or a VDOPoolLV +.SS \n+[step]. Caching a VDOPoolLV . -VDODataLV (accepts also VDOPoolLV) caching provides a mechanism +VDOPoolLV (accepts also VDODataLV volume name) caching provides a mechanism to accelerate reads and writes of already compressed and deduplicated data blocks together with VDO metadata. .P diff --git a/man/lvs.8_end b/man/lvs.8_end index 5a4ecc83c..6fdb80459 100644 --- a/man/lvs.8_end +++ b/man/lvs.8_end @@ -2,81 +2,81 @@ . The lv_attr bits are: .IP 1 3 -Volume type: (C)ache, (m)irrored, (M)irrored without initial sync, (o)rigin, -(O)rigin with merging snapshot, (r)aid, (R)aid without initial sync, -(s)napshot, merging (S)napshot, (p)vmove, (v)irtual, -mirror or raid (i)mage, mirror or raid (I)mage out-of-sync, mirror (l)og device, -under (c)onversion, thin (V)olume, (t)hin pool, (T)hin pool data, -v(d)o pool, v(D)o pool data, -raid or pool m(e)tadata or pool metadata spare. +Volume type: (\fBC\fP)ache, (\fBm\fP)irrored, (\fBM\fP)irrored without initial sync, (\fBo\fP)rigin, +(\fBO\fP)rigin with merging snapshot, (\fBr\fP)aid, (\fBR\fP)aid without initial sync, +(\fBs\fP)napshot, merging (\fBS\fP)napshot, (\fBp\fP)vmove, (\fBv\fP)irtual, +mirror or raid (\fBi\fP)mage, mirror or raid (\fBI\fP)mage out-of-sync, mirror (\fBl\fP)og device, +under (\fBc\fP)onversion, thin (\fBV\fP)olume, (\fBt\fP)hin pool, (\fBT\fP)hin pool data, +v(\fBd\fP)o pool, v(\fBD\fP)o pool data, +raid or pool m(\fBe\fP)tadata or pool metadata spare. .IP 2 3 -Permissions: (w)riteable, (r)ead-only, (R)ead-only activation of non-read-only +Permissions: (\fBw\fP)riteable, (\fBr\fP)ead-only, (\fBR\fP)ead-only activation of non-read-only volume .IP 3 3 -Allocation policy: (a)nywhere, (c)ontiguous, (i)nherited, c(l)ing, (n)ormal +Allocation policy: (\fBa\fP)nywhere, (\fBc\fP)ontiguous, (\fBi\fP)nherited, c(\fBl\fP)ing, (\fBn\fP)ormal This is capitalised if the volume is currently locked against allocation changes, for example during .BR pvmove (8). .IP 4 3 -fixed (m)inor +fixed (\fBm\fP)inor .IP 5 3 -State: (a)ctive, (h)istorical, (s)uspended, (I)nvalid snapshot, -invalid (S)uspended snapshot, snapshot (m)erge failed, -suspended snapshot (M)erge failed, mapped (d)evice present without tables, -mapped device present with (i)nactive table, thin-pool (c)heck needed, -suspended thin-pool (C)heck needed, (X) unknown +State: (\fBa\fP)ctive, (\fBh\fP)istorical, (\fBs\fP)uspended, (\fBI\fP)nvalid snapshot, +invalid (\fBS\fP)uspended snapshot, snapshot (\fBm\fP)erge failed, +suspended snapshot (\fBM\fP)erge failed, mapped (\fBd\fP)evice present without tables, +mapped device present with (\fBi\fP)nactive table, thin-pool (\fBc\fP)heck needed, +suspended thin-pool (\fBC\fP)heck needed, (\fBX\fP) unknown .IP 6 3 -device (o)pen, (X) unknown +device (\fBo\fP)pen, (\fBX\fP) unknown .IP 7 3 -Target type: (C)ache, (m)irror, (r)aid, (s)napshot, (t)hin, (u)nknown, (v)irtual. +Target type: (\fBC\fP)ache, (\fBm\fP)irror, (\fBr\fP)aid, (\fBs\fP)napshot, (\fBt\fP)hin, (\fBu\fP)nknown, (\fBv\fP)irtual. This groups logical volumes related to the same kernel target together. So, for example, mirror images, mirror logs as well as mirrors themselves appear as -(m) if they use the original device-mapper mirror kernel driver; whereas the raid -equivalents using the md raid kernel driver all appear as (r). -Snapshots using the original device-mapper driver appear as (s); whereas -snapshots of thin volumes using the new thin provisioning driver appear as (t). +(\fBm\fP) if they use the original device-mapper mirror kernel driver; whereas the raid +equivalents using the md raid kernel driver all appear as (\fBr\fP). +Snapshots using the original device-mapper driver appear as (\fBs\fP); whereas +snapshots of thin volumes using the new thin provisioning driver appear as (\fBt\fP). .IP 8 3 -Newly-allocated data blocks are overwritten with blocks of (z)eroes before use. +Newly-allocated data blocks are overwritten with blocks of (\fBz\fP)eroes before use. .IP 9 3 Volume Health, where there are currently three groups of attributes identified: .IP -Common ones for all Logical Volumes: (p)artial, (X) unknown. +Common ones for all Logical Volumes: (\fBp\fP)artial, (\fBX\fP) unknown. .br -(p)artial signifies that one or more of the Physical Volumes this Logical -Volume uses is missing from the system. (X) unknown signifies the status +(\fBp\fP)artial signifies that one or more of the Physical Volumes this Logical +Volume uses is missing from the system. (\fBX\fP) unknown signifies the status is unknown. .IP -Related to RAID Logical Volumes: (r)efresh needed, (m)ismatches exist, (w)ritemostly. +Related to RAID Logical Volumes: (\fBr\fP)efresh needed, (\fBm\fP)ismatches exist, (\fBw\fP)ritemostly. .br -(r)efresh signifies that one or more of the Physical Volumes this RAID Logical +(\fBr\fP)efresh signifies that one or more of the Physical Volumes this RAID Logical Volume uses had suffered a write error. The write error could be due to a temporary failure of that Physical Volume or an indication that it is failing. -The device should be refreshed or replaced. (m)ismatches signifies that the +The device should be refreshed or replaced. (\fBm\fP)ismatches signifies that the RAID logical volume has portions of the array that are not coherent. Inconsistencies are detected by initiating a "check" on a RAID logical volume. (The scrubbing operations, "check" and "repair", can be performed on a RAID -logical volume via the 'lvchange' command.) (w)ritemostly signifies the +logical volume via the 'lvchange' command.) (\fBw\fP)ritemostly signifies the devices in a RAID 1 logical volume that have been marked write-mostly. -Re(s)haping signifies a RAID Logical Volume is either undergoing a stripe +Re(\fBs\fP)haping signifies a RAID Logical Volume is either undergoing a stripe addition/removal, a stripe size or RAID algorithm change. -(R)emove after reshape signifies freed striped raid images to be removed. +(\fBR\fP)emove after reshape signifies freed striped raid images to be removed. .IP -Related to Thin pool Logical Volumes: (F)ailed, out of (D)ata space, -(M)etadata read only. +Related to Thin pool Logical Volumes: (\fBF\fP)ailed, out of (\fBD\fP)ata space, +(\fBM\fP)etadata read only. .br -(F)ailed is set if thin pool encounters serious failures and hence no further I/O -is permitted at all. The out of (D)ata space is set if thin pool has run out of -data space. (M)etadata read only signifies that thin pool encounters certain +(\fBF\fP)ailed is set if thin pool encounters serious failures and hence no further I/O +is permitted at all. The out of (\fBD\fP)ata space is set if thin pool has run out of +data space. (\fBM\fP)etadata read only signifies that thin pool encounters certain types of failures but it's still possible to do reads at least, but no metadata changes are allowed. .IP -Related to Thin Logical Volumes: (F)ailed. +Related to Thin Logical Volumes: (\fBF\fP)ailed. .br -(F)ailed is set when related thin pool enters Failed state and no further I/O +(\fBF\fP)ailed is set when related thin pool enters Failed state and no further I/O is permitted at all. .IP -Related to writecache logical volumes: (E)rror. +Related to writecache logical volumes: (\fBE\fP)rror. .br -(E)rror is set dm-writecache reports an error. +(\fBE\fP)rror is set dm-writecache reports an error. .IP 10 3 -s(k)ip activation: this volume is flagged to be skipped during activation. +s(\fBk\fP)ip activation: this volume is flagged to be skipped during activation. diff --git a/man/pvck.8_des b/man/pvck.8_des index b87345e3a..1d9b30a02 100644 --- a/man/pvck.8_des +++ b/man/pvck.8_des @@ -48,7 +48,7 @@ Save the entire text metadata area to a file without processing. .B --repair .br Repair headers and metadata on a PV. This uses a metadata input file that -was extracted by --dump, or a backup file (from /etc/lvm/backup). When +was extracted by --dump, or a backup file (from \fI#DEFAULT_BACKUP_DIR#\fP). When possible, use metadata saved by --dump from another PV in the same VG (or from a second metadata area on the PV). diff --git a/man/pvs.8_end b/man/pvs.8_end index e47d8e889..c18f5518b 100644 --- a/man/pvs.8_end +++ b/man/pvs.8_end @@ -2,8 +2,8 @@ . The pv_attr bits are: .IP 1 3 -(d)uplicate, (a)llocatable, (u)sed +(\fBd\fP)uplicate, (\fBa\fP)llocatable, (\fBu\fP)sed .IP 2 3 -e(x)ported +e(\fBx\fP)ported .IP 3 3 -(m)issing +(\fBm\fP)issing diff --git a/man/see_also.end b/man/see_also.end index dbe4bc1c1..e740ce588 100644 --- a/man/see_also.end +++ b/man/see_also.end @@ -1,11 +1,13 @@ +. .SH SEE ALSO +. .nh .ad l .BR lvm (8), .BR lvm.conf (5), .BR lvmconfig (8), .BR lvmdevices (8), - +.P .BR pvchange (8), .BR pvck (8), .BR pvcreate (8), @@ -15,7 +17,7 @@ .BR pvresize (8), .BR pvs (8), .BR pvscan (8), - +.P .BR vgcfgbackup (8), .BR vgcfgrestore (8), .BR vgchange (8), @@ -36,7 +38,7 @@ .BR vgs (8), .BR vgscan (8), .BR vgsplit (8), - +.P .BR lvcreate (8), .BR lvchange (8), .BR lvconvert (8), @@ -48,20 +50,20 @@ .BR lvresize (8), .BR lvs (8), .BR lvscan (8), - +.P .BR lvm-fullreport (8), .BR lvm-lvpoll (8), .BR lvm2-activation-generator (8), .BR blkdeactivate (8), .BR lvmdump (8), - +.P .BR dmeventd (8), .BR lvmpolld (8), .BR lvmlockd (8), .BR lvmlockctl (8), .BR cmirrord (8), .BR lvmdbusd (8), - +.P .BR lvmsystemid (7), .BR lvmreport (7), .BR lvmraid (7), diff --git a/man/vgs.8_end b/man/vgs.8_end index 09ece2b0d..06699187c 100644 --- a/man/vgs.8_end +++ b/man/vgs.8_end @@ -2,15 +2,15 @@ . The vg_attr bits are: .IP 1 3 -Permissions: (w)riteable, (r)ead-only +Permissions: (\fBw\fP)riteable, (\fBr\fP)ead-only .IP 2 3 -Resi(z)eable +Resi(\fBz\fP)eable .IP 3 3 -E(x)ported +E(\fBx\fP)ported .IP 4 3 -(p)artial: one or more physical volumes belonging to the volume group +(\fBp\fP)artial: one or more physical volumes belonging to the volume group are missing from the system .IP 5 3 -Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere +Allocation policy: (\fBc\fP)ontiguous, c(\fBl\fP)ing, (\fBn\fP)ormal, (\fBa\fP)nywhere .IP 6 3 -(c)lustered, (s)hared +(\fBc\fP)lustered, (\fBs\fP)hared

3 years

1
0
0 / 0

main - args: documentation enhancements

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=0f87b015b5f4251f958... Commit: 0f87b015b5f4251f9584244176b9f7c0579755e3 Parent: b1ad32acd63dedbd94b995f0d76f50343b751eff Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Thu Apr 15 21:41:33 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:40:14 2021 +0200 args: documentation enhancements Use #DEFAULT_SYS_DIR# replaceable string for devicesfile so the man pages installation respects configured settings. Update some missing lvm.conf(5) references. --- tools/args.h | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/tools/args.h b/tools/args.h index 3dcffe224..93ee737ce 100644 --- a/tools/args.h +++ b/tools/args.h @@ -37,7 +37,7 @@ arg(activationmode_ARG, '\0', "activationmode", activationmode_VAL, 0, 0, "(This does not include the \"mirror\" type, see \"raid1\" instead.)\n" "\\fBpartial\\fP allows any LV with missing PVs to be activated, and\n" "should only be used for recovery or repair.\n" - "For default, see lvm.conf/activation_mode.\n" + "For default, see \\fBlvm.conf\\fP(5) activation_mode.\n" "See \\fBlvmraid\\fP(7) for more information.\n") arg(addtag_ARG, '\0', "addtag", tag_VAL, ARG_GROUPABLE, 0, @@ -164,8 +164,8 @@ arg(compression_ARG, '\0', "compression", bool_VAL, 0, 0, "See \\fBlvmvdo\\fP(7) for more information about VDO usage.\n") arg(config_ARG, '\0', "config", string_VAL, 0, 0, - "Config settings for the command. These override lvm.conf settings.\n" - "The String arg uses the same format as lvm.conf,\n" + "Config settings for the command. These override \\fBlvm.conf\\fP(5) settings.\n" + "The String arg uses the same format as \\fBlvm.conf\\fP(5),\n" "or may use section/field syntax.\n" "See \\fBlvm.conf\\fP(5) for more information about config.\n") @@ -235,10 +235,10 @@ arg(devices_ARG, '\0', "devices", pv_VAL, ARG_GROUPABLE, 0, arg(devicesfile_ARG, '\0', "devicesfile", string_VAL, 0, 0, "A file listing devices that LVM should use.\n" - "The file must exist in /etc/lvm/devices/ and is managed\n" - "with the lvmdevices(8) command.\n" - "This overrides the lvm.conf devices/devicesfile and\n" - "devices/use_devicesfile settings.\n") + "The file must exist in \\fI#DEFAULT_SYS_DIR#/devices/\\fP and is managed\n" + "with the \\fBlvmdevices\\fP(8) command.\n" + "This overrides the \\fBlvm.conf\\fP(5) \\fBdevices/devicesfile\\fP and\n" + "\\fBdevices/use_devicesfile\\fP settings.\n") arg(discards_ARG, '\0', "discards", discards_VAL, 0, 0, "Specifies how the device-mapper thin pool layer in the kernel should\n" @@ -629,7 +629,7 @@ arg(replace_ARG, '\0', "replace", pv_VAL, ARG_GROUPABLE, 0, arg(reportformat_ARG, '\0', "reportformat", reportformat_VAL, 0, 0, "Overrides current output format for reports which is defined globally by\n" - "the report/output_format setting in lvm.conf.\n" + "the report/output_format setting in \\fBlvm.conf\\fP(5).\n" "\\fBbasic\\fP is the original format with columns and rows.\n" "If there is more than one report per command, each report is prefixed\n" "with the report name for identification. \\fBjson\\fP produces report\n" @@ -751,7 +751,7 @@ arg(syncaction_ARG, '\0', "syncaction", syncaction_VAL, 0, 0, "(mismatches between mirrors or incorrect parity values).\n" "\\fBcheck\\fP will count but not correct discrepancies.\n" "\\fBrepair\\fP will correct discrepancies.\n" - "See lvs for reporting discrepancies found or repaired.\n") + "See \\fBlvs\\fP(8) for reporting discrepancies found or repaired.\n") arg(sysinit_ARG, '\0', "sysinit", 0, 0, 0, "Indicates that vgchange/lvchange is being invoked from early system initialisation\n" @@ -845,7 +845,7 @@ arg(unquoted_ARG, '\0', "unquoted", 0, 0, 0, "pairs are not quoted.\n") arg(usepolicies_ARG, '\0', "usepolicies", 0, 0, 0, - "Perform an operation according to the policy configured in lvm.conf\n" + "Perform an operation according to the policy configured in \\fBlvm.conf\\fP(5)\n" "or a profile.\n") arg(validate_ARG, '\0', "validate", 0, 0, 0, @@ -853,7 +853,7 @@ arg(validate_ARG, '\0', "validate", 0, 0, 0, "return code. The validation is done only for the configuration\n" "at the front of the \"config cascade\". To validate the whole\n" "merged configuration tree, also use --mergedconfig.\n" - "The validation is done even if lvm.conf config/checks is disabled.\n") + "The validation is done even if \\fBlvm.conf\\fP(5) \\fBconfig/checks\\fP is disabled.\n") arg(vdo_ARG, '\0', "vdo", 0, 0, 0, "Specifies the command is handling VDO LV.\n" @@ -976,7 +976,7 @@ arg(activate_ARG, 'a', "activate", activation_VAL, 0, 0, "An autoactivation property can be set on a VG or LV to disable autoactivation,\n" "see --setautoactivation y|n in vgchange, lvchange, vgcreate, and lvcreate.\n" "Display the property with vgs or lvs \"-o autoactivation\".\n" - "The lvm.conf auto_activation_volume_list includes names of VGs or LVs\n" + "The \\fBlvm.conf\\fP(5) auto_activation_volume_list includes names of VGs or LVs\n" "that should be autoactivated, and anything not listed is not autoactivated.\n" "When auto_activation_volume_list is undefined (the default), it has no effect.\n" "If auto_activation_volume_list is defined and empty, no LVs are autoactivated.\n" @@ -993,7 +993,7 @@ arg(activate_ARG, 'a', "activate", activation_VAL, 0, 0, "be created in the active state (this does not apply to thin snapshots).\n" "The --zero option normally requires the LV to be active.\n" "If autoactivation \\fBay\\fP is used, the LV is only activated\n" - "if it matches an item in lvm.conf activation/auto_activation_volume_list.\n" + "if it matches an item in \\fBlvm.conf\\fP(5) \\fBactivation/auto_activation_volume_list\\fP.\n" "\\fBay\\fP implies --zero n and --wipesignatures n.\n" "See \\fBlvmlockd\\fP(8) for more information about activation options for shared VGs.\n") @@ -1114,7 +1114,7 @@ arg(cache_ARG, 'H', "cache", 0, 0, 0, arg(history_ARG, 'H', "history", 0, 0, 0, "Include historical LVs in the output.\n" "(This has no effect unless LVs were removed while\n" - "lvm.conf metadata/record_lvs_history was enabled.\n") + "\\fBlvm.conf\\fP(5) \\fBmetadata/record_lvs_history\\fP was enabled.\n") /* Not used */ arg(help2_ARG, '?', "", 0, 0, 0, NULL) @@ -1141,7 +1141,7 @@ arg(stripes_ARG, 'i', "stripes", number_VAL, 0, 0, "when unspecified, the default depends on the RAID type\n" "(raid0: 2, raid10: 2, raid4/5: 3, raid6: 5.)\n" "To stripe a new raid LV across all PVs by default,\n" - "see lvm.conf allocation/raid_stripe_all_devices.\n") + "see \\fBlvm.conf\\fP(5) \\fBallocation/raid_stripe_all_devices\\fP.\n") arg(stripesize_ARG, 'I', "stripesize", sizekb_VAL, 0, 0, "The amount of data that is written to one device before\n" @@ -1277,7 +1277,7 @@ arg(mirrors_ARG, 'm', "mirrors", number_VAL, 0, 0, "These are the names of the corresponding LV types, or \"segment types\".\n" "Use the --type option to specify which to use (raid1 is default,\n" "and mirror is legacy)\n" - "Use lvm.conf global/mirror_segtype_default and\n" + "Use \\fBlvm.conf\\fP(5) \\fBglobal/mirror_segtype_default\\fP and\n" "global/raid10_segtype_default to configure the default types.\n" "See the --nosync option for avoiding initial image synchronization.\n" "See \\fBlvmraid\\fP(7) for more information.\n" @@ -1291,7 +1291,7 @@ arg(mirrors_ARG, 'm', "mirrors", number_VAL, 0, 0, "These are the names of the corresponding LV types, or \"segment types\".\n" "Use the --type option to specify which to use (raid1 is default,\n" "and mirror is legacy)\n" - "Use lvm.conf global/mirror_segtype_default and\n" + "Use \\fBlvm.conf\\fP(5) \\fBglobal/mirror_segtype_default\\fP and\n" "global/raid10_segtype_default to configure the default types.\n" "The plus prefix \\fB+\\fP can be used, in which case\n" "the number is added to the current number of images,\n" @@ -1336,7 +1336,7 @@ arg(oldpath_ARG, 'n', "oldpath", 0, 0, 0, NULL) arg(options_ARG, 'o', "options", string_VAL, ARG_GROUPABLE, 0, "Comma-separated, ordered list of fields to display in columns.\n" - "String arg syntax is: [+|-|#]Field1[,Field2 ...]\n" + "String arg syntax is: [\\fB+\\fP|\\fB-\\fP|\\fB#\\fP]\\fIField1\\fP[\\fB,\\fP\\fIField2\\fP ...]\n" "The prefix \\fB+\\fP will append the specified fields to the default fields,\n" "\\fB-\\fP will remove the specified fields from the default fields, and\n" "\\fB#\\fP will compact specified fields (removing them when empty for all rows.)\n" @@ -1350,7 +1350,7 @@ arg(options_ARG, 'o', "options", string_VAL, ARG_GROUPABLE, 0, "\\fBpvseg_all\\fP all PV segment fields,\n" "\\fBseg_all\\fP all LV segment fields, and\n" "\\fBpvseg_all\\fP all PV segment columns.\n" - "See the lvm.conf report section for more config options.\n" + "See the \\fBlvm.conf\\fP(5) report section for more config options.\n" "See \\fBlvmreport\\fP(7) for more information about reporting.\n") arg(sort_ARG, 'O', "sort", string_VAL, ARG_GROUPABLE, 0, @@ -1369,7 +1369,7 @@ arg(permission_ARG, 'p', "permission", permission_VAL, 0, 0, arg(partial_ARG, 'P', "partial", 0, 0, 0, "Commands will do their best to activate LVs with missing PV extents.\n" "Missing extents may be replaced with error or zero segments\n" - "according to the lvm.conf missing_stripe_filler setting.\n" + "according to the missing_stripe_filler setting.\n" "Metadata may not be changed with this option.\n") /* Not used */ @@ -1393,7 +1393,7 @@ arg(reset_ARG, 'R', "reset", 0, 0, 0, NULL) arg(regionsize_ARG, 'R', "regionsize", regionsizemb_VAL, 0, 0, "Size of each raid or mirror synchronization region.\n" - "lvm.conf activation/raid_region_size can be used to\n" + "\\fBlvm.conf\\fP(5) \\fBactivation/raid_region_size\\fP can be used to\n" "configure a default.\n") arg(physicalextentsize_ARG, 's', "physicalextentsize", sizemb_VAL, 0, 0, @@ -1524,7 +1524,7 @@ arg(virtualsize_ARG, 'V', "virtualsize", sizemb_VAL, 0, 0, "See \\fBlvmthin\\fP(7) for more information about LVM thin provisioning.\n" "Using virtual size (-V) and actual size (-L) together creates\n" "a sparse LV.\n" - "lvm.conf global/sparse_segtype_default determines the\n" + "\\fBlvm.conf\\fP(5) \\fBglobal/sparse_segtype_default\\fP determines the\n" "default segment type used to create a sparse LV.\n" "Anything written to a sparse LV will be returned when reading from it.\n" "Reading from other areas of the LV will return blocks of zeros.\n" @@ -1539,8 +1539,8 @@ arg(wipesignatures_ARG, 'W', "wipesignatures", bool_VAL, 0, 0, "(unless --yes is used to override confirmations.)\n" "When not specified, signatures are wiped whenever zeroing is done\n" "(see --zero). This behaviour can be configured with\n" - "lvm.conf allocation/wipe_signatures_when_zeroing_new_lvs.\n" - "If blkid wiping is used (lvm.conf allocation/use_blkid_wiping)\n" + "\\fBlvm.conf\\fP(5) \\fBallocation/wipe_signatures_when_zeroing_new_lvs\\fP.\n" + "If blkid wiping is used (\\fBlvm.conf\\fP(5) \\fBallocation/use_blkid_wiping\\fP)\n" "and LVM is compiled with blkid wiping support, then the blkid(8)\n" "library is used to detect the signatures (use blkid -k to list the\n" "signatures that are recognized).\n"

3 years

1
0
0 / 0

main - commands: update definitions for thin creation

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=b1ad32acd63dedbd94b... Commit: b1ad32acd63dedbd94b995f0d76f50343b751eff Parent: 82e3b2e0adda88cd5542c97486ba6e8da28d2a47 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Fri Apr 16 18:31:27 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:40:14 2021 +0200 commands: update definitions for thin creation Add missing VG into description of thin pool creation command. Remove one duplicated thin-pool creation command. Remove options --discards and --errorwhenfull from the list when the command describes only creation of a thin volume - as these options do apply for thin-pool. Also use here more correct name OO_LVCONVERT_THINPOOL instead of OO_LVCONVERT_THIN. Reorder extra options for cache & thin-pool before common pool options. Order consistenly --stripes and --stripesize after --extents option so the options related to pools are better together. Remove invalid snapshot creation description - since this case is handled through our configurable spare volume creation. Add some missing optional --type parameters for few command instancies. --- tools/command-lines.in | 134 ++++++++++++++++++++++--------------------------- 1 file changed, 60 insertions(+), 74 deletions(-) diff --git a/tools/command-lines.in b/tools/command-lines.in index 0a3359630..459e2afb6 100644 --- a/tools/command-lines.in +++ b/tools/command-lines.in @@ -318,7 +318,7 @@ OO_LVCONVERT_POOL: --poolmetadata LV, --poolmetadatasize SizeMB, --poolmetadataspare Bool, --readahead Readahead, --chunksize SizeKB, --zero Bool, --metadataprofile String -OO_LVCONVERT_THIN: --discards Discards, --errorwhenfull Bool +OO_LVCONVERT_THINPOOL: --discards Discards, --errorwhenfull Bool OO_LVCONVERT_CACHE: --cachemetadataformat CacheMetadataFormat, --cachemode CacheMode, --cachepolicy String, @@ -519,7 +519,7 @@ RULE: all and lv_is_visible lvconvert --type thin-pool LV_linear_striped_raid_cache_error_zero OO: --stripes_long Number, --stripesize SizeKB, -OO_LVCONVERT_THIN, OO_LVCONVERT_POOL, OO_LVCONVERT +OO_LVCONVERT_THINPOOL, OO_LVCONVERT_POOL, OO_LVCONVERT OP: PV ... ID: lvconvert_to_thinpool DESC: Convert LV to type thin-pool. @@ -551,7 +551,7 @@ RULE: --poolmetadata not --readahead --stripesize --stripes_long lvconvert --thinpool LV_linear_striped_raid_cache_thinpool OO: --type thin-pool, --stripes_long Number, --stripesize SizeKB, -OO_LVCONVERT_THIN, OO_LVCONVERT_POOL, OO_LVCONVERT +OO_LVCONVERT_THINPOOL, OO_LVCONVERT_POOL, OO_LVCONVERT OP: PV ... ID: lvconvert_to_thinpool_or_swap_metadata DESC: Convert LV to type thin-pool (variant, use --type thin-pool). @@ -740,7 +740,7 @@ FLAGS: SECONDARY_SYNTAX # lvconvert --repair-cachepool LV_cachepool # DESC: Repair a cachepool. # -# lvm may want to do different things, or allow different options +# lvm may want to do different things, or allow different options # depending on which operation is being run, but as it stands, it # cannot do anything operation-specific until after the VG is read # and the LV type is known. @@ -806,7 +806,7 @@ OO_LVCREATE_CACHE: --cachemode CacheMode, --cachepolicy String, --cachesettings OO_LVCREATE_POOL: --poolmetadatasize SizeMB, --poolmetadataspare Bool, --chunksize SizeKB -OO_LVCREATE_THIN: --discards Discards, --errorwhenfull Bool +OO_LVCREATE_THINPOOL: --discards Discards, --errorwhenfull Bool OO_LVCREATE_VDO: --compression Bool, --deduplication Bool --- @@ -867,7 +867,7 @@ DESC: Create a linear LV. # R12. c,d,e: raid10 with specified stripes and mirrors # # R13. d: striped with specified stripes -# R14. e: mirror with specified mirrors +# R14. e: mirror with specified mirrors # R15. d,e: raid10 with specified mirrors # R1,R2 (--type striped with or without --stripes) @@ -880,15 +880,15 @@ FLAGS: SECONDARY_SYNTAX # R13 (just --stripes) lvcreate --stripes Number --size SizeMB VG -OO: --stripesize SizeKB, OO_LVCREATE +OO: --stripesize SizeKB, --type striped, OO_LVCREATE OP: PV ... ID: lvcreate_striped DESC: Create a striped LV (infers --type striped). # R5,R7 (--type mirror with or without --mirrors) lvcreate --type mirror --size SizeMB VG -OO: --mirrors PNumber, --mirrorlog MirrorLog, --regionsize RegionSize, ---stripes Number, --stripesize SizeKB, OO_LVCREATE +OO: --stripes Number, --stripesize SizeKB, +--mirrors PNumber, --mirrorlog MirrorLog, --regionsize RegionSize, OO_LVCREATE OP: PV ... ID: lvcreate_mirror DESC: Create a mirror LV (also see --type raid1). @@ -897,15 +897,16 @@ FLAGS: SECONDARY_SYNTAX # R14 (just --mirrors) # alternate form of lvcreate --type raid1|mirror lvcreate --mirrors PNumber --size SizeMB VG -OO: --mirrorlog MirrorLog, --regionsize RegionSize, --minrecoveryrate SizeKB, --maxrecoveryrate SizeKB, OO_LVCREATE +OO: --stripes Number, --stripesize SizeKB, +--mirrorlog MirrorLog, --regionsize RegionSize, --minrecoveryrate SizeKB, --maxrecoveryrate SizeKB, OO_LVCREATE OP: PV ... ID: lvcreate_mirror_or_raid1 DESC: Create a raid1 or mirror LV (infers --type raid1|mirror). # R9,R10,R11,R12 (--type raid with any use of --stripes/--mirrors) lvcreate --type raid --size SizeMB VG -OO: --mirrors PNumber, --stripes Number, --stripesize SizeKB, ---regionsize RegionSize, --minrecoveryrate SizeKB, --maxrecoveryrate SizeKB, +OO: --stripes Number, --stripesize SizeKB, +--mirrors PNumber, --regionsize RegionSize, --minrecoveryrate SizeKB, --maxrecoveryrate SizeKB, --raidintegrity Bool, --raidintegritymode String, --raidintegrityblocksize Number, OO_LVCREATE OP: PV ... ID: lvcreate_raid_any @@ -953,18 +954,11 @@ DESC: Create a sparse COW snapshot LV of a virtual origin LV DESC: (also see --snapshot). FLAGS: SECONDARY_SYNTAX -lvcreate --snapshot --size SizeMB --virtualsize SizeMB VG -OO: --type snapshot, --chunksize SizeKB, OO_LVCREATE -OP: PV ... -ID: lvcreate_cow_snapshot_with_virtual_origin -DESC: Create a sparse COW snapshot LV of a virtual origin LV. -FLAGS: SECONDARY_SYNTAX - --- lvcreate --type thin-pool --size SizeMB VG -OO: --thinpool LV_new, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --thinpool LV_new, --stripes Number, --stripesize SizeKB, +--thin, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thinpool @@ -972,8 +966,8 @@ DESC: Create a thin pool. # alternate form of lvcreate --type thin-pool lvcreate --thin --size SizeMB VG -OO: --type thin-pool, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--type thin-pool, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thinpool @@ -982,8 +976,8 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin-pool lvcreate --size SizeMB --thinpool LV_new VG -OO: --thin, --type thin-pool, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--thin, --type thin-pool, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thinpool @@ -999,14 +993,16 @@ FLAGS: SECONDARY_SYNTAX # --type cache-pool. lvcreate --type cache-pool --size SizeMB VG -OO: --cache, OO_LVCREATE_POOL, OO_LVCREATE_CACHE, OO_LVCREATE +OO: --stripes Number, --stripesize SizeKB, +--cache, OO_LVCREATE_CACHE, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... ID: lvcreate_cachepool DESC: Create a cache pool. # alternate form of lvcreate --type cache-pool lvcreate --type cache-pool --size SizeMB --cachepool LV_new VG -OO: --cache, OO_LVCREATE_POOL, OO_LVCREATE_CACHE, OO_LVCREATE +OO: --stripes Number, --stripesize SizeKB, +--cache, OO_LVCREATE_CACHE, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... ID: lvcreate_cachepool DESC: Create a cache pool named by the --cachepool arg @@ -1016,7 +1012,7 @@ FLAGS: SECONDARY_SYNTAX --- lvcreate --type thin --virtualsize SizeMB --thinpool LV_thinpool VG -OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE +OO: --thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_vol DESC: Create a thin LV in a thin pool. @@ -1024,7 +1020,7 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin lvcreate --type thin --virtualsize SizeMB LV_thinpool -OO: --thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_vol DESC: Create a thin LV in a thin pool named in the first arg @@ -1036,14 +1032,14 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin lvcreate --virtualsize SizeMB --thinpool LV_thinpool VG -OO: --type thin, --thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --type thin, --thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_vol DESC: Create a thin LV in a thin pool (infers --type thin). # alternate form of lvcreate --type thin lvcreate --virtualsize SizeMB LV_thinpool -OO: --type thin, --thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --type thin, --thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_vol DESC: Create a thin LV in the thin pool named in the first arg @@ -1054,7 +1050,7 @@ FLAGS: SECONDARY_SYNTAX --- lvcreate --type thin LV_thin -OO: --thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_snapshot DESC: Create a thin LV that is a snapshot of an existing thin LV. @@ -1062,7 +1058,7 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin lvcreate --thin LV_thin -OO: --type thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --type thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_snapshot DESC: Create a thin LV that is a snapshot of an existing thin LV @@ -1071,21 +1067,21 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin lvcreate --snapshot LV_thin -OO: --type thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --type thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_snapshot DESC: Create a thin LV that is a snapshot of an existing thin LV DESC: (infers --type thin). lvcreate --type thin --thinpool LV_thinpool LV -OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE +OO: --thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_snapshot_of_external DESC: Create a thin LV that is a snapshot of an external origin LV. # alternate form of lvcreate --type thin --thinpool LV_thinpool LV lvcreate --snapshot --thinpool LV_thinpool LV -OO: --type thin, OO_LVCREATE_THIN, OO_LVCREATE +OO: --type thin, OO_LVCREATE IO: --mirrors 0 ID: lvcreate_thin_snapshot_of_external DESC: Create a thin LV that is a snapshot of an external origin LV @@ -1095,16 +1091,16 @@ FLAGS: SECONDARY_SYNTAX --- lvcreate --type vdo --size SizeMB VG -OO: --vdo, --vdopool LV_new, OO_LVCREATE, OO_LVCREATE_VDO, ---virtualsize SizeMB, --stripes Number, --stripesize SizeKB, +OO: --stripes Number, --stripesize SizeKB, +--vdo, --virtualsize SizeMB, --vdopool LV_new, OO_LVCREATE_VDO, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_vdo_vol DESC: Create a LV that returns VDO when used. lvcreate --vdo --size SizeMB VG -OO: --vdopool LV_new, OO_LVCREATE, OO_LVCREATE_VDO, ---virtualsize SizeMB, --stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--type vdo, --virtualsize SizeMB, --vdopool LV_new, OO_LVCREATE_VDO, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_vdo_vol @@ -1112,8 +1108,8 @@ DESC: Create a VDO LV with VDO pool. FLAGS: SECONDARY_SYNTAX lvcreate --vdopool LV_new --size SizeMB VG -OO: --vdo, --type vdo, OO_LVCREATE, OO_LVCREATE_VDO, ---virtualsize SizeMB, --stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--vdo, --type vdo, --virtualsize SizeMB, OO_LVCREATE_VDO, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_vdo_vol @@ -1138,32 +1134,20 @@ FLAGS: SECONDARY_SYNTAX # definition. Note that when LV_new is used in arg pos 1, # it needs to include a VG name, i.e. VG/LV_new -lvcreate --type thin --virtualsize SizeMB --size SizeMB --thinpool LV_new -OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +lvcreate --type thin --virtualsize SizeMB --size SizeMB --thinpool LV_new VG +OO: --stripes Number, --stripesize SizeKB, +--thin, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thin_vol_and_thinpool DESC: Create a thin LV, first creating a thin pool for it, DESC: where the new thin pool is named by the --thinpool arg. - -# alternate form of lvcreate --type thin -lvcreate --virtualsize SizeMB --size SizeMB --thinpool LV_new -OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB -OP: PV ... -IO: --mirrors 0 -ID: lvcreate_thin_vol_and_thinpool -DESC: Create a thin LV, first creating a thin pool for it, -DESC: where the new thin pool is named by the --thinpool arg -DESC: (variant, infers --type thin). FLAGS: SECONDARY_SYNTAX -# same as prev but accepts VG pos arg # alternate form of lvcreate --type thin lvcreate --virtualsize SizeMB --size SizeMB --thinpool LV_new VG -OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--type thin, --thin, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thin_vol_and_thinpool @@ -1174,8 +1158,8 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin lvcreate --type thin --virtualsize SizeMB --size SizeMB LV_new|VG -OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--thin, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thin_vol_and_thinpool @@ -1187,8 +1171,8 @@ FLAGS: SECONDARY_SYNTAX # alternate form of lvcreate --type thin lvcreate --thin --virtualsize SizeMB --size SizeMB LV_new|VG -OO: OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--type thin, OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thin_vol_and_thinpool @@ -1201,8 +1185,9 @@ FLAGS: SECONDARY_SYNTAX --- lvcreate --size SizeMB --virtualsize SizeMB VG -OO: --type snapshot, --snapshot, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--type String, --snapshot, --thin, +OO_LVCREATE_THINPOOL, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... IO: --mirrors 0 ID: lvcreate_thin_vol_with_thinpool_or_sparse_snapshot @@ -1221,8 +1206,8 @@ FLAGS: SECONDARY_SYNTAX # is used to create the cache LV lvcreate --type cache --size SizeMB --cachepool LV_cachepool VG -OO: --cache, OO_LVCREATE_POOL, OO_LVCREATE_CACHE, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--cache, OO_LVCREATE_CACHE, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... ID: lvcreate_and_attach_cachepool DESC: Create a new LV, then attach the specified cachepool @@ -1231,8 +1216,8 @@ DESC: which converts the new LV to type cache. # alternate form of lvcreate --type cache # (omits the --type cache option which is inferred) lvcreate --size SizeMB --cachepool LV_cachepool VG -OO: --type cache, --cache, OO_LVCREATE_CACHE, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--cache, --type cache, OO_LVCREATE_CACHE, OO_LVCREATE OP: PV ... ID: lvcreate_and_attach_cachepool_v2 DESC: Create a new LV, then attach the specified cachepool @@ -1244,8 +1229,8 @@ FLAGS: SECONDARY_SYNTAX # (moves cachepool from option arg to position arg, # dropping the normal VG position arg) lvcreate --type cache --size SizeMB LV_cachepool -OO: --cache, OO_LVCREATE_POOL, OO_LVCREATE_CACHE, OO_LVCREATE, ---stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--cache, OO_LVCREATE_CACHE, OO_LVCREATE_POOL, OO_LVCREATE OP: PV ... ID: lvcreate_and_attach_cachepool_v3 DESC: Create a new LV, then attach the specified cachepool @@ -1275,7 +1260,7 @@ FLAGS: SECONDARY_SYNTAX # the LV type is known. lvcreate --cache --size SizeMB LV -OO: OO_LVCREATE_CACHE, OO_LVCREATE_POOL, OO_LVCREATE, +OO: --type cache, OO_LVCREATE_CACHE, OO_LVCREATE_POOL, OO_LVCREATE, --stripes Number, --stripesize SizeKB OP: PV ... ID: lvcreate_new_plus_old_cachepool_or_lvconvert_old_plus_new_cachepool @@ -1294,14 +1279,15 @@ FLAGS: SECONDARY_SYNTAX # the new LV to type cache or writecache. lvcreate --type cache --size SizeMB --cachevol LV VG -OO: OO_LVCREATE, OO_LVCREATE_CACHE, --stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, OO_LVCREATE_CACHE, OO_LVCREATE OP: PV ... ID: lvcreate_and_attach_cachevol_for_cache DESC: Create a new LV, then attach the specified cachevol DESC: which converts the new LV to type cache. lvcreate --type cache --size SizeMB --cachedevice PV VG -OO: OO_LVCREATE, OO_LVCREATE_CACHE, --cachesize SizeMB, --stripes Number, --stripesize SizeKB +OO: --stripes Number, --stripesize SizeKB, +--cachesize SizeMB, OO_LVCREATE_CACHE, OO_LVCREATE OP: PV ... ID: lvcreate_and_attach_cachedevice_for_cache DESC: Create a new LV, then attach a cachevol created from

3 years

1
0
0 / 0

main - tools: correct units description

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=82e3b2e0adda88cd554... Commit: 82e3b2e0adda88cd5542c97486ba6e8da28d2a47 Parent: 7bde16f5e17e8379f47696c731849176cd2f83b0 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Fri Apr 16 21:29:10 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:40:14 2021 +0200 tools: correct units description Option --units takes also [Number] to express size in configurable units. --- tools/vals.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/vals.h b/tools/vals.h index 098dc9e4e..addbea2f2 100644 --- a/tools/vals.h +++ b/tools/vals.h @@ -127,7 +127,7 @@ val(pextents_VAL, pextents_arg, "PExtents", "[+]Number[PERCENT]") val(nextents_VAL, nextents_arg, "NExtents", "[-]Number[PERCENT]") val(permission_VAL, permission_arg, "Permission", "rw|r") val(metadatatype_VAL, metadatatype_arg, "MetadataType", "lvm2") -val(units_VAL, string_arg, "Units", "r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E") +val(units_VAL, string_arg, "Units", "[Number]r|R|h|H|b|B|s|S|k|K|m|M|g|G|t|T|p|P|e|E") val(segtype_VAL, segtype_arg, "SegType", "linear|striped|snapshot|raid|mirror|thin|thin-pool|vdo|vdo-pool|cache|cache-pool|writecache") val(alloc_VAL, alloc_arg, "Alloc", "contiguous|cling|cling_by_tags|normal|anywhere|inherit") val(locktype_VAL, locktype_arg, "LockType", "sanlock|dlm|none")

3 years

1
0
0 / 0

main - man-generator: markup updates

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=7bde16f5e17e8379f47... Commit: 7bde16f5e17e8379f47696c731849176cd2f83b0 Parent: d94e5ba5afad7297852e4826be21ae30d39f9541 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Sat Apr 17 00:21:31 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:40:07 2021 +0200 man-generator: markup updates Emit .ad l / .ad b less frequently around larger blocks we want to keep left aligned. Avoid emittting empty lines. Reduce .HP usage and replace it with .TP. However keep .HP for all option listings, as i.e. html rendering can't handle well combintion of .TP an .HP together and .TP alone is not indenting 2nd. line of long option line. (For .TP line we don't need to emit .br) Surround .SH with dots for better look. For some .TP use plain more readable .I for a line. Support rendering of optional [Number] (for --units). Use better markup for units and instead of long markup string, show individual units with markup. --- tools/command.c | 166 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 84 insertions(+), 82 deletions(-) diff --git a/tools/command.c b/tools/command.c index cb261531c..b78271373 100644 --- a/tools/command.c +++ b/tools/command.c @@ -35,7 +35,7 @@ #include <getopt.h> const char *_lvt_enum_to_name(int lvt_enum); - +const size_t _LONG_LINE = 42; /* length of line that neededs .nh .. .hy */ /* * This file can be compiled by itself as a man page generator. */ @@ -2180,7 +2180,7 @@ void print_usage_common_cmd(struct command_name *cname, struct command *cmd) printf(" ]"); } - printf("\n\n"); + printf(".P\n"); } void print_usage_notes(struct command_name *cname) @@ -2369,13 +2369,19 @@ static void _print_val_man(struct command_name *cname, int opt_enum, int val_enu if (strchr(str, '|')) { if (!(line = strdup(str))) return; - if ((_was_hyphen = (strlen(line) > 42))) + if ((_was_hyphen = (strlen(line) > _LONG_LINE))) /* TODO: prevent line to end with already printed space */ - printf("\n.nh\n"); + printf("\\c\n.nh\n\\%%"); _split_line(line, &line_argc, line_argv, '|'); for (i = 0; i < line_argc; i++) { if (i) printf("|%s", _was_hyphen ? "\\:" : ""); + + if (strncmp(line_argv[i], "[Number]", 8) == 0) { + printf("[\\fINumber\\fP]"); + line_argv[i] += 8; + } + if (strstr(line_argv[i], "Number")) printf("\\fI%s\\fP", line_argv[i]); else @@ -2719,6 +2725,7 @@ static void _print_man_usage(char *lvmname, struct command *cmd) if (cmd->oo_count) { printf(".RS 4\n"); + printf(".ad l\n"); if (include_extents) { /* @@ -2726,12 +2733,10 @@ static void _print_man_usage(char *lvmname, struct command *cmd) * actual val type for extents_ARG has been adjusted * in opt_names[] according to the command name. */ - printf(".ad l\n"); printf("[ \\fB-l\\fP|\\fB--extents\\fP "); _print_val_man(cname, extents_ARG, opt_names[extents_ARG].val_enum); printf_hyphen(']'); - printf(".ad b\n"); sep = 1; } @@ -2751,7 +2756,6 @@ static void _print_man_usage(char *lvmname, struct command *cmd) if (sep) printf(".br\n"); - printf(".ad l\n"); printf("[ \\fB-%c\\fP|\\fB%s\\fP", opt_names[opt_enum].short_opt, @@ -2762,7 +2766,6 @@ static void _print_man_usage(char *lvmname, struct command *cmd) _print_def_man(cname, opt_enum, &cmd->optional_opt_args[oo].def, 1, NULL); } printf_hyphen(']'); - printf(".ad b\n"); sep = 1; } @@ -2782,7 +2785,6 @@ static void _print_man_usage(char *lvmname, struct command *cmd) if (sep) printf(".br\n"); - printf(".ad l\n"); /* space alignment without short opt */ printf("[ "); @@ -2794,7 +2796,6 @@ static void _print_man_usage(char *lvmname, struct command *cmd) _print_def_man(cname, opt_enum, &cmd->optional_opt_args[oo].def, 1, NULL); } printf_hyphen(']'); - printf(".ad b\n"); sep = 1; } @@ -2804,8 +2805,8 @@ static void _print_man_usage(char *lvmname, struct command *cmd) /* printf(" "); */ } printf("[ COMMON_OPTIONS ]\n"); + printf(".ad b\n"); printf(".RE\n"); - printf(".br\n"); } op_count: @@ -2828,11 +2829,10 @@ static void _print_man_usage(char *lvmname, struct command *cmd) printf(".RE\n"); out: + printf(".P\n"); if (!lv_type_bits) return; - printf(".br\n"); - printf("\n"); printf(".RS 4\n"); if (lv_type_bits) { @@ -2844,7 +2844,7 @@ out: printf("\n"); } printf(".RE\n"); - printf(".br\n"); + printf(".P\n"); } /* @@ -2878,6 +2878,7 @@ static void _print_man_usage_common_lvm(struct command *cmd) sep = 0; printf(".RS 4\n"); + printf(".ad l\n"); /* print those with short opts */ for (i = 0; i < ARG_COUNT; i++) { @@ -2891,7 +2892,6 @@ static void _print_man_usage_common_lvm(struct command *cmd) if (sep) printf(".br\n"); - printf(".ad l\n"); for (oo = 0; oo < cmd->oo_count; oo++) { if (cmd->optional_opt_args[oo].opt != opt_enum) @@ -2906,7 +2906,6 @@ static void _print_man_usage_common_lvm(struct command *cmd) _print_def_man(cname, opt_enum, &cmd->optional_opt_args[oo].def, 1, NULL); } printf_hyphen(']'); - printf(".ad b\n"); sep = 1; break; } @@ -2925,7 +2924,6 @@ static void _print_man_usage_common_lvm(struct command *cmd) if (sep) printf(".br\n"); - printf(".ad l\n"); for (oo = 0; oo < cmd->oo_count; oo++) { if (cmd->optional_opt_args[oo].opt != opt_enum) @@ -2941,14 +2939,13 @@ static void _print_man_usage_common_lvm(struct command *cmd) _print_def_man(cname, opt_enum, &cmd->optional_opt_args[oo].def, 1, NULL); } printf_hyphen(']'); - printf(".ad b\n"); sep = 1; break; } } + printf(".ad b\n"); printf(".RE\n"); - return; } static void _print_man_usage_common_cmd(struct command *cmd) @@ -2968,6 +2965,7 @@ static void _print_man_usage_common_cmd(struct command *cmd) sep = 0; printf(".RS 4\n"); + printf(".ad l\n"); /* print those with short opts */ for (i = 0; i < ARG_COUNT; i++) { @@ -2988,7 +2986,6 @@ static void _print_man_usage_common_cmd(struct command *cmd) if (sep) printf(".br\n"); - printf(".ad l\n"); for (oo = 0; oo < cmd->oo_count; oo++) { if (cmd->optional_opt_args[oo].opt != opt_enum) @@ -3003,11 +3000,9 @@ static void _print_man_usage_common_cmd(struct command *cmd) _print_def_man(cname, opt_enum, &cmd->optional_opt_args[oo].def, 1, NULL); } printf_hyphen(']'); - printf(".ad b\n"); sep = 1; break; } - } /* print those without short opts */ @@ -3029,7 +3024,6 @@ static void _print_man_usage_common_cmd(struct command *cmd) if (sep) printf(".br\n"); - printf(".ad l\n"); for (oo = 0; oo < cmd->oo_count; oo++) { if (cmd->optional_opt_args[oo].opt != opt_enum) @@ -3045,15 +3039,14 @@ static void _print_man_usage_common_cmd(struct command *cmd) _print_def_man(cname, opt_enum, &cmd->optional_opt_args[oo].def, 1, NULL); } printf_hyphen(']'); - printf(".ad b\n"); sep = 1; break; } } + printf(".ad b\n"); printf(".RE\n"); - printf("\n"); - return; + printf(".P\n"); } /* @@ -3146,6 +3139,7 @@ static void _print_man_all_options_list(struct command_name *cname) int opt_enum, val_enum; int sep = 0; int i; + int adl = 0; for (i = 0; i < ARG_COUNT; i++) { opt_enum = opt_names_alpha[i]->opt_enum; @@ -3155,7 +3149,11 @@ static void _print_man_all_options_list(struct command_name *cname) if (sep) printf(".br\n"); - printf(".ad l\n"); + + if (!adl) { + printf(".ad l\n"); + adl = 1; + } if (opt_names[opt_enum].short_opt) { printf(" \\fB-%c\\fP|\\fB%s\\fP", @@ -3180,10 +3178,13 @@ static void _print_man_all_options_list(struct command_name *cname) _print_val_man(cname, opt_enum, val_enum); } - printf("\n.ad b\n"); - + printf("\n"); sep = 1; } + + if (adl) + printf(".ad b\n"); + } /* @@ -3194,6 +3195,7 @@ static void _print_man_all_options_desc(struct command_name *cname) { int opt_enum, val_enum; int i; + int adl; for (i = 0; i < ARG_COUNT; i++) { opt_enum = opt_names_alpha[i]->opt_enum; @@ -3201,9 +3203,22 @@ static void _print_man_all_options_desc(struct command_name *cname) if (!cname->all_options[opt_enum]) continue; - printf(".HP\n"); + val_enum = opt_names[opt_enum].val_enum; - printf(".ad l\n"); + if (val_names[val_enum].usage && + (strlen(val_names[val_enum].usage) > _LONG_LINE)) { + printf(".\n.HP\n"); + printf(".ad l\n"); + adl = 1; + } else { + /* printf(".\n.TP\n"); + * ATM HTML rendering can't handle HP and TP mixing properly + * so still keeping .HP usage for this case + * untill some better workaround is found + * .TP does not need .br */ + printf(".\n.HP\n"); + adl = 0; + } if (opt_names[opt_enum].short_opt) { printf("\\fB-%c\\fP|\\fB%s\\fP", @@ -3213,7 +3228,6 @@ static void _print_man_all_options_desc(struct command_name *cname) printf("\\fB%s\\fP", _man_long_opt_name(cname->name, opt_enum)); } - val_enum = opt_names[opt_enum].val_enum; if (!val_names[val_enum].fn) { /* takes no arg */ @@ -3230,13 +3244,15 @@ static void _print_man_all_options_desc(struct command_name *cname) if (opt_names[opt_enum].flags & ARG_COUNTABLE) printf(" ..."); - if (opt_names[opt_enum].desc) { - printf("\n"); - printf(".br\n"); + printf("\n"); + if (adl) { printf(".ad b\n"); + } + printf(".br\n"); + + if (opt_names[opt_enum].desc) { _print_man_option_desc(cname, opt_enum); - } else - printf(".ad b\n"); + } } } @@ -3299,11 +3315,9 @@ static void _print_man_all_positions_desc(struct command_name *cname) } if (has_vg_val) { - printf(".HP\n"); + printf(".TP\n"); - printf("\\fI%s\\fP", val_names[vg_VAL].name); - printf("\n"); - printf(".br\n"); + printf(".I %s\n", val_names[vg_VAL].name); printf("Volume Group name. See \\fBlvm\\fP(8) for valid names.\n"); if (!strcmp(cname->name, "lvcreate")) @@ -3313,11 +3327,9 @@ static void _print_man_all_positions_desc(struct command_name *cname) } if (has_lv_val) { - printf(".HP\n"); + printf(".TP\n"); - printf("\\fI%s\\fP", val_names[lv_VAL].name); - printf("\n"); - printf(".br\n"); + printf(".I %s\n", val_names[lv_VAL].name); printf("Logical Volume name. See \\fBlvm\\fP(8) for valid names.\n" "An LV positional arg generally includes the VG name and LV name, e.g. VG/LV.\n"); @@ -3328,11 +3340,9 @@ static void _print_man_all_positions_desc(struct command_name *cname) } if (has_pv_val) { - printf(".HP\n"); + printf(".TP\n"); - printf("\\fI%s\\fP", val_names[pv_VAL].name); - printf("\n"); - printf(".br\n"); + printf(".I %s\n", val_names[pv_VAL].name); printf("Physical Volume name, a device path under /dev.\n" "For commands managing physical extents, a PV positional arg\n" "generally accepts a suffix indicating a range (or multiple ranges)\n" @@ -3343,21 +3353,17 @@ static void _print_man_all_positions_desc(struct command_name *cname) } if (has_tag_val) { - printf(".HP\n"); + printf(".TP\n"); - printf("\\fI%s\\fP", val_names[tag_VAL].name); - printf("\n"); - printf(".br\n"); + printf(".I %s\n", val_names[tag_VAL].name); printf("Tag name. See \\fBlvm\\fP(8) for information about tag names and using tags\n" "in place of a VG, LV or PV.\n"); } if (has_select_val) { - printf(".HP\n"); + printf(".TP\n"); - printf("\\fI%s\\fP", val_names[select_VAL].name); - printf("\n"); - printf(".br\n"); + printf(".I %s\n", val_names[select_VAL].name); printf("Select indicates that a required positional parameter can\n" "be omitted if the \\fB--select\\fP option is used.\n" "No arg appears in this position.\n"); @@ -3365,10 +3371,8 @@ static void _print_man_all_positions_desc(struct command_name *cname) /* Every command uses a string arg somewhere. */ - printf(".HP\n"); - printf("\\fI%s\\fP", val_names[string_VAL].name); - printf("\n"); - printf(".br\n"); + printf(".TP\n"); + printf(".I %s\n", val_names[string_VAL].name); printf("See the option description for information about the string content.\n"); /* @@ -3377,21 +3381,20 @@ static void _print_man_all_positions_desc(struct command_name *cname) * so common that we should probably always print it. */ - printf(".HP\n"); - printf("\\fISize\\fP[UNIT]"); - printf("\n"); - printf(".br\n"); + printf(".TP\n"); + printf(".IR Size [UNIT]\n"); printf("Size is an input number that accepts an optional unit.\n" "Input units are always treated as base two values, regardless of\n" "capitalization, e.g. 'k' and 'K' both refer to 1024.\n" "The default input unit is specified by letter, followed by |UNIT.\n" - "UNIT represents other possible input units: \\fBbBsSkKmMgGtTpPeE\\fP.\n" - "b|B is bytes, s|S is sectors of 512 bytes, k|K is KiB,\n" - "m|M is MiB, g|G is GiB, t|T is TiB, p|P is PiB, e|E is EiB.\n" + "UNIT represents other possible input units:\n" + ".BR b | B\nis bytes,\n.BR s | S\nis sectors of 512 bytes,\n.BR k | K\nis KiB,\n" + ".BR m | M\nis MiB,\n.BR g | G\nis GiB,\n.BR t | T\nis TiB,\n" + ".BR p | P\nis PiB,\n.BR e | E\nis EiB.\n" "(This should not be confused with the output control --units, where\n" "capital letters mean multiple of 1000.)\n"); - printf(".SH ENVIRONMENT VARIABLES\n"); + printf(".\n.SH ENVIRONMENT VARIABLES\n.\n"); printf("See \\fBlvm\\fP(8) for information about environment variables used by lvm.\n" "For example, LVM_VG_NAME can generally be substituted for a required VG parameter.\n"); } @@ -3482,7 +3485,7 @@ static int _include_description_file(char *name, char *des_file) } buf[sz] = '\0'; - printf(".SH DESCRIPTION\n%s", buf); + printf(".\n.SH DESCRIPTION\n.\n%s", buf); r = 1; out_free: @@ -3518,9 +3521,9 @@ static int _print_man(char *name, char *des_file, int secondary) _print_man_usage_common_cmd(prev_cmd); _print_man_usage_common_lvm(prev_cmd); - printf(".SH OPTIONS\n"); + printf(".\n.SH OPTIONS\n.\n"); _print_man_all_options_desc(cname); - printf(".SH VARIABLES\n"); + printf(".\n.SH VARIABLES\n.\n"); _print_man_all_positions_desc(cname); prev_cmd = NULL; @@ -3536,14 +3539,13 @@ static int _print_man(char *name, char *des_file, int secondary) continue; if (!prev_cmd || strcmp(prev_cmd->name, cmd->name)) { - printf(".SH NAME\n"); + printf(".\n.SH NAME\n.\n"); if (cname && cname->desc) printf("%s \\(em %s\n", lvmname, cname->desc); else printf("%s\n", lvmname); - printf(".\n"); - printf(".SH SYNOPSIS\n"); + printf(".\n.SH SYNOPSIS\n.\n"); prev_cmd = cmd; if (!(cname = _find_command_name(cmd->name))) @@ -3579,7 +3581,7 @@ static int _print_man(char *name, char *des_file, int secondary) if (des_file && !_include_description_file(lvmname, des_file)) return 0; - printf(".SH USAGE\n"); + printf(".\n.SH USAGE\n.\n"); } if (cmd->desc) { @@ -3593,17 +3595,17 @@ static int _print_man(char *name, char *des_file, int secondary) _print_man_usage_common_cmd(cmd); _print_man_usage_common_lvm(cmd); - printf("\n"); - printf(".SH OPTIONS\n"); + printf(".\n.SH OPTIONS\n.\n"); _print_man_all_options_desc(cname); - printf(".SH VARIABLES\n"); + printf(".\n.SH VARIABLES\n.\n"); _print_man_all_positions_desc(cname); } else { - if (cname->variants > 2) + if (cname->variants > 2) { printf("\\(em\n"); + printf(".P\n"); + } } - printf("\n"); continue; } @@ -3634,7 +3636,7 @@ static void _print_man_secondary(char *name) continue; if (!header) { - printf(".SH ADVANCED USAGE\n"); + printf(".\n.SH ADVANCED USAGE\n.\n"); printf("Alternate command forms, advanced command usage, and listing of all valid syntax for completeness.\n"); printf(".P\n"); header = 1;

3 years

1
0
0 / 0

main - man-generator: use \(em

by Zdenek Kabelac

Gitweb: https://sourceware.org/git/?p=lvm2.git;a=commitdiff;h=d94e5ba5afad7297852... Commit: d94e5ba5afad7297852e4826be21ae30d39f9541 Parent: efd0939583484b85ddb8ed3ebb7cda0db51cf473 Author: Zdenek Kabelac <zkabelac(a)redhat.com> AuthorDate: Sat Apr 17 00:21:04 2021 +0200 Committer: Zdenek Kabelac <zkabelac(a)redhat.com> CommitterDate: Mon Apr 19 14:37:08 2021 +0200 man-generator: use \(em Use \(em in command title description and command multidefs. --- tools/command.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tools/command.c b/tools/command.c index 556f22e95..cb261531c 100644 --- a/tools/command.c +++ b/tools/command.c @@ -3538,7 +3538,7 @@ static int _print_man(char *name, char *des_file, int secondary) if (!prev_cmd || strcmp(prev_cmd->name, cmd->name)) { printf(".SH NAME\n"); if (cname && cname->desc) - printf("%s - %s\n", lvmname, cname->desc); + printf("%s \\(em %s\n", lvmname, cname->desc); else printf("%s\n", lvmname); @@ -3600,7 +3600,7 @@ static int _print_man(char *name, char *des_file, int secondary) _print_man_all_positions_desc(cname); } else { if (cname->variants > 2) - printf("-\n"); + printf("\\(em\n"); } printf("\n"); @@ -3647,8 +3647,8 @@ static void _print_man_secondary(char *name) _print_man_usage(lvmname, cmd); - printf("-\n"); - printf("\n"); + printf("\\(em\n"); + printf(".P\n"); } }

3 years

1
0
0 / 0

← Newer
1
2
3
4
5
6
7
8
...
11
Older →

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

lvm2-commits April 2021