lvm2/man/vgs.8.in

.TH VGS 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*-
.SH NAME
vgs \- report information about volume groups
.SH SYNOPSIS
.B vgs
.RB [ \-a | \-\-all ]
.RB [ \-\-aligned ]
.RB [ \-d | \-\-debug ]
.RB [ \-h | \-? | \-\-help ]
.RB [ \-\-ignorelockingfailure ]
.RB [ \-\-nameprefixes ]
.RB [ \-\-noheadings ]
.RB [ \-\-nosuffix ]
.RB [ \-o | \-\-options
.RI [ + ] Field1 [ ,Field2 ...]]
.RB [ \-O | \-\-sort
.RI [ + | \- ] Key1 [ , [ + | \- ] Key2 ...]]
.RB [ \-P | \-\-partial ]
.RB [ \-\-rows ]
.RB [ \-\-separator
.IR Separator ]
.RB [ \-\-unbuffered ]
.RB [ \-\-units
.IR hHbBsSkKmMgGtTpPeE ]
.RB [ \-\-unquoted ]
.RB [ \-v | \-\-verbose ]
.RB [ \-\-version ]
.RI [ VolumeGroupName
.RI [ VolumeGroupName ...]]
.SH DESCRIPTION
vgs produces formatted output about volume groups.
.SH OPTIONS
See \fBlvm\fP(8) for common options.
.TP
.B \-\-all
List all volume groups.  Equivalent to not specifying any volume groups.
.TP
.B \-\-aligned
Use with \fB\-\-separator\fP to align the output columns.
.TP
.B \-\-nameprefixes
Add an "LVM2_" prefix plus the field name to the output.  Useful
with \fB\-\-noheadings\fP to produce a list of field=value pairs that can
be used to set environment variables (for example, in \fBudev\fP(7) rules).
.TP
.B \-\-noheadings
Suppress the headings line that is normally the first line of output.
Useful if grepping the output.
.TP
.B \-\-nosuffix
Suppress the suffix on output sizes.  Use with \fB\-\-units\fP
(except h and H) if processing the output.
.TP
.BR \-o ", " \-\-options
Comma-separated ordered list of columns.  Precede the list with '+' to append
to the default selection of columns.
.IP
Use \fB\-o vg_all\fP to select all volume group columns.
.IP
Use \fB\-o help\fP to view the full list of columns available.
.IP
Column names include: vg_fmt, vg_uuid, vg_name, vg_attr, vg_size, vg_free,
vg_sysid, vg_extent_size, vg_extent_count, vg_free_count, vg_profile, max_lv,
max_pv, pv_count, lv_count, snap_count, vg_seqno, vg_tags, vg_mda_count,
vg_mda_free, and vg_mda_size, vg_mda_used_count.
.IP
Any "vg_" prefixes are optional.  Columns mentioned in either \fBpvs\fP(8)
or \fBlvs\fP(8) can also be chosen, but columns cannot be taken from both
at the same time.  
.IP
The vg_attr bits are:
.RS
.IP 1 3
Permissions: (w)riteable, (r)ead-only
.IP 2 3
Resi(z)eable
.IP 3 3
E(x)ported
.IP 4 3
(p)artial: one or more physical volumes belonging to the volume group
are missing from the system
.IP 5 3
Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
.IP 6 3
(c)lustered
.RE
.TP
.BR \-O ", " \-\-sort
Comma-separated ordered list of columns to sort by.  Replaces the default
selection. Precede any column with '\fI\-\fP' for a reverse sort on that
column.
.TP
.B \-\-rows
Output columns as rows.
.TP
.B \-\-separator \fISeparator
String to use to separate each column.  Useful if grepping the output.
.TP
.B \-\-unbuffered
Produce output immediately without sorting or aligning the columns properly.
.TP
.B \-\-units \fIhHbBsSkKmMgGtTpPeE
All sizes are output in these units: (h)uman-readable, (b)ytes, (s)ectors,
(k)ilobytes, (m)egabytes, (g)igabytes, (t)erabytes, (p)etabytes, (e)xabytes.  
Capitalise to use multiples of 1000 (S.I.) instead of 1024.  Can also specify 
custom units e.g. \-\-units 3M
.TP
.B \-\-unquoted
When used with \fB\-\-nameprefixes\fP, output values in the field=value
pairs are not quoted.
.SH SEE ALSO
.BR lvm (8),
.BR vgdisplay (8),
.BR pvs (8),
.BR lvs (8)