Sync usage with man page.
[netbsd-mini2440.git] / external / gpl2 / lvm2 / dist / man / lvs.8
blob7257a98d24ad3229622a4fd866651dbed3e67c79
1 .\"    $NetBSD$
2 .\"
3 .TH LVS 8 "LVM TOOLS 2.02.44-cvs (02-17-09)" "Sistina Software UK" \" -*- nroff -*-
4 .SH NAME
5 lvs \- report information about logical volumes
6 .SH SYNOPSIS
7 .B lvs
8 [\-\-aligned] [\-d|\-\-debug] [\-h|\-?|\-\-help]
9 [\-\-ignorelockingfailure] [\-\-nameprefixes] [\-\-noheadings] [\-\-nosuffix]
10 [\-o|\-\-options [+]Field[,Field]]
11 [\-O|\-\-sort [+|-]Key1[,[+|-]Key2[,...]]]
12 [\-P|\-\-partial] [\-\-rows] [\-\-segments]
13 [\-\-separator Separator] [\-\-unbuffered]
14 [\-\-units hsbkmgtHKMGT]
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 \-\-aligned
24 Use with \-\-separator to align the output columns.
25 .TP
26 .I \-\-nameprefixes
27 Add an "LVM2_" prefix plus the field name to the output.  Useful
28 with --noheadings to produce a list of field=value pairs that can
29 be used to set environment variables (for example, in \fBudev (7)\fP rules).
30 .TP
31 .I \-\-noheadings
32 Suppress the headings line that is normally the first line of output.
33 Useful if grepping the output.
34 .TP
35 .I \-\-nosuffix
36 Suppress the suffix on output sizes.  Use with \-\-units (except h and H)
37 if processing the output.
38 .TP
39 .I \-o, \-\-options
40 Comma-separated ordered list of columns.  Precede the list with '+' to append
41 to the default selection of columns instead of replacing it.  Column names are: 
42 lv_uuid, lv_name, lv_attr, lv_major, lv_minor, lv_kernel_major, lv_kernel_minor,
43 lv_size, seg_count, origin, snap_percent,
44 copy_percent, move_pv, lv_tags,
45 segtype, stripes,
46 stripesize, chunksize, seg_start, seg_size, seg_tags, devices,
47 regionsize, mirror_log, modules.
48 .IP
49 With \-\-segments, any "seg_" prefixes are optional; otherwise any "lv_"
50 prefixes are optional.  Columns mentioned in \fBvgs (8)\fP 
51 can also be chosen.
52 Use \fb-o help\fP to view the full list of fields available.
53 .IP
54 The lv_attr bits are: 
55 .RS
56 .IP 1 3
57 Volume type: (m)irrored, (M)irrored without initial sync, (o)rigin, (p)vmove, (s)napshot, 
58 invalid (S)napshot, (v)irtual, mirror (i)mage, mirror (I)mage out-of-sync,
59 under (c)onversion
60 .IP 2 3
61 Permissions: (w)riteable, (r)ead-only
62 .IP 3 3
63 Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
64 This is capitalised if the volume is currently locked against allocation
65 changes, for example during \fBpvmove\fP (8).
66 .IP 4 3
67 fixed (m)inor
68 .IP 5 3
69 State: (a)ctive, (s)uspended, (I)nvalid snapshot, invalid (S)uspended snapshot,
70 mapped (d)evice present without tables, mapped device present with (i)nactive table
71 .IP 6 3
72 device (o)pen
73 .RE
74 .TP
75 .I \-\-segments
76 Use default columns that emphasize segment information.
77 .TP
78 .I \-O, \-\-sort
79 Comma-separated ordered list of columns to sort by.  Replaces the default
80 selection. Precede any column with - for a reverse sort on that column.
81 .TP
82 .I \-\-rows
83 Output columns as rows.
84 .TP
85 .I \-\-separator Separator
86 String to use to separate each column.  Useful if grepping the output.
87 .TP
88 .I \-\-unbuffered
89 Produce output immediately without sorting or aligning the columns properly.
90 .TP
91 .I \-\-units hsbkmgtHKMGT
92 All sizes are output in these units: (h)uman-readable, (s)ectors, (b)ytes,
93 (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes.  Capitalise to use multiples
94 of 1000 (S.I.) instead of 1024.  Can also specify custom (u)nits e.g.
95 \-\-units 3M
96 .TP
97 .I \-\-unquoted
98 When used with --nameprefixes, output values in the field=value pairs are not quoted.
99 .SH SEE ALSO
100 .BR lvm (8),
101 .BR lvdisplay (8),
102 .BR pvs (8),
103 .BR vgs (8)