Import lvm2 from NetBSD
[dragonfly.git] / contrib / lvm2 / dist / man / vgdisplay.8.in
1 .TH VGDISPLAY 8 "LVM TOOLS #VERSION#" "Sistina Software UK" \" -*- nroff -*-
2 .SH NAME
3 vgdisplay \- display attributes of volume groups
4 .SH SYNOPSIS
5 .B vgdisplay
6 .RB [ \-A | \-\-activevolumegroups ]
7 .RB [ \-c | \-\-colon | \-s | \-\-short | \-v|\-\-verbose ]
8 .RB [ \-d | \-\-debug ]
9 .RB [ \-h | \-\-help ]
10 .RB [ \-\-ignorelockingfailure ]
11 .RB [ \-\-nosuffix ]
12 .RB [ \-P | \-\-partial ]
13 .RB [\-\-units hHbBsSkKmMgGtTpPeE]
14 .RB [ \-\-version ]
15 .RI [VolumeGroupName [VolumeGroupName...]]
16 .br
17
18 .br
19 .B vgdisplay \-\-columns | \-C
20 .RB [ \-\-aligned ] [ \-d|\-\-debug ] [ \-h|\-?|\-\-help ]
21 .RB [ \-\-ignorelockingfailure ] [ \-\-noheadings ] [ \-\-nosuffix ]
22 .RB [ \-o|\-\-options [+]Field[,Field] ]
23 .RB [ \-O|\-\-sort [+|-]Key1[,[+|-]Key2[,...]] ]
24 .RB [ \-P|\-\-partial ]
25 .RB [ \-\-separator Separator ]
26 .RB [ \-\-unbuffered ]
27 .RB [ \-\-units hHbBsSkKmMgGtTpPeE ]
28 .RB [ \-v|\-\-verbose ]
29 .RB [ \-\-version ]
30 .RI [VolumeGroupName [VolumeGroupName...]]
31 .SH DESCRIPTION
32 .B vgdisplay
33 allows you to see the attributes of
34 .I VolumeGroupName
35 (or all volume groups if none is given) with it's physical and logical
36 volumes and their sizes etc.
37 .P
38 \fBvgs\fP (8) is an alternative that provides the same information 
39 in the style of \fBps\fP (1).
40 .SH OPTIONS
41 See \fBlvm\fP for common options and \fBvgs\fP for options given with
42 \fB\-\-columns\fP.
43 .TP
44 .BR \-A ", " \-\-activevolumegroups
45 Only select the active volume groups.
46 .TP
47 .BR \-c ", " \-\-colon
48 Generate colon separated output for easier parsing in scripts or programs.
49 N.B. \fBvgs\fP (8) provides considerably more control over the output.
50 .nf
51
52 The values are:
53
54 1  volume group name
55 2  volume group access
56 3  volume group status
57 4  internal volume group number
58 5  maximum number of logical volumes
59 6  current number of logical volumes
60 7  open count of all logical volumes in this volume group
61 8  maximum logical volume size
62 9  maximum number of physical volumes
63 10 current number of physical volumes
64 11 actual number of physical volumes
65 12 size of volume group in kilobytes
66 13 physical extent size
67 14 total number of physical extents for this volume group
68 15 allocated number of physical extents for this volume group
69 16 free number of physical extents for this volume group
70 17 uuid of volume group
71
72 .fi
73 .TP
74 .BR \-s ", " \-\-short
75 Give a short listing showing the existence of volume groups.
76 .TP
77 .BR \-v ", " \-\-verbose
78 Display verbose information containing long listings of physical
79 and logical volumes.  If given twice, also display verbose runtime
80 information of vgdisplay's activities.
81 .TP
82 .BR \-\-version
83 Display version and exit successfully.
84 .TP
85 .BR \-\-columns | \-C
86 Display output in columns, the equivalent of \fBvgs\fP.  Options listed
87 are the same as options given in \fPvgs (8)\fP.
88 .SH SEE ALSO
89 .BR lvm (8),
90 .BR vgs (8),
91 .BR pvcreate (8),
92 .BR vgcreate (8),
93 .BR lvcreate (8)