summaryrefslogtreecommitdiffstats
path: root/man/pvs.8.in
diff options
context:
space:
mode:
Diffstat (limited to 'man/pvs.8.in')
-rw-r--r--man/pvs.8.in104
1 files changed, 58 insertions, 46 deletions
diff --git a/man/pvs.8.in b/man/pvs.8.in
index 8a24eb5a..4bdfa12d 100644
--- a/man/pvs.8.in
+++ b/man/pvs.8.in
@@ -3,90 +3,102 @@
pvs \- report information about physical volumes
.SH SYNOPSIS
.B pvs
-[\-a|\-\-all]
-[\-\-aligned] [\-d|\-\-debug] [\-h|\-?|\-\-help]
-[\-\-ignorelockingfailure] [\-\-nameprefixes] [\-\-noheadings] [\-\-nosuffix]
-[\-o|\-\-options [+]Field[,Field]]
-[\-O|\-\-sort [+|-]Key1[,[+|-]Key2[,...]]]
-[\-P|\-\-partial]
-[\-\-rows]
-[\-\-segments]
-[\-\-separator Separator]
-[\-\-unbuffered]
-[\-\-units hHbBsSkKmMgGtTpPeE]
-[\-\-unquoted]
-[\-v|\-\-verbose]
-[\-\-version] [PhysicalVolume [PhysicalVolume...]]
+.RB [ \-a | \-\-all ]
+.RB [ \-\-aligned ]
+.RB [ \-d | \-\-debug ]
+.RB [ \-h | \-? | \-\-help ]
+.RB [ \-\-ignorelockingfailure ]
+.RB [ \-\-nameprefixes ]
+.RB [ \-\-noheadings ]
+.RB [ \-\-nosuffix ]
+.RB [ \-o | \-\-options
+.RI [ + ] Field [ ,Field ...]]
+.RB [ \-O | \-\-sort
+.RI [ + | \- ] Key1 [ , [ + | \- ] Key2 ...]]
+.RB [ \-P | \-\-partial ]
+.RB [ \-\-rows ]
+.RB [ \-\-segments ]
+.RB [ \-\-separator
+.IR Separator ]
+.RB [ \-\-unbuffered ]
+.RB [ \-\-units
+.IR hHbBsSkKmMgGtTpPeE ]
+.RB [ \-\-unquoted ]
+.RB [ \-v|\-\-verbose ]
+.RB [ \-\-version]
+.RI [ PhysicalVolume
+.RI [ PhysicalVolume ...]]
.SH DESCRIPTION
pvs produces formatted output about physical volumes.
.SH OPTIONS
-See \fBlvm\fP for common options.
-\fB\-\-columns\fP.
+See \fBlvm\fP(8) for common options.
.TP
-.I \-\-all
+.B \-\-all
Include information in the output about devices that have not been
-initialized with \fBpvcreate\fP.
+initialized with \fBpvcreate\fP(8).
.TP
-.I \-\-aligned
-Use with \-\-separator to align the output columns.
+.B \-\-aligned
+Use with \fB\-\-separator\fP to align the output columns.
.TP
-.I \-\-nameprefixes
+.B \-\-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 \fBudev (7)\fP rules).
+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
-.I \-\-noheadings
+.B \-\-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.
+.B \-\-nosuffix
+Suppress the suffix on output sizes. Use with \fB\-\-units\fP
+(except h and H) if processing the output.
.TP
-.I \-o, \-\-options
-Comma-separated ordered list of columns. Precede the list with '+' to append
-to the default selection of columns.
+.BR \-o ", " \-\-options
+Comma-separated ordered list of columns. Precede the list with '\fI+\fP'
+to append to the default selection of columns.
.IP
-Use \fb-o pv_all\fP to select all physical volume columns, and \fb-o pvseg_all\fP
-to select all Physical Volume segment columns.
+Use \fB-o pv_all\fP to select all physical volume columns,
+and \fB-o pvseg_all\fP to select all Physical Volume segment columns.
.IP
-Use \fb-o help\fP to view the full list of columns available.
+Use \fB-o help\fP to view the full list of columns available.
.IP
Column names include: pv_fmt, pv_uuid, dev_size, pv_name, pv_mda_free,
pv_mda_size, pe_start, pv_size, pv_free, pv_used, pv_attr, pv_pe_count,
pv_pe_alloc_count, pv_tags, pv_mda_count, pv_mda_used_count,
pvseg_start, and pvseg_size.
.IP
-With --segments, any "pvseg_" prefixes are optional; otherwise any
-"pv_" prefixes are optional. Columns mentioned in \fBvgs (8)\fP can also
+With \fB\-\-segments\fP, any "pvseg_" prefixes are optional; otherwise any
+"pv_" prefixes are optional. Columns mentioned in \fBvgs\fP(8) can also
be chosen. The pv_attr bits are: (a)llocatable, e(x)ported and (m)issing.
.TP
-.I \-\-segments
+.B \-\-segments
Produces one line of output for each contiguous allocation of space on each
Physical Volume, showing the start (pvseg_start) and length (pvseg_size) in
units of physical extents.
.TP
-.I \-O, \-\-sort
+.BR \-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.
+selection. Precede any column with '\fI\-\fP' for a reverse sort on that
+column.
.TP
-.I \-\-rows
+.B \-\-rows
Output columns as rows.
.TP
-.I \-\-separator Separator
+.B \-\-separator \fISeparator
String to use to separate each column. Useful if grepping the output.
.TP
-.I \-\-unbuffered
+.B \-\-unbuffered
Produce output immediately without sorting or aligning the columns properly.
.TP
-.I \-\-units hHbBsSkKmMgGtTpPeE
+.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
+(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
-.I \-\-unquoted
-When used with --nameprefixes, output values in the field=value pairs are not quoted.
+.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 pvdisplay (8),