Tizen 2.1 base
[external/device-mapper.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 [\-a|\-\-all]
7 [\-\-aligned] [\-d|\-\-debug] [\-h|\-?|\-\-help]
8 [\-\-ignorelockingfailure] [\-\-nameprefixes] [\-\-noheadings] [\-\-nosuffix]
9 [\-o|\-\-options [+]Field[,Field]]
10 [\-O|\-\-sort [+|-]Key1[,[+|-]Key2[,...]]]
11 [\-P|\-\-partial] [\-\-rows] [\-\-segments]
12 [\-\-separator Separator]
13 [\-\-unbuffered]
14 [\-\-units hHbBsSkKmMgGtTpPeE]
15 [\-\-unquoted]
16 [\-v|\-\-verbose] 
17 [\-\-version] [VolumeGroupName [VolumeGroupName...]]
18 .SH DESCRIPTION
19 lvs produces formatted output about logical volumes.
20 .SH OPTIONS
21 See \fBlvm\fP for common options.
22 .TP
23 .I \-\-all
24 Include information in the output about internal Logical Volumes that
25 are components of normally-accessible Logical Volumes, such as mirrors,
26 but which are not independently accessible (e.g. not mountable).
27 The names of such Logical Volumes are enclosed within square brackets
28 in the output.  For example, after creating a mirror using 'lvcreate -m1
29 --mirrorlog disk', this option will reveal three internal Logical
30 Volumes, with suffixes mimage_0, mimage_1, and mlog.
31 .TP
32 .I \-\-aligned
33 Use with \-\-separator to align the output columns.
34 .TP
35 .I \-\-nameprefixes
36 Add an "LVM2_" prefix plus the field name to the output.  Useful
37 with --noheadings to produce a list of field=value pairs that can
38 be used to set environment variables (for example, in \fBudev (7)\fP rules).
39 .TP
40 .I \-\-noheadings
41 Suppress the headings line that is normally the first line of output.
42 Useful if grepping the output.
43 .TP
44 .I \-\-nosuffix
45 Suppress the suffix on output sizes.  Use with \-\-units (except h and H)
46 if processing the output.
47 .TP
48 .I \-o, \-\-options
49 Comma-separated ordered list of columns.  Precede the list with '+' to append
50 to the default selection of columns instead of replacing it.
51 .IP
52 Use \fb-o lv_all\fP to select all logical volume columns, and \fb-o seg_all\fP
53 to select all logical volume segment columns.
54 .IP
55 Use \fb-o help\fP to view the full list of columns available.
56 .IP
57 Column names include:
58 lv_uuid, lv_name, lv_path, lv_attr, lv_major, lv_minor, lv_read_ahead, lv_kernel_major,
59 lv_kernel_minor, lv_kernel_read_ahead, lv_size, seg_count, origin, origin_size,
60 snap_percent, copy_percent, move_pv, convert_lv, lv_tags, mirror_log, modules,
61 segtype, stripes, stripesize, regionsize, chunksize, seg_start, seg_start_pe,
62 seg_size, seg_tags, seg_pe_ranges, devices.
63 .IP
64 With \-\-segments, any "seg_" prefixes are optional; otherwise any "lv_"
65 prefixes are optional.  Columns mentioned in \fBvgs (8)\fP 
66 can also be chosen.
67 .IP
68 The lv_attr bits are: 
69 .RS
70 .IP 1 3
71 Volume type: (m)irrored, (M)irrored without initial sync, (o)rigin,
72 (O)rigin with merging snapshot, (s)napshot, merging (S)napshot, (p)vmove,
73 (v)irtual, mirror (i)mage, mirror (I)mage out-of-sync, under (c)onversion
74 .IP 2 3
75 Permissions: (w)riteable, (r)ead-only
76 .IP 3 3
77 Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
78 This is capitalised if the volume is currently locked against allocation
79 changes, for example during \fBpvmove\fP (8).
80 .IP 4 3
81 fixed (m)inor
82 .IP 5 3
83 State: (a)ctive, (s)uspended, (I)nvalid snapshot, invalid (S)uspended snapshot,
84 mapped (d)evice present without tables, mapped device present with (i)nactive table
85 .IP 6 3
86 device (o)pen
87 .RE
88 .TP
89 .I \-\-segments
90 Use default columns that emphasize segment information.
91 .TP
92 .I \-O, \-\-sort
93 Comma-separated ordered list of columns to sort by.  Replaces the default
94 selection. Precede any column with - for a reverse sort on that column.
95 .TP
96 .I \-\-rows
97 Output columns as rows.
98 .TP
99 .I \-\-separator Separator
100 String to use to separate each column.  Useful if grepping the output.
101 .TP
102 .I \-\-unbuffered
103 Produce output immediately without sorting or aligning the columns properly.
104 .TP
105 .I \-\-units hHbBsSkKmMgGtTpPeE
106 All sizes are output in these units: (h)uman-readable, (b)ytes, (s)ectors,
107 (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes.  
108 Capitalise to use multiples of 1000 (S.I.) instead of 1024.  Can also specify 
109 custom units e.g. \-\-units 3M
110 .TP
111 .I \-\-unquoted
112 When used with --nameprefixes, output values in the field=value pairs are not quoted.
113 .SH SEE ALSO
114 .BR lvm (8),
115 .BR lvdisplay (8),
116 .BR pvs (8),
117 .BR vgs (8)