From 17823680fcf0fc3dbfd8a1f86db305b17f6da509 Mon Sep 17 00:00:00 2001 From: Alasdair Kergon Date: Fri, 14 Nov 2003 16:17:55 +0000 Subject: [PATCH] Add/update some man pages. --- man/Makefile.in | 11 +++++----- man/lvextend.8 | 11 +++++----- man/lvmdiskscan.8 | 24 +++++++++++++++++++++ man/lvreduce.8 | 5 +++-- man/lvresize.8 | 53 +++++++++++++++++++++++++++++++++++++++++++++++ man/vgexport.8 | 27 ++++++++++++++++++++++++ man/vgimport.8 | 25 ++++++++++++++++++++++ man/vgmknodes.8 | 17 +++++++++++++++ man/vgscan.8 | 7 ++++++- man/vgsplit.8 | 34 ++++++++++++++++++++++++++++++ 10 files changed, 201 insertions(+), 13 deletions(-) create mode 100644 man/lvmdiskscan.8 create mode 100644 man/lvresize.8 create mode 100644 man/vgexport.8 create mode 100644 man/vgimport.8 create mode 100644 man/vgmknodes.8 create mode 100644 man/vgsplit.8 diff --git a/man/Makefile.in b/man/Makefile.in index b1b8b7abf..0d41bfea8 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -22,11 +22,12 @@ VPATH = @srcdir@ MAN5=lvm.conf.5 MAN8=lvchange.8 lvcreate.8 lvdisplay.8 lvextend.8 lvm.8 lvmchange.8 \ - lvreduce.8 lvremove.8 lvrename.8 lvs.8 lvscan.8 pvchange.8 \ - pvcreate.8 pvdisplay.8 pvmove.8 pvremove.8 pvs.8 pvscan.8 \ - vgcfgbackup.8 vgcfgrestore.8 vgchange.8 vgck.8 vgcreate.8 \ - vgconvert.8 vgdisplay.8 vgextend.8 vgmerge.8 vgreduce.8 vgremove.8 \ - vgrename.8 vgs.8 vgscan.8 + lvmdiskscan.8 lvreduce.8 lvremove.8 lvrename.8 lvresize.8 lvs.8 \ + lvscan.8 pvchange.8 pvcreate.8 pvdisplay.8 pvmove.8 pvremove.8 pvs.8 \ + pvscan.8 vgcfgbackup.8 vgcfgrestore.8 vgchange.8 vgck.8 vgcreate.8 \ + vgconvert.8 vgdisplay.8 vgexport.8 vgextend.8 vgimport.8 \ + vgmerge.8 vgmknodes.8 vgreduce.8 vgremove.8 vgrename.8 \ + vgs.8 vgscan.8 vgsplit.8 MAN5DIR=${mandir}/man5 MAN8DIR=${mandir}/man8 diff --git a/man/lvextend.8 b/man/lvextend.8 index f9bb73aa5..58c71cb00 100644 --- a/man/lvextend.8 +++ b/man/lvextend.8 @@ -13,7 +13,7 @@ lvextend \- extend the size of a logical volume lvextend allows you to extend the size of a logical volume. Extension of snapshot logical volumes (see .B lvcreate(8) -for information to create snapshots) is supprted as well. +for information to create snapshots) is supported as well. .SH OPTIONS See \fBlvm\fP for common options. .TP @@ -30,13 +30,13 @@ of the logical volume and without it, the value is taken as an absolute one. .TP .I \-i, \-\-stripes Stripes Gives the number of stripes for the extension. -Not applicable to PVs using the original metadata LVM format. -This is equal to the number of physical volumes to scatter -the logical volume. +Not applicable to LVs using the original metadata LVM format, which must +use a single value throughout. .TP .I \-I, \-\-stripesize StripeSize Gives the number of kilobytes for the granularity of the stripes. -Not applicable to PVs using the original metadata LVM format. +Not applicable to LVs using the original metadata LVM format, which must +use a single value throughout. .br StripeSize must be 2^n (n = 2 to 9) .SH Examples @@ -48,4 +48,5 @@ there are enough free physical extents in it. .BR lvm (8), .BR lvcreate (8), .BR lvreduce (8), +.BR lvresize (8), .BR lvchange (8) diff --git a/man/lvmdiskscan.8 b/man/lvmdiskscan.8 new file mode 100644 index 000000000..f649510d5 --- /dev/null +++ b/man/lvmdiskscan.8 @@ -0,0 +1,24 @@ +.TH LVMDISKSCAN 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvmdiskscan \- scan for all devices visible to LVM2 +.SH SYNOPSIS +.B lvmdiskscan +[\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-l/\-\-lvmpartition] +[\-v/\-\-verbose] +.SH DESCRIPTION +vgscan scans all SCSI, (E)IDE disks, multiple devices and a bunch +of other block devices in the system looking for LVM physical volumes. +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. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-l, \-\-lvmpartition +Only reports Physical Volumes. +.SH SEE ALSO +.BR lvm (8), +.BR lvm.conf (5), +.BR pvscan (8), +.BR vgscan (8) diff --git a/man/lvreduce.8 b/man/lvreduce.8 index c56a87239..8250cdfb5 100644 --- a/man/lvreduce.8 +++ b/man/lvreduce.8 @@ -13,7 +13,7 @@ lvreduce allows you to reduce the size of a logical volume. Be careful when reducing a logical volume's size, because data in the reduced part is lost!!! .br -You should therefore ensure that the (eg) filesystem on the volume is +You should therefore ensure that any filesystem on the volume is resized .i before running lvreduce so that the extents that are to be removed are not in use. @@ -38,7 +38,7 @@ Reduce or set the logical volume size in units of megabyte by default. A size suffix of k for kilobyte, m for megabyte, g for gigabyte or t for terabyte is optional. With the - sign the value will be subtracted from -the logical volume's actual size and without it the will be taken as +the logical volume's actual size and without it it will be taken as an absolute size. .SH Example "lvreduce -l -3 /dev/vg00/lvol1" reduces the size of logical volume lvol1 @@ -47,4 +47,5 @@ in volume group vg00 by 3 logical extents. .BR lvm (8), .BR lvcreate (8), .BR lvextend (8), +.BR lvresize (8), .BR lvchange (8) diff --git a/man/lvresize.8 b/man/lvresize.8 new file mode 100644 index 000000000..6eef558a5 --- /dev/null +++ b/man/lvresize.8 @@ -0,0 +1,53 @@ +.TH LVRESIZE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvresize \- resize a logical volume +.SH SYNOPSIS +.B lvresize +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-i/\-\-stripes Stripes [\-I/\-\-stripesize StripeSize]] +{\-l/\-\-extents [+]LogicalExtentsNumber | +\-L/\-\-size [+]LogicalVolumeSize[kKmMgGtT]} +[\-t/\-\-test] +[\-v/\-\-verbose] LogicalVolumePath [PhysicalVolumePath...] +.SH DESCRIPTION +lvresize allows you to resize a logical volume. +Be careful when reducing a logical volume's size, because data in the reduced +part is lost!!! +You should therefore ensure that any filesystem on the volume is +shrunk first so that the extents that are to be removed are not in use. +Resizing snapshot logical volumes (see +.B lvcreate(8) +for information about creating snapshots) is supported as well. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-l, \-\-extents [+/-]LogicalExtentsNumber +Change or set the logical volume size in units of logical extents. +With the + or - sign the value is added to or subtracted from the actual size +of the logical volume and without it, the value is taken as an absolute one. +.TP +.I \-L, \-\-size [+/-]LogicalVolumeSize[kKmMgGtT] +Change or set the logical volume size in units in units of megabytes. +A size suffix of M for megabytes, G for gigabytes or T for terabytes is +optional. With the + or - sign the value is added to or subtracted from +the actual size of the logical volume and without it, the value is taken as an +absolute one. +.TP +.I \-i, \-\-stripes Stripes +Gives the number of stripes to use when extending a Logical Volume. +Defaults to whatever the last segment of the Logical Volume uses. +Not applicable to LVs using the original metadata LVM format, which must +use a single value throughout. +.TP +.I \-I, \-\-stripesize StripeSize +Gives the number of kilobytes for the granularity of the stripes. +Defaults to whatever the last segment of the Logical Volume uses. +Not applicable to LVs using the original metadata LVM format, which +must use a single value throughout. +.br +StripeSize must be 2^n (n = 2 to 9) +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8), +.BR lvreduce (8), +.BR lvchange (8) diff --git a/man/vgexport.8 b/man/vgexport.8 new file mode 100644 index 000000000..8708bc081 --- /dev/null +++ b/man/vgexport.8 @@ -0,0 +1,27 @@ +.TH VGEXPORT 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgexport \- make volume groups unknown to the system +.SH SYNOPSIS +.B vgexport +[\-a/\-\-all] +[\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-v/\-\-verbose] +VolumeGroupName [VolumeGroupName...] +.SH DESCRIPTION +vgexport allows you to make the inactive +.IR VolumeGroupName (s) +unknown to the system. +You can then move all the Physical Volumes in that Volume Group to +a different system for later +.BR vgimport (8). +Most LVM2 tools ignore exported Volume Groups. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-a, \-\-all +Export all inactive Volume Groups. +.SH SEE ALSO +.BR lvm (8), +.BR pvscan (8), +.BR vgimport (8), +.BR vgscan (8) diff --git a/man/vgimport.8 b/man/vgimport.8 new file mode 100644 index 000000000..40ee97767 --- /dev/null +++ b/man/vgimport.8 @@ -0,0 +1,25 @@ +.TH VGIMPORT 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgimport \- make exported volume groups known to the system +.SH SYNOPSIS +.B vgimport +[\-a/\-\-all] +[\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-v/\-\-verbose] +VolumeGroupName [VolumeGroupName...] +.SH DESCRIPTION +.B vgimport +allows you to make a Volume Group that was previously exported using +.BR vgexport (8) +known to the system again, perhaps after moving its Physical Volumes +from a different machine. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-a, \-\-all +Import all exported Volume Groups. +.SH SEE ALSO +.BR lvm (8), +.BR pvscan (8), +.BR vgexport (8), +.BR vgscan (8) diff --git a/man/vgmknodes.8 b/man/vgmknodes.8 new file mode 100644 index 000000000..2ef53796e --- /dev/null +++ b/man/vgmknodes.8 @@ -0,0 +1,17 @@ +.TH VGMKNODES 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgmknodes \- recreate volume group directory and logical volume special files +.SH SYNOPSIS +.B vgmknodes +[\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-v/\-\-verbose] +[[VolumeGroupName | LogicalVolumePath]...] +.SH DESCRIPTION +Checks the LVM2 special files in /dev that are needed for active +logical volumes and creates any missing ones and removes unused ones. +.SH OPTIONS +See \fBlvm\fP for common options. +.SH SEE ALSO +.BR lvm (8), +.BR vgscan (8), +.BR dmsetup (8) diff --git a/man/vgscan.8 b/man/vgscan.8 index 2f596583e..222e07298 100644 --- a/man/vgscan.8 +++ b/man/vgscan.8 @@ -5,6 +5,7 @@ vgscan \- scan all disks for volume groups and rebuild caches .B vgscan [\-d/\-\-debug] [\-h/\-?/\-\-help] [\-\-ignorelockingfailure] +[\-\-mknodes] [\-P/\-\-partial] [\-v/\-\-verbose] .SH DESCRIPTION @@ -14,9 +15,13 @@ and volume groups. Define a filter in \fBlvm.conf\fP(8) to restrict the scan to avoid a CD ROM, for example. .LP In LVM2, vgscans take place automatically; but you might still need to -run one explicitly after changing hardware or filters. +run one explicitly after changing hardware. .SH OPTIONS See \fBlvm\fP for common options. +.TP +.I \-\-mknodes +Also checks the LVM special files in /dev that are needed for active +logical volumes and creates any missing ones and removes unused ones. .SH SEE ALSO .BR lvm (8), .BR vgcreate (8), diff --git a/man/vgsplit.8 b/man/vgsplit.8 new file mode 100644 index 000000000..2fd090f8b --- /dev/null +++ b/man/vgsplit.8 @@ -0,0 +1,34 @@ +.TH VGMERGE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgsplit \- split a volume group into two +.SH SYNOPSIS +.B vgsplit +[\-A/\-\-autobackup y/n] +[\-d/\-\-debug] +[\-h/\-?/\-\-help] +[\-l/\-\-list] +[\-M/\-\-metadatatype 1/2] +[\-t/\-\-test] +[\-v/\-\-verbose] +ExistingVolumeGroupName NewVolumeGroupName +PhysicalVolumePath [PhysicalVolumePath...] +.SH DESCRIPTION +.B vgsplit +creates +.I NewVolumeGroupName +and moves +.IR PhysicalVolumePath (s) +from +.I ExistingVolumeGroupName +into it. +Logical Volumes cannot be split between Volume Groups. +Each existing Logical Volumes must be entirely on the Physical Volumes forming +either the old or the new Volume Group. +.SH OPTIONS +See \fBlvm\fP for common options. +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR vgextend (8), +.BR vgreduce (8), +.BR vgmerge (8) -- 2.43.5