man: add files with description informationdev-dct-cmd-defs80

The text in the .des files will be included in
the DESCRIPTION section.

19 files changed, 184 insertions, 0 deletions

diff --git a/man/lvchange.8.des b/man/lvchange.8.des
new file mode 100644
index 000000000..7aa8ce754
--- /dev/null
+++ b/man/lvchange.8.des
@@ -0,0 +1,2 @@
+lvchange changes LV attributes in the VG, changes LV activation in the
+kernel, and includes other utilities for LV maintenance.
diff --git a/man/lvconvert.8.des b/man/lvconvert.8.des
new file mode 100644
index 000000000..6fff91e0b
--- /dev/null
+++ b/man/lvconvert.8.des
@@ -0,0 +1,53 @@
+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.
+
+To display the current LV type, run the command:
+
+.B lvs \-o name,segtype
+.I LV
+
+A command to change the LV type uses the general pattern:
+
+.B lvconvert \-\-type
+.I NewType LV
+
+LVs with the following types can be modified by lvconvert:
+.B striped,
+.B snapshot,
+.B mirror,
+.B raid*,
+.B thin,
+.B cache,
+.B thin\-pool,
+.B cache\-pool.
+
+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.
+
+In most cases, the
+.B mirror
+type is deprecated and the
+.B raid1
+type should be used.  They are both implementations of mirroring.
+
+The
+.B raid*
+type refers to one of many raid levels, e.g.
+.B raid1,
+.B raid5.
+
+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.
+
+Sub LVs can be displayed with the command
+.B lvs -a
+
diff --git a/man/lvcreate.8.des b/man/lvcreate.8.des
new file mode 100644
index 000000000..e18affeac
--- /dev/null
+++ b/man/lvcreate.8.des
@@ -0,0 +1,28 @@
+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, then the VG can be extended (see
+\fBvgextend\fP(8)) with other PVs, or existing LVs can be reduced or
+removed (see \fBlvremove\fP, \fBlvreduce\fP.)
+
+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.
+
+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.
+
+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.
+
+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 references to the pools.
+
+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.
+
diff --git a/man/lvdisplay.8.des b/man/lvdisplay.8.des
new file mode 100644
index 000000000..48552cc95
--- /dev/null
+++ b/man/lvdisplay.8.des
@@ -0,0 +1,5 @@
+lvdisplay shows the attributes of LVs, like size, read/write status,
+snapshot information, etc.
+
+\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
new file mode 100644
index 000000000..2a3781d1d
--- /dev/null
+++ b/man/lvextend.8.des
@@ -0,0 +1,5 @@
+lvextend extends the size of an LV. This requires allocating logical
+extents from the VG's free physical extents. A copy\-on\-write snapshot LV
+can also be extended to provide more space to hold COW blocks. Use
+\fBlvconvert\fP(8) to change the number of data images in a RAID or
+mirrored LV.
diff --git a/man/lvm-fullreport.8.des b/man/lvm-fullreport.8.des
new file mode 100644
index 000000000..f350a0aed
--- /dev/null
+++ b/man/lvm-fullreport.8.des
@@ -0,0 +1,6 @@
+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.
+
diff --git a/man/lvm-lvpoll.8.des b/man/lvm-lvpoll.8.des
new file mode 100644
index 000000000..35c252231
--- /dev/null
+++ b/man/lvm-lvpoll.8.des
@@ -0,0 +1,4 @@
+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.
diff --git a/man/lvmconfig.8.des b/man/lvmconfig.8.des
new file mode 100644
index 000000000..17f9f18e7
--- /dev/null
+++ b/man/lvmconfig.8.des
@@ -0,0 +1,3 @@
+lvmconfig produces formatted output from the LVM configuration tree. The
+sources of the configuration data include \fBlvm.conf\fP(5) and command
+line settings from \-\-config.
diff --git a/man/lvmdiskscan.8.des b/man/lvmdiskscan.8.des
new file mode 100644
index 000000000..c1e87cca5
--- /dev/null
+++ b/man/lvmdiskscan.8.des
@@ -0,0 +1,7 @@
+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.
+
+This command is deprecated, use \fBpvs\fP instead.
+
diff --git a/man/lvreduce.8.des b/man/lvreduce.8.des
new file mode 100644
index 000000000..7f0ba0cd8
--- /dev/null
+++ b/man/lvreduce.8.des
@@ -0,0 +1,14 @@
+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.
+
+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.
+
+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.
diff --git a/man/lvremove.8.des b/man/lvremove.8.des
new file mode 100644
index 000000000..d049c635f
--- /dev/null
+++ b/man/lvremove.8.des
@@ -0,0 +1,22 @@
+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.
+
+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.
+
+\fBHistorical LVs\fP
+
+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
+retained. This includes the time of removal (\fBlv_time_removed\fP
+reporting field), creation time (\fBlv_time\fP), name (\fBlv_name\fP), LV
+uuid (\fBlv_uuid\fP) and VG name (\fBvg_name\fP). This allows later
+reporting to see the ancestry chain of thin snapshot volumes, even after
+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.
+
diff --git a/man/lvrename.8.des b/man/lvrename.8.des
new file mode 100644
index 000000000..a8455fc70
--- /dev/null
+++ b/man/lvrename.8.des
@@ -0,0 +1,2 @@
+lvrename renames an existing LV or a historical LV (see \fBlvremove\fP for
+historical LV information.)
diff --git a/man/lvresize.8.des b/man/lvresize.8.des
new file mode 100644
index 000000000..7fdcacc6f
--- /dev/null
+++ b/man/lvresize.8.des
@@ -0,0 +1,2 @@
+lvresize resizes an LV in the same way as lvextend and lvreduce. See
+\fBlvextend\fP(8) and \fBlvreduce\fP(8) for more information.
diff --git a/man/lvs.8.des b/man/lvs.8.des
new file mode 100644
index 000000000..5f8076447
--- /dev/null
+++ b/man/lvs.8.des
@@ -0,0 +1 @@
+lvs produces formatted output about LVs.
diff --git a/man/lvscan.8.des b/man/lvscan.8.des
new file mode 100644
index 000000000..e30eb58de
--- /dev/null
+++ b/man/lvscan.8.des
@@ -0,0 +1,5 @@
+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.
diff --git a/man/pvchange.8.des b/man/pvchange.8.des
new file mode 100644
index 000000000..802850fa1
--- /dev/null
+++ b/man/pvchange.8.des
@@ -0,0 +1 @@
+pvchange changes PV attributes in the VG.
diff --git a/man/pvck.8.des b/man/pvck.8.des
new file mode 100644
index 000000000..0a3265789
--- /dev/null
+++ b/man/pvck.8.des
@@ -0,0 +1 @@
+pvck checks the LVM metadata for consistency on PVs.
diff --git a/man/pvcreate.8.des b/man/pvcreate.8.des
new file mode 100644
index 000000000..3dfddbcb7
--- /dev/null
+++ b/man/pvcreate.8.des
@@ -0,0 +1,18 @@
+pvcreate initializes a PV so that it is recognized as belonging to LVM,
+and allows the PV to be used in a VG. A PV can be a disk partition, whole
+disk, meta device, or loopback file.
+
+For DOS disk partitions, the partition id should be set to 0x8e using
+.BR fdisk (8),
+.BR cfdisk (8),
+or a equivalent. For GUID Partition Table (GPT), the id is
+E6D6D379-F507-44C2-A23C-238F2A3DF928. For
+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:
+
+.BI "dd if=/dev/zero of=" PhysicalVolume " bs=512 count=1"
+
+Use \fBvgcreate\fP(8) to create a new VG on the PV, or \fBvgextend\fP(8)
+to add the PV to existing VG.
+
diff --git a/man/pvdisplay.8.des b/man/pvdisplay.8.des
new file mode 100644
index 000000000..74d57ca78
--- /dev/null
+++ b/man/pvdisplay.8.des
@@ -0,0 +1,5 @@
+pvdisplay shows the attributes of PVs, like size, physical extent size,
+space used for the VG descriptor area, etc.
+
+\fBpvs\fP(8) is a preferred alternative that shows the same information
+and more, using a more compact and configurable output format.