diff --git a/man/lvchange.8 b/man/lvchange.8 new file mode 100644 index 000000000..0b5fe2c10 --- /dev/null +++ b/man/lvchange.8 @@ -0,0 +1,43 @@ +.TH LVCHANGE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvchange \- change attributes of a logical volume +.SH SYNOPSIS +.B lvchange +[\-A/\-\-autobackup y/n] [\-a/\-\-available y/n] +[\-C/\-\-contiguous y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-p/\-\-permission r/w] [\-r/\-\-readahead ReadAheadSectors] +[\-v/\-\-verbose] LogicalVolumePath [LogicalVolumePath...] +.SH DESCRIPTION +lvchange allows you to change the attributes of a logical volume. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.TP +.I \-a, \-\-available y/n +Controls the availability of the logical volumes for use. +This is (among others) useful for changing the logical volume's name +( see +.B lvrename(8) +) safely. +.TP +.I \-C, \-\-contiguous y/n +Tries to set or resets the contiguous allocation policy for +logical volumes. It's only possible to change a non-contiguous +logical volume's allocation policy to contiguous, if all of the +allocated physical extents are already contiguous. +.TP +.I \-p, \-\-permission r/w +Change access permission to read-only or read/write. +.TP +.I \-r, \-\-readahead ReadAheadSectors +Change read ahead sector count per logical between 2 and 120. +.SH Examples +"lvchange -x n /dev/vg00/lvol1" prevents the allocation of any physical +extents on logical volume lvol1 in volume group vg00. +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8) diff --git a/man/lvcreate.8 b/man/lvcreate.8 new file mode 100644 index 000000000..da16d1702 --- /dev/null +++ b/man/lvcreate.8 @@ -0,0 +1,135 @@ +.TH LVCREATE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvcreate \- create a logical volume in an existing volume group +.SH SYNOPSIS +.B lvcreate +[\-A/\-\-autobackup y/n] [\-C/\-\-contiguous y/n] [\-d/\-\-debug] +[\-h/\-?/\-\-help] +[\-i/\-\-stripes Stripes [\-I/\-\-stripesize StripeSize]] +{\-l/\-\-extents LogicalExtentsNumber | + \-L/\-\-size LogicalVolumeSize[kKmMgGtT]} +[\-n/\-\-name LogicalVolumeName] +[\-p/\-\-permission r/rw] [\-r/\-\-readahead ReadAheadSectors] +[\-v/\-\-verbose] [\-Z/\-\-zero y/n] +VolumeGroupName [PhysicalVolumePath...] +.br + +.br +.B lvcreate +{\-l/\-\-extents LogicalExtentsNumber | + \-L/\-\-size LogicalVolumeSize[kKmMgGtT]} +[\-c/\-\-chunksize ChunkSize] +\-s/\-\-snapshot \-n/\-\-name SnapshotLogicalVolumeName OriginalLogicalVolumePath +.SH DESCRIPTION +lvcreate creates a new logical volume in a volume group ( see +.B vgcreate(8), vgchange(8) +) by allocating logical extents from the free physical extent pool +of that volume group. If there are not enough free physical extents then +the volume group can be extended ( see +.B vgextend(8) +) with other physical volumes or by reducing existing logical volumes +of this volume group in size ( see +.B lvreduce(8), e2fsadm(8) +). +.br +The second form supports the creation of snapshot logical volumes which +keep the contents of the original logical volume for backup purposes. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). +.br +Default is yes. +.TP +.I \-c, \-\-chunksize ChunkSize +Power of 2 chunk size for the snapshot logical volume between 4k and 1024k. +.TP +.I \-C, \-\-contiguous y/n +Sets or resets the contiguous allocation policy for +logical volumes. Default is no contiguous allocation based +on a next free principle. +.TP +.I \-i, \-\-stripes Stripes +Gives the number of stripes. +This is equal to the number of physical volumes to scatter +the logical volume. +.TP +.I \-I, \-\-stripesize StripeSize +Gives the number of kilobytes for the granularity of the stripes. +.br +StripeSize must be 2^n (n = 2 to 9) +.TP +.I \-l, \-\-extents LogicalExtentsNumber +Gives the number of logical extents to allocate for the new +logical volume. +.TP +.I \-L, \-\-size LogicalVolumeSize[kKmMgGtT] +Gives the size to allocate for the new logical volume. +A size suffix of K for kilobytes, M for megabytes, +G for gigabytes or T for terabytes is optional. +.br +Default unit is megabytes. +.TP +.I \-n, \-\-name LogicalVolumeName +The name for the new logical volume. +.br +Without this option a default names of "lvol#" will be generated where +# is the LVM internal number of the logical volume. +.TP +.I \-p, \-\-permission r/w +Set access permissions to read only or read and write. +.br +Default is read and write. +.TP +.I \-r, \-\-readahead ReadAheadSectors +Set read ahead sector count of this logical volume to a value between 2 and 120. +.TP +.I \-s, \-\-snapshot +Create a snapshot logical volume (or snapshot) for an existing, so called +original logical volume (or origin). +Snapshots provide a 'frozen image' of the contents of the origin +while the origin can still be updated. They enable consistent +backups and online recovery of removed/overwritten data/files. The snapshot +does not need the same amount of storage the origin has. In a typical scenario, +15-20% might be enough. In case the snapshot runs out of storage, use +.B lvextend(8) +to grow it. Shrinking a snapshot is supported by +.B lvreduce(8) +as well. Run +.B lvdisplay(8) +on the snapshot in order to check how much data is allocated to it. +.TP +.I \-Z, \-\-zero y/n +Controls zeroing of the first KB of data in the new logical volume. +.br +Default is yes. + +.br +Warning: trying to mount an unzeroed logical volume can cause the system to +hang. +.SH Examples +"lvcreate -i 3 -I 8 -L 100 vg00" tries to create a striped logical +volume with 3 stripes, a stripesize of 8KB and a size of 100MB in the volume +group named vg00. The logical volume name will be chosen by lvcreate. + +"lvcreate --size 100m --snapshot --name snap /dev/vg00/lvol1" +.br +creates a snapshot logical volume named /dev/vg00/snap which has access to the +contents of the original logical volume named /dev/vg00/lvol1 +at snapshot logical volume creation time. If the original logical volume +contains a file system, you can mount the snapshot logical volume on an +arbitrary directory in order to access the contents of the filesystem to run +a backup while the original filesystem is updated. + +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR lvremove (8), +.BR lvrename (8) +.BR lvextend (8), +.BR lvreduce (8), +.BR lvdisplay (8), +.BR lvscan (8) diff --git a/man/lvdisplay.8 b/man/lvdisplay.8 new file mode 100644 index 000000000..0a9f68af8 --- /dev/null +++ b/man/lvdisplay.8 @@ -0,0 +1,58 @@ +.TH LVDISPLAY 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvdisplay \- display attributes of a logical volume +.SH SYNOPSIS +.B lvdisplay +[\-c/\-\-colon] [\-d/\-\-debug] [\-D/\-\-disk] [\-h/\-?/\-\-help] +[\-v[v]/\-\-verbose] LogicalVolumePath [LogicalVolumePath...] +.SH DESCRIPTION +lvdisplay allows you to see the attributes of a logical volume +like size, read/write status, snapshot information etc. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-c, \-\-colon +Generate colon seperated output for easier parsing in scripts or programs. +.nf + +The values are: + +* logical volume name +* volume group name +* logical volume access +* logical volume status +* internal logical volume number +* open count of logical volume +* logical volume size in kilobytes +* current logical extents associated to logical volume +* allocated logical extents of logical volume +* allocation policy of logical volume +* read ahead sectors of logical volume +* major device number of logical volume +* minor device number of logical volume + +.fi +.TP +.I \-D, \-\-disk +Show attributes of the volume group descriptor array on disk(s). +Without this switch they are derived from kernel space. +Useful, if the volume group isn't active. +.TP +.I \-m, \-\-maps +Display the mapping of logical extents to physical volumes and +physical extents. +.SH Examples +"lvdisplay -v /dev/vg00/lvol2" shows attributes of that logical volume +and its mapping of logical to physical extents. In case snapshot +logical volumes have been created for this original logical volume, +this command shows a list of all snapshot logical volumes and their +status (active or inactive) as well. + +"lvdisplay /dev/vg00/snapshot" shows the attributes of this snapshot +logical volume and also which original logical volume +it is associated with. + +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8), +.BR lvscan (8) diff --git a/man/lvextend.8 b/man/lvextend.8 new file mode 100644 index 000000000..98c379be4 --- /dev/null +++ b/man/lvextend.8 @@ -0,0 +1,42 @@ +.TH LVEXTEND 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvextend \- extend the size of a logical volume +.SH SYNOPSIS +.B lvextend +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] +{\-l/\-\-extents [+]LogicalExtentsNumber | +\-L/\-\-size [+]LogicalVolumeSize[kKmMgGtT]} +[\-v/\-\-verbose] LogicalVolumePath [PhysicalVolumePath...] +.SH DESCRIPTION +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. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.TP +.I \-l, \-\-extents [+]LogicalExtentsNumber +Extend or set the logical volume size in units of logical extents. +With the + sign the value is added to the actual size +of the logical volume and without it, the value is taken as an absolute one. +.TP +.I \-L, \-\-size [+]LogicalVolumeSize[kKmMgGtT] +Extend 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 + sign the value is added to the actual size +of the logical volume and without it, the value is taken as an absolute one. +.SH Examples +"lvextend -L +54 /dev/vg01/lvol10 /dev/sdk3" tries to extend the size of +that logical volume by 54MB on physical volume /dev/sdk3. +This is only possible if /dev/sdk3 is a member of volume group vg01 and +there are enough free physical extents in it. +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8), +.BR lvreduce (8), +.BR lvchange (8) diff --git a/man/lvm.8 b/man/lvm.8 index 2c3079f1b..055b73a1f 100644 --- a/man/lvm.8 +++ b/man/lvm.8 @@ -25,6 +25,26 @@ A file containing a simple script with one command per line can also be given on the command line. The script can also be executed directly if the first line is #! followed by the absolute path of \fBlvm\fP. +.SH OPTIONS +The following options can be used with every command and are not documented +on individual manual pages. +.TP +\fB-h | --help\fP \(em Display the help text. +.TP +\fB--version\fP \(em Display the version. +Not implemented yet. +.TP +\fB-v | --verbose\fP \(em Set verbose level. +Repeat from 1 to 3 times to determine the detail of messages +sent to stdout and stderr. Overrides config file setting. +.TP +\fB-d | --debug\fP \(em Set debug level. +Repeat from 1 to 6 times to determine the detail of messages sent +to the log file and/or syslog (if configured). +Overrides config file setting. +.TP +\fB--quiet\fP \(em Suppress output and log messages. +Overrides -d and -v. .SH ENVIRONMENT VARIABLES .TP \fBLVM_SYSTEM_DIR\fP @@ -45,37 +65,38 @@ Defaults to "yes". The volume group name that is assumed for any reference to a logical volume that doesn't specify a path. Not set by default. +.SH DIAGNOSTICS +All tools return a status code of zero on success or non-zero on failure. .SH FILES .I /etc/lvm/lvm.conf .br .I $HOME/.lvm_history -.fi .SH SEE ALSO -.BR lvchange (1), -.BR lvcreate (1), -.BR lvdisplay (1), -.BR lvextend (1), -.BR lvmchange (1), -.BR lvreduce (1), -.BR lvremove (1), -.BR lvrename (1), -.BR lvresize (1), -.BR lvscan (1), -.BR pvchange (1), -.BR pvcreate (1), -.BR pvdisplay (1), -.BR pvscan (1), -.BR vgcfgbackup (1), -.BR vgchange (1), -.BR vgck (1), -.BR vgcreate (1), -.BR vgdisplay (1), -.BR vgextend (1), -.BR vgmerge (1), -.BR vgreduce (1), -.BR vgremove (1), -.BR vgrename (1), -.BR vgscan (1), +.BR lvchange (8), +.BR lvcreate (8), +.BR lvdisplay (8), +.BR lvextend (8), +.BR lvmchange (8), +.BR lvreduce (8), +.BR lvremove (8), +.BR lvrename (8), +.BR lvresize (8), +.BR lvscan (8), +.BR pvchange (8), +.BR pvcreate (8), +.BR pvdisplay (8), +.BR pvscan (8), +.BR vgcfgbackup (8), +.BR vgchange (8), +.BR vgck (8), +.BR vgcreate (8), +.BR vgdisplay (8), +.BR vgextend (8), +.BR vgmerge (8), +.BR vgreduce (8), +.BR vgremove (8), +.BR vgrename (8), +.BR vgscan (8), .BR readline (3), .BR lvm.conf (5) diff --git a/man/lvm.conf.5 b/man/lvm.conf.5 index 12ac38a3a..6bd2726ba 100644 --- a/man/lvm.conf.5 +++ b/man/lvm.conf.5 @@ -130,6 +130,5 @@ metadata. Default is 1 (automatic backups enabled). Set to 0 to disable. .I /etc/lvm/lvm.conf .br .I $HOME/.lvm_history -.fi .SH SEE ALSO -.BR lvm(8) +.BR lvm (8) diff --git a/man/lvmchange.8 b/man/lvmchange.8 new file mode 100644 index 000000000..3bc3a72ad --- /dev/null +++ b/man/lvmchange.8 @@ -0,0 +1,9 @@ +.TH LVMCHANGE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvmchange \- change attributes of the logical volume manager +.SH SYNOPSIS +.B lvmchange +.SH DESCRIPTION +lvmchange is not currently supported under LVM2 +.SH SEE ALSO +.BR dmsetup (8) diff --git a/man/lvreduce.8 b/man/lvreduce.8 new file mode 100644 index 000000000..cc288f377 --- /dev/null +++ b/man/lvreduce.8 @@ -0,0 +1,57 @@ +.TH LVREDUCE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvreduce \- reduce the size of a logical volume +.SH SYNOPSIS +.B lvreduce +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-f/\-\-force] +[\-h/\-?/\-\-help] {\-l/\-\-extents [\-]LogicalExtentsNumber | +\-L/\-\-size [\-]LogicalVolumeSize[kKmMgGtT]} +[\-v/\-\-verbose] LogicalVolumePath +.SH DESCRIPTION +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 +resized +.i before +running lvreduce so that the extents that are to be removed are not in use. +If the filesystem is ext2 then you can use the +.B e2fsadm(8) +command to both resize the filesystem and the logical volume together. +.br. +Shrinking snapshot logical volumes (see +.B lvcreate(8) +for information to create snapshots) is supported as well. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.TP +.I \-f, \-\-force +Force size reduction without any question. +.TP +.I \-l, \-\-extents [\-]LogicalExtentsNumber +Reduce or set the logical volume size in units of logical extents. +With the - sign the value will be subtracted from +the logical volume's actual size and without it the will be taken as +an absolute size. +.TP +.I \-L, \-\-size [\-]LogicalVolumeSize[kKmMgGtT] +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 +an absolute size. +.SH Example +"lvreduce -l -3 /dev/vg00/lvol1" reduces the size of logical volume lvol1 +in volume group vg00 by 3 logical extents. +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8), +.BR lvextend (8), +.BR lvchange (8) diff --git a/man/lvremove.8 b/man/lvremove.8 new file mode 100644 index 000000000..9e89c92b4 --- /dev/null +++ b/man/lvremove.8 @@ -0,0 +1,27 @@ +.TH LVREMOVE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvremove \- remove a logical volume +.SH SYNOPSIS +.B lvremove +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-f/\-\-force] +[\-h/\-?/\-\-help] [\-v/\-\-verbose] LogicalVolumePath [LogicalVolumePath...] +.SH DESCRIPTION +lvremove allows you to remove one or more inactive logical volumes. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.TP +.I \-f, \-\-force +Force remove without confirmation. +.SH Example +"lvremove -f /dev/vg00/lvol1" removes that inactive logical volume +unconditionally. +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8), +.BR lvdisplay (8), +.BR lvscan (8) diff --git a/man/lvrename.8 b/man/lvrename.8 new file mode 100644 index 000000000..470414132 --- /dev/null +++ b/man/lvrename.8 @@ -0,0 +1,50 @@ +.TH LVRENAME 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvrename \- rename a logical volume +.SH SYNOPSIS +.B lvrename +.RB [ \-A | \-\-autobackup " {" y | n }] +.RB [ \-d | \-\-debug ] +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-verbose ] +.RB [ \-\-version ] +.TP +.IR "OldLogicalVolumePath NewLogicalVolume" { Path | Name } +.TP +.I VolumeGroupName OldLogicalVolumeName NewLogicalVolumeName +.SH DESCRIPTION +.B lvrename +renames an existing logical volume from +.IR OldLogicalVolume { Name | Path } +to +.IR NewLogicalVolume { Name | Path }. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-A ", " \-\-autobackup " {" y | n } +Controls automatic backup of VG metadata after the change (see +.BR vgcfgbackup (8)). +Default is yes. +.SH EXAMPLE +To rename +.B lvold +in volume group +.B vg02 +to +.BR lvnew : +.nf + +\ lvrename /dev/vg02/lvold /dev/vg02/lvnew + +.fi +An alternate syntax to rename this logical volume is +.nf + +\ lvrename vg02 lvold lvnew + +.fi +.SH SEE ALSO +.BR lvm (8), +.BR lvchange (8), +.BR vgcreate (8), +.BR vgrename (8) diff --git a/man/lvscan.8 b/man/lvscan.8 new file mode 100644 index 000000000..39859551b --- /dev/null +++ b/man/lvscan.8 @@ -0,0 +1,28 @@ +.TH LVSCAN 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +lvscan \- scan (all disks) for logical volumes +.SH SYNOPSIS +.B lvscan +.RB [ \-b | \-\-blockdevice ] +.RB [ \-d | \-\-debug ] +.RB [ \-D | \-\-disk ] +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-verbose ] +.SH DESCRIPTION +.B lvscan +scans all known volume groups or all supported LVM block devices +in the system for defined logical volumes. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-b ", " \-\-blockdevice +Adds the device major and minor numbers to the display +of each logical volume. +.TP +.BR \-D ", " \-\-disk +Scan for logical volumes on disk(s) instead of getting the information +from the kernel. +.SH SEE ALSO +.BR lvm (8), +.BR lvcreate (8), +.BR lvdisplay (8) diff --git a/man/pvchange.8 b/man/pvchange.8 new file mode 100644 index 000000000..3bf4061a0 --- /dev/null +++ b/man/pvchange.8 @@ -0,0 +1,31 @@ +.TH PVCHANGE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +pvchange \- change attributes of a physical volume +.SH SYNOPSIS +.B pvchange +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-v/\-\-verbose] [\-a/\-\-all] [\-x/\-\-allocation y/n] [PhysicalVolumePath...] +.SH DESCRIPTION +pvchange allows you to change the allocation permissions of one or +more physical volumes. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.TP +.I \-a, \-\-all +If PhysicalVolumePath is not specified on the command line all +physical volumes are searched for and used. +.TP +.I \-x, \-\-allocation y/n +Enable or disable allocation of physical extents on this physical volume. +.SH Example +"pvchange -x n /dev/sdk1" disallows the allocation of physical extents +on this physical volume (possibly because of disk errors, or because it will +be removed after freeing it. +.SH SEE ALSO +.BR lvm (8), +.BR pvcreate (8) diff --git a/man/pvcreate.8 b/man/pvcreate.8 new file mode 100644 index 000000000..0078e09fd --- /dev/null +++ b/man/pvcreate.8 @@ -0,0 +1,57 @@ +.TH PVCREATE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +pvcreate \- initialize a disk or partition for use by LVM +.SH SYNOPSIS +.B pvcreate +.RB [ \-d | \-\-debug ] +.RB [ \-f [ f ]| \-\-force " [" \-\-force ]] +.RB [ \-y | \-\-yes ] +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-verbose ] +.RB [ \-V | \-\-version ] +.IR PhysicalVolume " [" PhysicalVolume ...] +.SH DESCRIPTION +.B pvcreate +initializes +.I PhysicalVolume +for later use by the Logical Volume Manager (LVM). Each +.I PhysicalVolume +can be a disk partition, whole disk, meta device, or loopback file. +For DOS disk partitions, the partition id must be set to 0x8e using +.BR fdisk "(8), " cfdisk "(8), " +or a equivalent. For +.B whole disk devices only +the partition table must be erased, which will effectively destroy all +data on that disk. This can be done by zeroing the first sector with: +.sp +.BI "dd if=/dev/zero of=" PhysicalVolume " bs=512 count=1" +.sp +Continue with +.BR vgcreate (8) +to create a new volume group on +.IR PhysicalVolume , +or +.BR vgextend (8) +to add +.I PhysicalVolume +to an existing volume group. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-f ", " \-\-force +Force the creation without any confirmation. You can not recreate +(reinitialize) a physical volume belonging to an existing volume group. +In an emergency you can override this behaviour with -ff. In no case +case can you initialize an active physical volume with this command. +.TP +.BR \-y ", " \-\-yes +Answer yes to all questions. +.SH Example +Initialize partition #4 on the third SCSI disk and the entire fifth +SCSI disk for later use by LVM: +.sp +.B pvcreate /dev/sdc4 /dev/sde +.sp +.SH SEE ALSO +.BR lvm "(8), " vgcreate "(8), " vgextend "(8), " lvcreate "(8), " +.BR cfdisk "(8), " fdisk "(8), " losetup "(8), " mdadd "(8)" diff --git a/man/pvdisplay.8 b/man/pvdisplay.8 new file mode 100644 index 000000000..840a4f9aa --- /dev/null +++ b/man/pvdisplay.8 @@ -0,0 +1,46 @@ +.TH PVDISPLAY 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +pvdisplay \- display attributes of a physical volume +.SH SYNOPSIS +.B pvdisplay +[\-c/\-\-colon] [\-d/\-\-debug] [\-h/\-?/\-\-help] [\-s/\-\-short] +[\-v[v]/\-\-verbose [\-\-verbose]] +PhysicalVolumePath [PhysicalVolumePath...] +.SH DESCRIPTION +pvdisplay allows you to see the attributes of one or more physical volumes +like size, physical extent size, space used for the volume group descriptor +area and so on. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-c, \-\-colon +Generate colon seperated output for easier parsing in scripts or programs. +.nf + +The values are: + +* physical volume device name +* volume group name +* physical volume size in kilobytes +* internal physical volume number +* physical volume status +* physical volume (not) allocatable +* current number of logical volumes on this physical volume +* physical extent size in kilobytes +* total number of physical extents +* free number of physical extents +* allocated number of physical extents + +.fi +.TP +.I \-s, \-\-short +Only display the size of the given physical volumes. +.TP +.I \-m, \-\-maps +Display the mapping of physical extents to logical volumes and +logical extents. +.SH SEE ALSO +.BR lvm (8), +.BR pvcreate (8), +.BR lvcreate (8), +.BR vgcreate (8) diff --git a/man/pvscan.8 b/man/pvscan.8 new file mode 100644 index 000000000..747368572 --- /dev/null +++ b/man/pvscan.8 @@ -0,0 +1,33 @@ +.TH PVSCAN 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +pvscan \- scan all disks for physical volumes +.SH SYNOPSIS +.B pvscan +.RB [ \-d | \-\-debug] +.RB [\-e | \-\-exported] +.RB [\-h | \-\-help] +.RB [ \-n | \-\-novolumegroup] +.RB [\-s | \-\-short] +.RB [\-u | \-\-uuid] +.RB [ \-v [ v ]| \-\-verbose " [" \-\-verbose ]] +.SH DESCRIPTION +.B pvscan +scans all supported LVM block devices in the system for physical volumes. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-e ", " \-\-exported +Only show physical volumes belonging to exported volume groups. +.TP +.BR \-n ", " \-\-novolumegroup +Only show physical volumes not belonging to any volume group. +.TP +.BR \-s ", " \-\-short +Short listing format. +.TP +.BR \-u ", " \-\-uuid +Show UUIDs (Unifrom Unique Identifiers) in addition to device special names. +.SH SEE ALSO +.BR lvm (8), +.BR pvcreate (8), +.BR pvdisplay (8) diff --git a/man/vgcfgbackup.8 b/man/vgcfgbackup.8 new file mode 100644 index 000000000..f6b340fe4 --- /dev/null +++ b/man/vgcfgbackup.8 @@ -0,0 +1,22 @@ +.TH VGCFGBACKUP 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgcfgbackup \- backup volume group descriptor area +.SH SYNOPSIS +.B vgcfgbackup +.RB [ \-d | \-\-debug ] +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-verbose ] +.RI [ VolumeGroupName ...] +.SH DESCRIPTION +.B vgcfgbackup +allows you to backup the metadata +of one to all volume groups to files in +.IR /etc/lvm . +If you don't give any volume groups in the command line, all of them +will be backed up. This DOESN'T backup user/system data in logical +volume(s)! +.SH OPTIONS +See \fBlvm\fP for common options. +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8) diff --git a/man/vgchange.8 b/man/vgchange.8 new file mode 100644 index 000000000..3081ace10 --- /dev/null +++ b/man/vgchange.8 @@ -0,0 +1,65 @@ +.TH VGCHANGE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgchange \- change attributes of a volume group +.SH SYNOPSIS +.B vgchange +.RB [ \-A | \-\-autobackup " {" y | n }] +.RB [\-a | \-\-available " {" y | n }] +.RB [\-d | \-\-debug] +.RB [ \-h | \-\-help] +.RB [\-l | \-\-logicalvolume +.IR MaxLogicalVolumes ] +.RB [ \-v | \-\-verbose ] +.RB [ \-\-version ] +.RB [\-x | \-\-allocation " {" y | n }] +.RI [ VolumeGroupName ...] +.SH DESCRIPTION +.B vgchange +allows you to change the attributes of one or more volume groups. +Its main purpose is to activate and deactivate +.IR VolumeGroupName , +or all volume groups if none is specified. Only active volume groups +are subject to changes and allow access to their logical volumes. +During volume group activation, if +.B vgchange +recognizes snapshot logical volumes which were dropped because they ran +out of space, it displays a message informing the administrator that such +snapshots should be removed (see +.BR lvremove (8)). +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-A ", " \-\-autobackup { y | n } +Controls automatic backup of metadata after the change. See +.B vgcfgbackup (8). +Default is yes. +.TP +.BR \-a ", " \-\-available { y | n } +Controls the availability of the volume group for input/output. +In other words: makes a volume group known/unknown to the kernel. +.TP +.BR \-l ", " \-\-logicalvolume " " \fIMaxLogicalVolumes\fR +Changes the maximum logical volume number of an existing inactive +volume group. +.TP +.BR \-x ", " \-\-allocation { y | n } +Enables or disables the extension/reduction of this volume group +with/by physical volumes. +.SH EXAMPLES +To activate all known volume groups in the system: +.nf + +\ vgchange -a y + +.fi +To change the maximum number of logical volumes of inactive volume group +.B vg00 +to 128. +.nf + +\ vgchange -l 128 /dev/vg00 + +.fi +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8) diff --git a/man/vgck.8 b/man/vgck.8 new file mode 100644 index 000000000..b5f388f07 --- /dev/null +++ b/man/vgck.8 @@ -0,0 +1,15 @@ +.TH VGCK 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgck \- check volume group metadata +.SH SYNOPSIS +.B vgck +[\-d/\-\-debug] [\-h/\-?/\-\-help] [\-v/\-\-verbose] [VolumeGroupName...] +.SH DESCRIPTION +vgck checks LVM metadata for each named volume group for consistency. +.SH OPTIONS +See \fBlvm\fP for common options. +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR vgchange (8), +.BR vgscan (8) diff --git a/man/vgcreate.8 b/man/vgcreate.8 new file mode 100644 index 000000000..01241ea7f --- /dev/null +++ b/man/vgcreate.8 @@ -0,0 +1,79 @@ +.TH VGCREATE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgcreate \- create a volume group +.SH SYNOPSIS +.B vgcreate +.RB [ \-A | \-\-autobackup " {" y | n }] +.RB [ \-d | \-\-debug ] +.RB [ \-h | \-\-help ] +.RB [ \-l | \-\-maxlogicalvolumes +.IR MaxLogicalVolumes ] +.RB [ -p | \-\-maxphysicalvolumes +.IR MaxPhysicalVolumes ] +.RB [ \-s | \-\-physicalextentsize +.IR PhysicalExtentSize [ \fBkKmMgGtT\fR ]] +.RB [ \-v | \-\-verbose ] +.RB [ \-\-version ] +.I VolumeGroupName PhysicalVolumePath +.RI [ PhysicalVolumePath ...] +.SH DESCRIPTION +.B vgcreate +creates a new volume group called +.I VolumeGroupName +using the block special device +.IR PhysicalVolumePath +previously configured for LVM with +.BR pvcreate (8). +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-A ", " \-\-autobackup " {" y | n } +Controls automatic backup of VG metadata after the change (see +.BR vgcfgbackup (8)). +Default is yes. +.TP +.BR \-l ", " \-\-maxlogicalvolumes " " \fIMaxLogicalVolumes\fR +Sets the maximum possible logical volume count. +More logical volumes can't be created in this volume group. +Absolute maximum is 256. +.TP +.BR \-p ", " \-\-maxphysicalvolumes " " \fIMaxPhysicalVolumes\fR +Sets the maximum possible physical volume count. +More physical volumes can't be included in this volume group. +Absolute maximum is 256. +.TP +.BR \-s ", " \-\-physicalextentsize " " \fIPhysicalExtentSize\fR[\fBkKmMgGtT\fR] +Sets the physical extent size on physical volumes of this volume group. +A size suffix (k for kilobytes up to t for terabytes) is optional, megabytes +is the default if no suffix is present. Values can be from 8 KB to 16 GB in +powers of 2. The default of 4 MB causes maximum LV sizes of ~256GB because as +many as ~64k extents are supported per LV. In case larger maximum LV sizes are +needed (later), you need to set the PE size to a larger value as well. Later +changes of the PE size in an existing VG are not supported. +.SH EXAMPLES +To create a volume group named +.B test_vg +using physical volumes +.BR /dev/hdk1 ", " /dev/hdl1 ", and " /dev/hdm1 +with default physical extent size of 4MB: +.nf + +\ vgcreate test_vg /dev/sd[k-m]1 + +.fi +To limit kernel memory usage, there is a limit of 65536 physical extents +(PE) per logical volume, so the PE size determines the maximum logical volume +size. The default PE size of 4MB limits a single logical volume to 256GB (see +the -s option to raise that limit). +There is also (as of Linux 2.4) a kernel limitation of 2TB per block device. +.SH SEE ALSO +.BR lvm (8), +.BR pvdisplay (8), +.BR pvcreate (8), +.BR vgdisplay (8), +.BR vgextend (8), +.BR vgreduce (8), +.BR lvcreate (8), +.BR lvdisplay (8), +.BR lvextend (8), +.BR lvreduce (8) diff --git a/man/vgdisplay.8 b/man/vgdisplay.8 new file mode 100644 index 000000000..a4849408f --- /dev/null +++ b/man/vgdisplay.8 @@ -0,0 +1,72 @@ +.TH VGDISPLAY 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgdisplay \- display attributes of volume groups +.SH SYNOPSIS +.B vgdisplay +.RB [ \-A | \-\-activevolumegroups ] +.RB [ \-c | \-\-colon ] +.RB [ \-d | \-\-debug ] +.RB [ \-D | \-\-disk ] +.RB [ \-h | \-\-help ] +.RB [ \-s | \-\-short ] +.RB [ \-v [ v ]| \-\-verbose " [" \-\-verbose ]] +.RB [ \-\-version ] +.RI [ VolumeGroupName ...] +.SH DESCRIPTION +.B vgdisplay +allows you to see the attributes of +.I VolumeGroupName +(or all volume groups if none is given) with it's physical and logical +volumes and their sizes etc. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.BR \-A ", " \-\-activevolumegroups +Only select the active volume groups. +.TP +.BR \-c ", " \-\-colon +Generate colon seperated output for easier parsing in scripts or programs. +.nf + +The values are: + +1 volume group name +2 volume group access +3 volume group status +4 internal volume group number +5 maximum number of logical volumes +6 current number of logical volumes +7 open count of all logical volumes in this volume group +8 maximum logical volume size +9 maximum number of physical volumes +10 current number of physical volumes +11 actual number of physical volumes +12 size of volume group in kilobytes +13 physical extent size +14 total number of physical extents for this volume group +15 allocated number of physical extents for this volume group +16 free number of physical extents for this volume group +17 uuid of volume group + +.fi +.TP +.BR \-D ", " \-\-disk +Show attributes from the volume group descriptor area on disk(s). +Without this switch they are shown from the kernel. +Useful if the volume group isn't activated. +.TP +.BR \-s ", " \-\-short +Give a short listing showing the existence of volume groups. +.TP +.BR \-v ", " \-\-verbose +Display verbose information containing long listings of physical +and logical volumes. If given twice, also display verbose runtime +information of vgdisplay's activities. +.TP +.BR \-\-version +Display version and exit successfully. +.SH SEE ALSO +.BR lvm (8), +.BR pvcreate (8), +.BR vgcreate (8), +.BR lvcreate (8) diff --git a/man/vgextend.8 b/man/vgextend.8 new file mode 100644 index 000000000..cd81503ce --- /dev/null +++ b/man/vgextend.8 @@ -0,0 +1,28 @@ +.TH VGEXTEND 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgextend \- add physical volumes to a volume group +.SH SYNOPSIS +.B vgextend +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] [\-v/\-\-verbose] +VolumeGroupName PhysicalDevicePath [PhysicalDevicePath...] +.SH DESCRIPTION +vgextend allows you to add one or more initialized physical volumes ( see +.B pvcreate(8) +) to an existing volume group to extend it in size. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.SH Examples +"vgextend vg00 /dev/sda4 /dev/sdn1" tries to extend the existing volume +group "vg00" by the new physical volumes (see +.B pvcreate(8) +) "/dev/sdn1" and /dev/sda4". +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR vgreduce (8), +.BR pvcreate (8) diff --git a/man/vgmerge.8 b/man/vgmerge.8 new file mode 100644 index 000000000..12c27934b --- /dev/null +++ b/man/vgmerge.8 @@ -0,0 +1,34 @@ +.TH VGMERGE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgmerge \- merge two volume groups +.SH SYNOPSIS +.B vgmerge +[\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] [\-l/\-\-list] +[\-t/\-\-test] [\-v/\-\-verbose] DestinationVolumeGroupName +SourceVolumeGroupName +.SH DESCRIPTION +vgmerge merges two existing volume groups. The inactive SourceVolumeGroupName +will be merged into the DestinationVolumeGroupName if physical extent sizes +are equal and physical and logical volume summaries of both volume groups +fit into DestinationVolumeGroupName's limits. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the merge ( see +.B vgcfgbackup(8) +). Default is yes. +.I \-l, \-\-list +Display merged DestinationVolumeGroupName like "vgdisplay -v". +.TP +.I \-t, \-\-test +Do a test run WITHOUT making any real changes. +.SH Examples +"vgmerge -v databases my_vg" merges the inactive volume group named "my_vg" +into the active or inactive volume group named "databases" giving verbose +runtime information. +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR vgextend (8), +.BR vgreduce (8) diff --git a/man/vgreduce.8 b/man/vgreduce.8 new file mode 100644 index 000000000..d81ea9885 --- /dev/null +++ b/man/vgreduce.8 @@ -0,0 +1,24 @@ +.TH VGREDUCE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgreduce \- reduce a volume group +.SH SYNOPSIS +.B vgreduce +[\-a/\-\-all] [\-A/\-\-autobackup y/n] [\-d/\-\-debug] [\-h/\-?/\-\-help] +[\-v/\-\-verbose] VolumeGroupName +[PhysicalVolumePath...] +.SH DESCRIPTION +vgreduce allows you to remove one or more unused physical volumes +from a volume group. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-a, \-\-all +Removes all empty physical volumes if none are given on command line. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.SH SEE ALSO +.BR lvm (8), +.BR vgextend (8) diff --git a/man/vgremove.8 b/man/vgremove.8 new file mode 100644 index 000000000..7a193102d --- /dev/null +++ b/man/vgremove.8 @@ -0,0 +1,19 @@ +.TH VGREMOVE 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgremove \- remove a volume group +.SH SYNOPSIS +.B vgremove +[\-d/\-\-debug] [\-h/\-?/\-\-help] [\-v/\-\-verbose] +VolumeGroupName [VolumeGroupName...] +.SH DESCRIPTION +vgremove allows you to remove one or more volume groups. +The volume group(s) must not have any logical volumes allocated +and must also be inactive (see +.B vgchange(8) +). +.SH OPTIONS +See \fBlvm\fP for common options. +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR vgreduce (8) diff --git a/man/vgrename.8 b/man/vgrename.8 new file mode 100644 index 000000000..328703040 --- /dev/null +++ b/man/vgrename.8 @@ -0,0 +1,31 @@ +.TH VGRENAME 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgrename \- rename a volume group +.SH SYNOPSIS +.B vgrename +[\-A/\-\-autobackup y/n] +[\-d/\-\-debug] +[\-h/\-?/\-\-help] +[\-v/\-\-verbose] +OldVolumeGroupPath/\-Name NewVolumeGroupPath/\-Name +.SH DESCRIPTION +vgrename renames an existing (see +.B vgcreate(8) +) volume group. +.SH OPTIONS +See \fBlvm\fP for common options. +.TP +.I \-A, \-\-autobackup y/n +Controls automatic backup of VG metadata after the change ( see +.B vgcfgbackup(8) +). Default is yes. +.SH Examples +"vgrename /dev/vg02 /dev/my_volume_group" renames existing +volume group "vg02" to "my_volume_group". +.TP +"vgrename vg02 my_volume_group" does the same. +.SH SEE ALSO +.BR lvm (8), +.BR vgchange (8), +.BR vgcreate (8), +.BR lvrename (8) diff --git a/man/vgscan.8 b/man/vgscan.8 new file mode 100644 index 000000000..1715c0d09 --- /dev/null +++ b/man/vgscan.8 @@ -0,0 +1,20 @@ +.TH VGSCAN 8 "LVM TOOLS" "Sistina Software UK" \" -*- nroff -*- +.SH NAME +vgscan \- scan all disks for volume groups and rebuild caches +.SH SYNOPSIS +.B vgscan +[\-d/\-\-debug] [\-h/\-?/\-\-help] [\-v/\-\-verbose] +.SH DESCRIPTION +vgscan scans all SCSI, (E)IDE disks, multiple devices and a bunch +of other disk devices in the system looking for LVM physical volumes +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. +.SH OPTIONS +See \fBlvm\fP for common options. +.SH SEE ALSO +.BR lvm (8), +.BR vgcreate (8), +.BR vgchange (8)