2008-10-08 16:50:13 +04:00
.TH VGS 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*-
2002-12-12 23:55:49 +03:00
.SH NAME
vgs \- report information about volume groups
.SH SYNOPSIS
.B vgs
2008-11-12 18:01:35 +03:00
[\- \- aligned] [\- d|\- \- debug] [\- h|\- ?|\- \- help]
2009-01-20 20:10:44 +03:00
[\- \- ignorelockingfailure] [\- \- nameprefixes] [\- \- noheadings] [\- \- nosuffix]
2008-11-12 18:01:35 +03:00
[\- o|\- \- options [+]Field[,Field]]
2008-11-12 18:16:58 +03:00
[\- O|\- \- sort [+|-]Key1[,[+|-]Key2[,...]]]
2009-01-20 19:55:24 +03:00
[\- P|\- \- partial] [\- \- rows]
2002-12-12 23:55:49 +03:00
[\- \- separator Separator] [\- \- unbuffered]
2009-07-07 23:28:57 +04:00
[\- \- units hHbBsSkKmMgGtTpPeE]
2009-01-20 20:39:07 +03:00
[\- \- unquoted]
2008-11-12 18:01:35 +03:00
[\- v|\- \- verbose]
2002-12-12 23:55:49 +03:00
[\- \- version] [VolumeGroupName [VolumeGroupName...]]
.SH DESCRIPTION
2004-11-12 18:59:09 +03:00
vgs produces formatted output about volume groups.
2002-12-12 23:55:49 +03:00
.SH OPTIONS
See \fB lvm\fP for common options.
.TP
.I \- \- aligned
Use with \- \- separator to align the output columns.
.TP
2009-01-20 20:10:44 +03:00
.I \- \- nameprefixes
Add an "LVM2_" prefix plus the field name to the output. Useful
with --noheadings to produce a list of field=value pairs that can
be used to set environment variables (for example, in \fB udev (7)\fP rules).
.TP
2002-12-12 23:55:49 +03:00
.I \- \- noheadings
Suppress the headings line that is normally the first line of output.
Useful if grepping the output.
.TP
.I \- \- nosuffix
Suppress the suffix on output sizes. Use with \- \- units (except h and H)
if processing the output.
.TP
.I \- o, \- \- options
Comma-separated ordered list of columns. Precede the list with '+' to append
Cleanup pvs, vgs, and lvs "-o" section in man pages (rhbz 500861).
http://bugzilla.redhat.com/show_bug.cgi?id=500861
- Update list of fields/columns for each command (a few missing).
- Update list order to match "-o help" output (easier to verify field list)
- Add "{pv|vg|lv}_all" description.
- Move "-o help" sentence above column/field list.
New sample man page for lvs (pvs and vgs are similar):
-o, --options
Comma-separated ordered list of columns. Precede the list with ’+’ to append to the
default selection of columns instead of replacing it.
Use -o lv_all to select all logical volume columns, and -o seg_all to select all logical
segment columns.
Use -o help to view the full list of columns available.
Column names include: lv_uuid, lv_name, lv_attr, lv_major, lv_minor, lv_read_ahead,
lv_kernel_major, lv_kernel_minor, lv_kernel_read_ahead, lv_size, seg_count, origin, ori-
gin_size, snap_percent, copy_percent, move_pv, convert_lv, lv_tags, mirror_log, modules,
segtype, stripes, stripesize, regionsize, chunksize, seg_start, seg_start_pe, seg_size,
seg_tags, seg_pe_ranges, devices.
With --segments, any "seg_" prefixes are optional; otherwise any "lv_" prefixes are
optional. Columns mentioned in vgs (8) can also be chosen.
The lv_attr bits are:
2009-06-15 21:09:32 +04:00
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, max_lv, max_pv,
pv_count, lv_count, snap_count, vg_seqno, vg_tags, vg_mda_count, vg_mda_free,
and vg_mda_size.
.IP
2002-12-12 23:55:49 +03:00
Any "vg_" prefixes are optional. Columns mentioned in either \fB pvs (8)\fP
or \fB lvs (8)\fP can also be chosen, but columns cannot be taken from both
2007-03-27 17:35:33 +04:00
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
.IP 5 3
Allocation policy: (c)ontiguous, c(l)ing, (n)ormal, (a)nywhere, (i)nherited
.IP 6 3
(c)lustered
.RE
2002-12-12 23:55:49 +03:00
.TP
.I \- O, \- \- sort
Comma-separated ordered list of columns to sort by. Replaces the default
selection. Precede any column with - for a reverse sort on that column.
.TP
2009-01-20 19:55:24 +03:00
.I \- \- rows
Output columns as rows.
.TP
2002-12-12 23:55:49 +03:00
.I \- \- separator Separator
String to use to separate each column. Useful if grepping the output.
.TP
.I \- \- unbuffered
Produce output immediately without sorting or aligning the columns properly.
.TP
2009-07-07 23:28:57 +04:00
.I \- \- units hHbBsSkKmMgGtTpPeE
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
2009-01-20 20:39:07 +03:00
.TP
.I \- \- unquoted
When used with --nameprefixes, output values in the field=value pairs are not quoted.
2002-12-12 23:55:49 +03:00
.SH SEE ALSO
2008-01-10 21:35:51 +03:00
.BR lvm (8),
2004-11-12 18:59:09 +03:00
.BR vgdisplay (8),
2002-12-12 23:55:49 +03:00
.BR pvs (8),
.BR lvs (8)