]> sourceware.org Git - lvm2.git/blob - man/lvs.8.in
update reworded string
[lvm2.git] / man / lvs.8.in
1 .TH LVS 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*-
2 .SH NAME
3 lvs \- report information about logical volumes
4 .SH SYNOPSIS
5 .B lvs
6 .RB [ \-a | \-\-all ]
7 .RB [ \-\-aligned ]
8 .RB [ \-d | \-\-debug ]
9 .RB [ \-h | \-? | \-\-help ]
10 .RB [ \-\-ignorelockingfailure ]
11 .RB [ \-\-nameprefixes ]
12 .RB [ \-\-noheadings ]
13 .RB [ \-\-nosuffix ]
14 .RB [ \-o | \-\-options
15 .RI [ + ] Field [, Field ]]
16 .RB [ \-O | \-\-sort
17 .RI [ + | - ] Key1 [,[ + | - ] Key2 [,...]]]
18 .RB [ \-P | \-\-partial ]
19 .RB [ \-\-rows ]
20 .RB [ \-\-segments ]
21 .RB [ \-\-separator
22 .IR Separator ]
23 .RB [ \-\-unbuffered ]
24 .RB [ \-\-units
25 .IR hHbBsSkKmMgGtTpPeE ]
26 .RB [ \-\-unquoted ]
27 .RB [ \-v | \-\-verbose ]
28 .RB [ \-\-version ]
29 .RI [ VolumeGroupName
30 .RI [ VolumeGroupName ...]]
31
32 .SH DESCRIPTION
33 lvs produces formatted output about logical volumes.
34 .SH OPTIONS
35 See
36 .BR lvm (8)
37 for common options.
38 .TP
39 .B \-\-all
40 Include information in the output about internal Logical Volumes that
41 are components of normally-accessible Logical Volumes, such as mirrors,
42 but which are not independently accessible (e.g. not mountable).
43 The names of such Logical Volumes are enclosed within square brackets
44 in the output. For example, after creating a mirror using 'lvcreate -m1
45 --mirrorlog disk', this option will reveal three internal Logical
46 Volumes, with suffixes mimage_0, mimage_1, and mlog.
47 .TP
48 .B \-\-aligned
49 Use with \-\-separator to align the output columns.
50 .TP
51 .B \-\-nameprefixes
52 Add an "LVM2_" prefix plus the field name to the output. Useful
53 with --noheadings to produce a list of field=value pairs that can
54 be used to set environment variables (for example, in
55 .BR udev (7)
56 rules).
57 .TP
58 .B \-\-noheadings
59 Suppress the headings line that is normally the first line of output.
60 Useful if grepping the output.
61 .TP
62 .B \-\-nosuffix
63 Suppress the suffix on output sizes. Use with \-\-units (except h and H)
64 if processing the output.
65 .TP
66 .BR \-o ", " \-\-options
67 Comma-separated ordered list of columns. Precede the list with '+' to append
68 to the default selection of columns instead of replacing it.
69 .IP
70 Use \fb-o lv_all\fP to select all logical volume columns, and \fb-o seg_all\fP
71 to select all logical volume segment columns.
72 .IP
73 Use \fb-o help\fP to view the full list of columns available.
74 .IP
75 Column names include:
76 lv_uuid, lv_name, lv_path, lv_attr, lv_major, lv_minor, lv_read_ahead, lv_kernel_major,
77 lv_kernel_minor, lv_kernel_read_ahead, lv_size, seg_count, origin, origin_size,
78 snap_percent, copy_percent, move_pv, convert_lv, lv_tags, mirror_log, thin_pool, modules,
79 segtype, stripes, stripesize, regionsize, chunksize, seg_start, seg_start_pe,
80 seg_size, seg_tags, seg_pe_ranges, devices.
81 .IP
82 With \-\-segments, any "seg_" prefixes are optional; otherwise any "lv_"
83 prefixes are optional. Columns mentioned in
84 .BR vgs (8)
85 can also be chosen.
86 .IP
87 The lv_attr bits are:
88 .RS
89 .IP 1 3
90 Volume type: (m)irrored, (M)irrored without initial sync, (o)rigin,
91 (O)rigin with merging snapshot, (r)aid, (R)aid without initial sync,
92 (s)napshot, merging (S)napshot, (p)vmove, (v)irtual,
93 mirror or raid (i)mage, mirror or raid (I)mage out-of-sync, mirror (l)og device,
94 under (c)onversion, thin (V)olume, (t)hin pool, (T)hin pool data, raid or
95 thin pool m(e)tadata
96 .IP 2 3
97 Permissions: (w)riteable, (r)ead-only, (R)ead-only activation of non-read-only
98 volume
99 .IP 3 3
100 Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
101 This is capitalised if the volume is currently locked against allocation
102 changes, for example during
103 .BR pvmove (8).
104 .IP 4 3
105 fixed (m)inor
106 .IP 5 3
107 State: (a)ctive, (s)uspended, (I)nvalid snapshot, invalid (S)uspended snapshot,
108 snapshot (m)erge failed, suspended snapshot (M)erge failed,
109 mapped (d)evice present without tables, mapped device present with (i)nactive table
110 .IP 6 3
111 device (o)pen
112 .IP 7 3
113 Target type: (m)irror, (r)aid, (s)napshot, (t)hin, (u)nknown, (v)irtual.
114 This groups logical volumes related to the same kernel target together. So,
115 for example, mirror images, mirror logs as well as mirrors themselves appear as
116 (m) if they use the original device-mapper mirror kernel driver; whereas the raid
117 equivalents using the md raid kernel driver all appear as (r).
118 Snapshots using the original device-mapper driver appear as (s); whereas
119 snapshots of thin volumes using the new thin provisioning driver appear as (t).
120 .IP 8 3
121 Newly-allocated data blocks are overwritten with blocks of (z)eroes before use.
122 .RE
123 .TP
124 .B \-\-segments
125 Use default columns that emphasize segment information.
126 .TP
127 .BR \-O ", " \-\-sort
128 Comma-separated ordered list of columns to sort by. Replaces the default
129 selection. Precede any column with - for a reverse sort on that column.
130 .TP
131 .B \-\-rows
132 Output columns as rows.
133 .TP
134 .B \-\-separator \fISeparator
135 String to use to separate each column. Useful if grepping the output.
136 .TP
137 .B \-\-unbuffered
138 Produce output immediately without sorting or aligning the columns properly.
139 .TP
140 .B \-\-units \fIhHbBsSkKmMgGtTpPeE
141 All sizes are output in these units: (h)uman-readable, (b)ytes, (s)ectors,
142 (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes.
143 Capitalise to use multiples of 1000 (S.I.) instead of 1024. Can also specify
144 custom units e.g. \-\-units 3M
145 .TP
146 .B \-\-unquoted
147 When used with --nameprefixes, output values in the field=value pairs are not quoted.
148 .SH SEE ALSO
149 .BR lvm (8),
150 .BR lvdisplay (8),
151 .BR pvs (8),
152 .BR vgs (8)
This page took 0.038053 seconds and 5 git commands to generate.