summaryrefslogtreecommitdiff
path: root/man/lvs.8.in
diff options
context:
space:
mode:
authorAnas Nashif <anas.nashif@intel.com>2013-03-05 01:47:43 -0800
committerAnas Nashif <anas.nashif@intel.com>2013-03-05 01:47:43 -0800
commit44a3c2255bc480c82f34db156553a595606d8a0b (patch)
tree5e6df96a6c6e40207cb3a711860e16b543918c0d /man/lvs.8.in
parent8bd28eea831fd5215c12e6fcecc8e9a772398ed9 (diff)
downloaddevice-mapper-44a3c2255bc480c82f34db156553a595606d8a0b.tar.gz
device-mapper-44a3c2255bc480c82f34db156553a595606d8a0b.tar.bz2
device-mapper-44a3c2255bc480c82f34db156553a595606d8a0b.zip
Imported Upstream version 2.02.98upstream/2.02.98upstream/1.02.77
Diffstat (limited to 'man/lvs.8.in')
-rw-r--r--man/lvs.8.in193
1 files changed, 135 insertions, 58 deletions
diff --git a/man/lvs.8.in b/man/lvs.8.in
index baa14ab..f31256c 100644
--- a/man/lvs.8.in
+++ b/man/lvs.8.in
@@ -3,113 +3,190 @@
lvs \- report information about logical volumes
.SH SYNOPSIS
.B lvs
-[\-a|\-\-all]
-[\-\-aligned] [\-d|\-\-debug] [\-h|\-?|\-\-help]
-[\-\-ignorelockingfailure] [\-\-nameprefixes] [\-\-noheadings] [\-\-nosuffix]
-[\-o|\-\-options [+]Field[,Field]]
-[\-O|\-\-sort [+|-]Key1[,[+|-]Key2[,...]]]
-[\-P|\-\-partial] [\-\-rows] [\-\-segments]
-[\-\-separator Separator]
-[\-\-unbuffered]
-[\-\-units hHbBsSkKmMgGtTpPeE]
-[\-\-unquoted]
-[\-v|\-\-verbose]
-[\-\-version] [VolumeGroupName [VolumeGroupName...]]
+.RB [ \-\-aligned ]
+.RB [ \-a | \-\-all ]
+.RB [ \-d | \-\-debug ]
+.RB [ \-h | \-? | \-\-help ]
+.RB [ \-\-ignorelockingfailure ]
+.RB [ \-\-nameprefixes ]
+.RB [ \-\-noheadings ]
+.RB [ \-\-nosuffix ]
+.RB [ \-o | \-\-options
+.RI [ + ] Field [, Field ]]
+.RB [ \-O | \-\-sort
+.RI [ + | \- ] Key1 [,[ + | \- ] Key2 [,...]]]
+.RB [ \-P | \-\-partial ]
+.RB [ \-\-rows ]
+.RB [ \-\-separator
+.IR Separator ]
+.RB [ \-\-segments ]
+.RB [ \-\-unbuffered ]
+.RB [ \-\-units
+.IR hHbBsSkKmMgGtTpPeE ]
+.RB [ \-\-unquoted ]
+.RB [ \-v | \-\-verbose ]
+.RB [ \-\-version ]
+.RI [ VolumeGroupName
+.RI [ VolumeGroupName ...]]
+
.SH DESCRIPTION
lvs produces formatted output about logical volumes.
.SH OPTIONS
-See \fBlvm\fP for common options.
+See
+.BR lvm (8)
+for common options.
.TP
-.I \-\-all
+.B \-\-aligned
+Use with \fB\-\-separator\fP to align the output columns.
+.TP
+.B \-\-all
Include information in the output about internal Logical Volumes that
are components of normally-accessible Logical Volumes, such as mirrors,
but which are not independently accessible (e.g. not mountable).
The names of such Logical Volumes are enclosed within square brackets
-in the output. For example, after creating a mirror using 'lvcreate -m1
---mirrorlog disk', this option will reveal three internal Logical
+in the output. For example, after creating a mirror using
+.B lvcreate -m1 --mirrorlog disk
+, this option will reveal three internal Logical
Volumes, with suffixes mimage_0, mimage_1, and mlog.
.TP
-.I \-\-aligned
-Use with \-\-separator to align the output columns.
-.TP
-.I \-\-nameprefixes
+.B \-\-nameprefixes
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 \fBudev (7)\fP rules).
+with \fB\-\-noheadings\fP to produce a list of field=value pairs that can
+be used to set environment variables (for example, in
+.BR udev (7)
+rules).
.TP
-.I \-\-noheadings
+.B \-\-noheadings
Suppress the headings line that is normally the first line of output.
Useful if grepping the output.
.TP
-.I \-\-nosuffix
-Suppress the suffix on output sizes. Use with \-\-units (except h and H)
-if processing the output.
+.B \-\-nosuffix
+Suppress the suffix on output sizes. Use with \fB\-\-units\fP
+(except h and H) if processing the output.
.TP
-.I \-o, \-\-options
-Comma-separated ordered list of columns. Precede the list with '+' to append
-to the default selection of columns instead of replacing it.
+.BR \-o ", " \-\-options
+Comma-separated ordered list of columns. Precede the list with '\fI+\fP'
+to append to the default selection of columns instead of replacing it.
.IP
-Use \fb-o lv_all\fP to select all logical volume columns, and \fb-o seg_all\fP
+Use \fB\-o lv_all\fP to select all logical volume columns,
+and \fB\-o seg_all\fP
to select all logical volume segment columns.
.IP
-Use \fb-o help\fP to view the full list of columns available.
+Use \fB\-o help\fP to view the full list of columns available.
.IP
Column names include:
-lv_uuid, lv_name, lv_path, lv_attr, lv_major, lv_minor, lv_read_ahead, lv_kernel_major,
-lv_kernel_minor, lv_kernel_read_ahead, lv_size, seg_count, origin, origin_size,
-snap_percent, copy_percent, move_pv, convert_lv, lv_tags, mirror_log, modules,
-segtype, stripes, stripesize, regionsize, chunksize, seg_start, seg_start_pe,
-seg_size, seg_tags, seg_pe_ranges, devices.
+chunk_size,
+convert_lv,
+copy_percent,
+data_lv,
+devices,
+discards,
+lv_attr,
+lv_host,
+lv_kernel_major,
+lv_kernel_minor,
+lv_kernel_read_ahead,
+lv_major,
+lv_minor,
+lv_name,
+lv_path,
+lv_read_ahead,
+lv_size,
+lv_tags,
+lv_time,
+lv_uuid,
+metadata_lv,
+mirror_log,
+modules,
+move_pv,
+origin,
+origin_size,
+pool_lv,
+region_size,
+segtype,
+seg_count,
+seg_pe_ranges,
+seg_size,
+seg_start,
+seg_start_pe,
+seg_tags,
+snap_percent,
+stripes,
+stripe_size,
+thin_count,
+transaction_id,
+zero.
.IP
-With \-\-segments, any "seg_" prefixes are optional; otherwise any "lv_"
-prefixes are optional. Columns mentioned in \fBvgs (8)\fP
+With \fB\-\-segments\fP, any "seg_" prefixes are optional;
+otherwise any "lv_" prefixes are optional. Columns mentioned in
+.BR vgs (8)
can also be chosen.
.IP
-The lv_attr bits are:
+The lv_attr bits are:
.RS
.IP 1 3
Volume type: (m)irrored, (M)irrored without initial sync, (o)rigin,
-(O)rigin with merging snapshot, (s)napshot, merging (S)napshot, (p)vmove,
-(v)irtual, mirror (i)mage, mirror (I)mage out-of-sync, under (c)onversion
+(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, raid or
+thin pool m(e)tadata
.IP 2 3
-Permissions: (w)riteable, (r)ead-only
+Permissions: (w)riteable, (r)ead-only, (R)ead-only activation of non-read-only
+volume
.IP 3 3
-Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
+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 \fBpvmove\fP (8).
+changes, for example during
+.BR pvmove (8).
.IP 4 3
fixed (m)inor
.IP 5 3
State: (a)ctive, (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
.IP 6 3
device (o)pen
+.IP 7 3
+Target type: (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
+(p)artial: One or more of the Physical Volumes this Logical Volume uses is
+missing from the system.
.RE
.TP
-.I \-\-segments
-Use default columns that emphasize segment information.
-.TP
-.I \-O, \-\-sort
+.BR \-O ", " \-\-sort
Comma-separated ordered list of columns to sort by. Replaces the default
-selection. Precede any column with - for a reverse sort on that column.
+selection. Precede any column with '\fI\-\fP' for a reverse sort on that column.
.TP
-.I \-\-rows
+.B \-\-rows
Output columns as rows.
.TP
-.I \-\-separator Separator
+.B \-\-segments
+Use default columns that emphasize segment information.
+.TP
+.B \-\-separator \fISeparator
String to use to separate each column. Useful if grepping the output.
.TP
-.I \-\-unbuffered
+.B \-\-unbuffered
Produce output immediately without sorting or aligning the columns properly.
.TP
-.I \-\-units hHbBsSkKmMgGtTpPeE
+.B \-\-units \fIhHbBsSkKmMgGtTpPeE
All sizes are output in these units: (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. Can also specify
-custom units e.g. \-\-units 3M
+(k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes.
+Capitalise to use multiples of 1000 (S.I.) instead of 1024. Can also specify
+custom units e.g. \fB\-\-units 3M\fP
.TP
-.I \-\-unquoted
-When used with --nameprefixes, output values in the field=value pairs are not quoted.
+.B \-\-unquoted
+When used with \fB\-\-nameprefixes\fP, output values in the field=value
+pairs are not quoted.
.SH SEE ALSO
.BR lvm (8),
.BR lvdisplay (8),