contrib/lvm2/dist/man/vgs.8.in

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