]>
Commit | Line | Data |
---|---|---|
5951ef33 | 1 | .TH VGS 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*- |
4c64ed4c AK |
2 | .SH NAME |
3 | vgs \- report information about volume groups | |
4 | .SH SYNOPSIS | |
5 | .B vgs | |
c63b155d ZK |
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 [ + ] Field1 [ ,Field2 ...]] | |
16 | .RB [ \-O | \-\-sort | |
17 | .RI [ + | \- ] Key1 [ , [ + | \- ] Key2 ...]] | |
18 | .RB [ \-P | \-\-partial ] | |
19 | .RB [ \-\-rows ] | |
20 | .RB [ \-\-separator | |
21 | .IR Separator ] | |
22 | .RB [ \-\-unbuffered ] | |
23 | .RB [ \-\-units | |
24 | .IR hHbBsSkKmMgGtTpPeE ] | |
25 | .RB [ \-\-unquoted ] | |
26 | .RB [ \-v | \-\-verbose ] | |
27 | .RB [ \-\-version ] | |
28 | .RI [ VolumeGroupName | |
29 | .RI [ VolumeGroupName ...]] | |
4c64ed4c | 30 | .SH DESCRIPTION |
d6cf4325 | 31 | vgs produces formatted output about volume groups. |
4c64ed4c | 32 | .SH OPTIONS |
c63b155d | 33 | See \fBlvm\fP(8) for common options. |
4c64ed4c | 34 | .TP |
c63b155d | 35 | .B \-\-all |
7c638cc2 DW |
36 | List all volume groups. Equivalent to not specifying any volume groups. |
37 | .TP | |
c63b155d ZK |
38 | .B \-\-aligned |
39 | Use with \fB\-\-separator\fP to align the output columns. | |
4c64ed4c | 40 | .TP |
c63b155d | 41 | .B \-\-nameprefixes |
583ee601 | 42 | Add an "LVM2_" prefix plus the field name to the output. Useful |
c63b155d ZK |
43 | with \fB\-\-noheadings\fP to produce a list of field=value pairs that can |
44 | be used to set environment variables (for example, in \fBudev\fP(7) rules). | |
583ee601 | 45 | .TP |
c63b155d | 46 | .B \-\-noheadings |
4c64ed4c AK |
47 | Suppress the headings line that is normally the first line of output. |
48 | Useful if grepping the output. | |
49 | .TP | |
c63b155d ZK |
50 | .B \-\-nosuffix |
51 | Suppress the suffix on output sizes. Use with \fB\-\-units\fP | |
52 | (except h and H) if processing the output. | |
4c64ed4c | 53 | .TP |
c63b155d | 54 | .BR \-o ", " \-\-options |
4c64ed4c | 55 | Comma-separated ordered list of columns. Precede the list with '+' to append |
01b988cf DW |
56 | to the default selection of columns. |
57 | .IP | |
c63b155d | 58 | Use \fB\-o vg_all\fP to select all volume group columns. |
01b988cf | 59 | .IP |
c63b155d | 60 | Use \fB\-o help\fP to view the full list of columns available. |
01b988cf DW |
61 | .IP |
62 | Column names include: vg_fmt, vg_uuid, vg_name, vg_attr, vg_size, vg_free, | |
63 | vg_sysid, vg_extent_size, vg_extent_count, vg_free_count, max_lv, max_pv, | |
64 | pv_count, lv_count, snap_count, vg_seqno, vg_tags, vg_mda_count, vg_mda_free, | |
2f8e0473 | 65 | and vg_mda_size, vg_mda_used_count. |
01b988cf | 66 | .IP |
c63b155d ZK |
67 | Any "vg_" prefixes are optional. Columns mentioned in either \fBpvs\fP(8) |
68 | or \fBlvs\fP(8) can also be chosen, but columns cannot be taken from both | |
b4fb5226 | 69 | at the same time. |
b4fb5226 AK |
70 | .IP |
71 | The vg_attr bits are: | |
72 | .RS | |
73 | .IP 1 3 | |
74 | Permissions: (w)riteable, (r)ead-only | |
75 | .IP 2 3 | |
76 | Resi(z)eable | |
77 | .IP 3 3 | |
78 | E(x)ported | |
79 | .IP 4 3 | |
a0b0df93 DW |
80 | (p)artial: one or more physical volumes belonging to the volume group |
81 | are missing from the system | |
b4fb5226 AK |
82 | .IP 5 3 |
83 | Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited | |
84 | .IP 6 3 | |
85 | (c)lustered | |
86 | .RE | |
4c64ed4c | 87 | .TP |
c63b155d | 88 | .BR \-O ", " \-\-sort |
4c64ed4c | 89 | Comma-separated ordered list of columns to sort by. Replaces the default |
c63b155d ZK |
90 | selection. Precede any column with '\fI\-\fP' for a reverse sort on that |
91 | column. | |
4c64ed4c | 92 | .TP |
c63b155d | 93 | .B \-\-rows |
6baf9737 DW |
94 | Output columns as rows. |
95 | .TP | |
c63b155d | 96 | .B \-\-separator \fISeparator |
4c64ed4c AK |
97 | String to use to separate each column. Useful if grepping the output. |
98 | .TP | |
c63b155d | 99 | .B \-\-unbuffered |
4c64ed4c AK |
100 | Produce output immediately without sorting or aligning the columns properly. |
101 | .TP | |
c63b155d | 102 | .B \-\-units \fIhHbBsSkKmMgGtTpPeE |
3d425215 MS |
103 | All sizes are output in these units: (h)uman-readable, (b)ytes, (s)ectors, |
104 | (k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes. | |
105 | Capitalise to use multiples of 1000 (S.I.) instead of 1024. Can also specify | |
106 | custom units e.g. \-\-units 3M | |
c0f61d7d | 107 | .TP |
c63b155d ZK |
108 | .B \-\-unquoted |
109 | When used with \fB\-\-nameprefixes\fP, output values in the field=value | |
110 | pairs are not quoted. | |
4c64ed4c | 111 | .SH SEE ALSO |
06ea7eaa | 112 | .BR lvm (8), |
d6cf4325 | 113 | .BR vgdisplay (8), |
4c64ed4c AK |
114 | .BR pvs (8), |
115 | .BR lvs (8) |