Sync usage with man page.
[netbsd-mini2440.git] / external / gpl2 / lvm2 / dist / man / vgs.8
blobd6678a37d2ff62a862e1356b72e295cb5e4b5b50
1 .\"    $NetBSD$
2 .\"
3 .TH VGS 8 "LVM TOOLS 2.02.44-cvs (02-17-09)" "Sistina Software UK" \" -*- nroff -*-
4 .SH NAME
5 vgs \- report information about volume groups
6 .SH SYNOPSIS
7 .B vgs
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]
13 [\-\-separator Separator] [\-\-unbuffered]
14 [\-\-units hsbkmgtHKMGT]
15 [\-\-unquoted]
16 [\-v|\-\-verbose] 
17 [\-\-version] [VolumeGroupName [VolumeGroupName...]]
18 .SH DESCRIPTION
19 vgs produces formatted output about volume groups.
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.  Column names are: vg_fmt, vg_uuid,
42 vg_name, vg_attr, vg_size, vg_free, vg_sysid, vg_extent_size, vg_extent_count,
43 vg_free_count, max_lv, max_pv, pv_count, lv_count, snap_count, vg_seqno,
44 vg_tags, vg_mda_count, vg_mda_free, and vg_mda_size.
45 Any "vg_" prefixes are optional.  Columns mentioned in either \fBpvs (8)\fP 
46 or \fBlvs (8)\fP can also be chosen, but columns cannot be taken from both
47 at the same time.  
48 Use \fb-o help\fP to view the full list of fields available.
49 .IP
50 The vg_attr bits are:
51 .RS
52 .IP 1 3
53 Permissions: (w)riteable, (r)ead-only
54 .IP 2 3
55 Resi(z)eable
56 .IP 3 3
57 E(x)ported
58 .IP 4 3
59 (p)artial
60 .IP 5 3
61 Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
62 .IP 6 3
63 (c)lustered
64 .RE
65 .TP
66 .I \-O, \-\-sort
67 Comma-separated ordered list of columns to sort by.  Replaces the default
68 selection. Precede any column with - for a reverse sort on that column.
69 .TP
70 .I \-\-rows
71 Output columns as rows.
72 .TP
73 .I \-\-separator Separator
74 String to use to separate each column.  Useful if grepping the output.
75 .TP
76 .I \-\-unbuffered
77 Produce output immediately without sorting or aligning the columns properly.
78 .TP
79 .I \-\-units hsbkmgtHKMGT
80 All sizes are output in these units: (h)uman-readable, (s)ectors, (b)ytes,
81 (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes.  Capitalise to use multiples
82 of 1000 (S.I.) instead of 1024.  Can also specify custom (u)nits e.g.
83 \-\-units 3M
84 .TP
85 .I \-\-unquoted
86 When used with --nameprefixes, output values in the field=value pairs are not quoted.
87 .SH SEE ALSO
88 .BR lvm (8),
89 .BR vgdisplay (8),
90 .BR pvs (8),
91 .BR lvs (8)