]> sourceware.org Git - lvm2.git/blame - tools/commands.h
post-release
[lvm2.git] / tools / commands.h
CommitLineData
269930c0 1/*
6606c3ae 2 * Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
be684599 3 * Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
269930c0 4 *
6606c3ae 5 * This file is part of LVM2.
269930c0 6 *
6606c3ae
AK
7 * This copyrighted material is made available to anyone wishing to use,
8 * modify, copy, or redistribute it subject to the terms and conditions
be684599 9 * of the GNU Lesser General Public License v.2.1.
269930c0 10 *
be684599 11 * You should have received a copy of the GNU Lesser General Public License
6606c3ae
AK
12 * along with this program; if not, write to the Free Software Foundation,
13 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
269930c0
AK
14 */
15
5a52dca9
AK
16/*********** Replace with script?
17xx(e2fsadm,
18 "Resize logical volume and ext2 filesystem",
19 "e2fsadm "
20 "[-d|--debug] " "[-h|--help] " "[-n|--nofsck]" "\n"
21 "\t{[-l|--extents] [+|-]LogicalExtentsNumber |" "\n"
a89d6014 22 "\t [-L|--size] [+|-]LogicalVolumeSize[kKmMgGtTpPeE]}" "\n"
5a52dca9
AK
23 "\t[-t|--test] " "\n"
24 "\t[-v|--verbose] " "\n"
25 "\t[--version] " "\n"
26 "\tLogicalVolumePath" "\n",
27
28 extents_ARG, size_ARG, nofsck_ARG, test_ARG)
29*********/
30
dcc31da5
AK
31xx(dumpconfig,
32 "Dump active configuration",
2eeb2a1f
AK
33 "dumpconfig "
34 "\t[-f|--file filename] " "\n"
35 "[ConfigurationVariable...]\n",
36 file_ARG)
dcc31da5 37
156dd4f1
AK
38xx(formats,
39 "List available metadata formats",
40 "formats\n")
41
269930c0
AK
42xx(help,
43 "Display help for commands",
a03f2320 44 "help <command>" "\n")
269930c0 45
677a06d5 46/*********
269930c0
AK
47xx(lvactivate,
48 "Activate logical volume on given partition(s)",
e6efb2b0 49 "lvactivate "
c80325ca
AK
50 "\t[-d|--debug]\n"
51 "\t[-h|--help]\n"
52 "\t[-v|--verbose]\n"
e6efb2b0 53 "Logical Volume(s)\n")
677a06d5 54***********/
269930c0
AK
55
56xx(lvchange,
57 "Change the attributes of logical volume(s)",
58 "lvchange\n"
c80325ca 59 "\t[-A|--autobackup y|n]\n"
d6cf4325 60 "\t[-a|--available [e|l]y|n]\n"
cf6dd251 61 "\t[--addtag Tag]\n"
63bea03e 62 "\t[--alloc AllocationPolicy]\n"
c80325ca
AK
63 "\t[-C|--contiguous y|n]\n"
64 "\t[-d|--debug]\n"
cf6dd251 65 "\t[--deltag Tag]\n"
0b946db9 66 "\t[-f|--force]\n"
c80325ca 67 "\t[-h|--help]\n"
5a52dca9 68 "\t[--ignorelockingfailure]\n"
53c774b9 69 "\t[--ignoremonitoring]\n"
3e3d5d85 70 "\t[--monitor {y|n}]\n"
27f364af 71 "\t[-M|--persistent y|n] [--major major] [--minor minor]\n"
c80325ca
AK
72 "\t[-P|--partial] " "\n"
73 "\t[-p|--permission r|rw]\n"
74 "\t[-r|--readahead ReadAheadSectors]\n"
71b9fadf 75 "\t[--refresh]\n"
99f247f8 76 "\t[--resync]\n"
c80325ca
AK
77 "\t[-t|--test]\n"
78 "\t[-v|--verbose]\n"
04e023be 79 "\t[-y|--yes]\n"
4c64ed4c 80 "\t[--version]" "\n"
269930c0
AK
81 "\tLogicalVolume[Path] [LogicalVolume[Path]...]\n",
82
a0a23eff 83 alloc_ARG, autobackup_ARG, available_ARG, contiguous_ARG, force_ARG,
53c774b9
AK
84 ignorelockingfailure_ARG, ignoremonitoring_ARG, major_ARG, minor_ARG,
85 monitor_ARG, partial_ARG, permission_ARG, persistent_ARG, readahead_ARG,
86 resync_ARG, refresh_ARG, addtag_ARG, deltag_ARG, test_ARG, yes_ARG)
269930c0 87
1a1f3d3e
AK
88xx(lvconvert,
89 "Change logical volume layout",
1c8b86c7 90 "lvconvert "
edb3374d 91 "[-m|--mirrors Mirrors [{--mirrorlog {disk|core}|--corelog}]]\n"
b42eb4c3 92 "\t[-R|--regionsize MirrorLogRegionSize]\n"
1a1f3d3e
AK
93 "\t[--alloc AllocationPolicy]\n"
94 "\t[-d|--debug]\n"
95 "\t[-h|-?|--help]\n"
1a1f3d3e
AK
96 "\t[-v|--verbose]\n"
97 "\t[--version]" "\n"
1c8b86c7
AK
98 "\tLogicalVolume[Path] [PhysicalVolume[Path]...]\n\n"
99
100 "lvconvert "
101 "[-s|--snapshot]\n"
102 "\t[-c|--chunksize]\n"
103 "\t[-d|--debug]\n"
104 "\t[-h|-?|--help]\n"
105 "\t[-v|--verbose]\n"
106 "\t[-Z|--zero {y|n}]\n"
107 "\t[--version]" "\n"
108 "\tOriginalLogicalVolume[Path] SnapshotLogicalVolume[Path]\n",
1a1f3d3e 109
edb3374d 110 alloc_ARG, chunksize_ARG, corelog_ARG, mirrorlog_ARG, mirrors_ARG,
19583d11 111 regionsize_ARG, snapshot_ARG, test_ARG, zero_ARG)
1a1f3d3e 112
269930c0
AK
113xx(lvcreate,
114 "Create a logical volume",
03888774 115 "lvcreate " "\n"
0eb83127 116 "\t[-A|--autobackup {y|n}]\n"
cf6dd251 117 "\t[--addtag Tag]\n"
63bea03e 118 "\t[--alloc AllocationPolicy]\n"
0eb83127
JT
119 "\t[-C|--contiguous {y|n}]\n"
120 "\t[-d|--debug]\n"
c80325ca 121 "\t[-h|-?|--help]\n"
0eb83127
JT
122 "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
123 "\t{-l|--extents LogicalExtentsNumber |\n"
a89d6014 124 "\t -L|--size LogicalVolumeSize[kKmMgGtTpPeE]}\n"
27f364af 125 "\t[-M|--persistent {y|n}] [--major major] [--minor minor]\n"
edb3374d 126 "\t[-m|--mirrors Mirrors [--nosync] [{--mirrorlog {disk|core}|--corelog}]]\n"
0eb83127
JT
127 "\t[-n|--name LogicalVolumeName]\n"
128 "\t[-p|--permission {r|rw}]\n"
129 "\t[-r|--readahead ReadAheadSectors]\n"
60f13f01 130 "\t[-R|--regionsize MirrorLogRegionSize]\n"
0eb83127 131 "\t[-t|--test]\n"
1832f310 132 "\t[--type VolumeType]\n"
0eb83127
JT
133 "\t[-v|--verbose]\n"
134 "\t[-Z|--zero {y|n}]\n"
135 "\t[--version]\n"
c80325ca 136 "\tVolumeGroupName [PhysicalVolumePath...]\n\n"
8b46b545 137
c80325ca 138 "lvcreate -s|--snapshot\n"
8b46b545
HM
139 "\t[-c|--chunksize]\n"
140 "\t[-A|--autobackup {y|n}]\n"
cf6dd251 141 "\t[--addtag Tag]\n"
63bea03e 142 "\t[--alloc AllocationPolicy]\n"
8b46b545
HM
143 "\t[-C|--contiguous {y|n}]\n"
144 "\t[-d|--debug]\n"
c80325ca 145 "\t[-h|-?|--help]\n"
8b46b545 146 "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
34fadac4 147 "\t{-l|--extents LogicalExtentsNumber[%{VG|LV|FREE}] |\n"
a89d6014 148 "\t -L|--size LogicalVolumeSize[kKmMgGtTpPeE]}\n"
27f364af 149 "\t[-M|--persistent {y|n}] [--major major] [--minor minor]\n"
8b46b545
HM
150 "\t[-n|--name LogicalVolumeName]\n"
151 "\t[-p|--permission {r|rw}]\n"
152 "\t[-r|--readahead ReadAheadSectors]\n"
153 "\t[-t|--test]\n"
154 "\t[-v|--verbose]\n"
155 "\t[--version]\n"
156 "\tOriginalLogicalVolume[Path] [PhysicalVolumePath...]\n\n",
a03f2320 157
a0a23eff 158 addtag_ARG, alloc_ARG, autobackup_ARG, chunksize_ARG, contiguous_ARG,
edb3374d
AK
159 corelog_ARG, extents_ARG, major_ARG, minor_ARG, mirrorlog_ARG, mirrors_ARG,
160 name_ARG, nosync_ARG, permission_ARG, persistent_ARG, readahead_ARG,
161 regionsize_ARG, size_ARG, snapshot_ARG, stripes_ARG, stripesize_ARG,
162 test_ARG, type_ARG, zero_ARG)
269930c0
AK
163
164xx(lvdisplay,
165 "Display information about a logical volume",
166 "lvdisplay\n"
8211a13c 167 "\t[-a|--all]\n"
c80325ca
AK
168 "\t[-c|--colon]\n"
169 "\t[-d|--debug]\n"
170 "\t[-h|--help]\n"
8b46b545 171 "\t[--ignorelockingfailure]\n"
c80325ca 172 "\t[-m|--maps]\n"
4c64ed4c 173 "\t[--nosuffix]\n"
c80325ca 174 "\t[-P|--partial] " "\n"
4c64ed4c 175 "\t[--units hsbkmgtHKMGT]\n"
c80325ca 176 "\t[-v|--verbose]\n"
4c64ed4c
AK
177 "\t[--version]" "\n"
178 "\t[LogicalVolume[Path] [LogicalVolume[Path]...]]\n"
179 "\n"
180 "lvdisplay --columns|-C\n"
181 "\t[--aligned]\n"
8211a13c 182 "\t[-a|--all]\n"
4c64ed4c
AK
183 "\t[-d|--debug]\n"
184 "\t[-h|--help]\n"
185 "\t[--ignorelockingfailure]\n"
186 "\t[--noheadings]\n"
187 "\t[--nosuffix]\n"
188 "\t[-o|--options [+]Field[,Field]]\n"
189 "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
190 "\t[-P|--partial] " "\n"
191 "\t[--segments]\n"
192 "\t[--separator Separator]\n"
193 "\t[--unbuffered]\n"
194 "\t[--units hsbkmgtHKMGT]\n"
195 "\t[-v|--verbose]\n"
196 "\t[--version]" "\n"
197 "\t[LogicalVolume[Path] [LogicalVolume[Path]...]]\n",
269930c0 198
8211a13c
AK
199 aligned_ARG, all_ARG, colon_ARG, columns_ARG, disk_ARG,
200 ignorelockingfailure_ARG, maps_ARG, noheadings_ARG, nosuffix_ARG,
201 options_ARG, sort_ARG, partial_ARG, segments_ARG, separator_ARG,
202 unbuffered_ARG, units_ARG)
269930c0
AK
203
204xx(lvextend,
205 "Add space to a logical volume",
206 "lvextend\n"
c80325ca 207 "\t[-A|--autobackup y|n]\n"
63bea03e 208 "\t[--alloc AllocationPolicy]\n"
c80325ca
AK
209 "\t[-d|--debug]\n"
210 "\t[-h|--help]\n"
52dc2139 211 "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
34fadac4 212 "\t{-l|--extents [+]LogicalExtentsNumber[%{VG|FREE}] |\n"
a89d6014 213 "\t -L|--size [+]LogicalVolumeSize[kKmMgGtTpPeE]}\n"
ffb0e538 214 "\t[-m|--mirrors Mirrors]\n"
1a9ea74d
AK
215 "\t[-n|--nofsck]\n"
216 "\t[-r|--resizefs]\n"
c80325ca 217 "\t[-t|--test]\n"
1832f310 218 "\t[--type VolumeType]\n"
c80325ca 219 "\t[-v|--verbose]\n"
4c64ed4c 220 "\t[--version]" "\n"
269930c0
AK
221 "\tLogicalVolume[Path] [ PhysicalVolumePath... ]\n",
222
ffb0e538
AK
223 alloc_ARG, autobackup_ARG, extents_ARG, mirrors_ARG, nofsck_ARG,
224 resizefs_ARG, size_ARG, stripes_ARG, stripesize_ARG, test_ARG,
225 type_ARG)
269930c0
AK
226
227xx(lvmchange,
a03f2320 228 "With the device mapper, this is obsolete and does nothing.",
03888774 229 "lvmchange\n"
c80325ca
AK
230 "\t[-d|--debug]\n"
231 "\t[-h|--help]\n"
232 "\t[-R|--reset]\n"
4c64ed4c
AK
233 "\t[-v|--verbose]\n"
234 "\t[--version]" "\n",
269930c0 235
a03f2320 236 reset_ARG)
269930c0
AK
237
238xx(lvmdiskscan,
239 "List devices that may be used as physical volumes",
240 "lvmdiskscan\n"
c80325ca
AK
241 "\t[-d|--debug]\n"
242 "\t[-h|--help]\n"
4c64ed4c
AK
243 "\t[-l|--lvmpartition]\n"
244 "\t[--version]" "\n",
269930c0
AK
245
246 lvmpartition_ARG)
247
248xx(lvmsadc,
249 "Collect activity data",
250 "lvmsadc\n"
c80325ca
AK
251 "\t[-d|--debug]\n"
252 "\t[-h|--help]\n"
253 "\t[-v|--verbose]\n"
4c64ed4c 254 "\t[--version]" "\n"
269930c0
AK
255 "\t[LogFilePath]\n" )
256
257xx(lvmsar,
258 "Create activity report",
259 "lvmsar\n"
c80325ca
AK
260 "\t[-d|--debug]\n"
261 "\t[-f|--full]\n"
262 "\t[-h|--help]\n"
263 "\t[-s|--stdin]\n"
264 "\t[-v|--verbose]\n"
4c64ed4c 265 "\t[--version]" "\n"
269930c0
AK
266 "\tLogFilePath\n",
267
8b46b545 268 full_ARG, stdin_ARG)
269930c0
AK
269
270xx(lvreduce,
271 "Reduce the size of a logical volume",
272 "lvreduce\n"
c80325ca
AK
273 "\t[-A|--autobackup y|n]\n"
274 "\t[-d|--debug]\n"
275 "\t[-f|--force]\n"
276 "\t[-h|--help]\n"
34fadac4 277 "\t{-l|--extents [-]LogicalExtentsNumber[%{VG|LV|FREE}] |\n"
a89d6014 278 "\t -L|--size [-]LogicalVolumeSize[kKmMgGtTpPeE]}\n"
1a9ea74d
AK
279 "\t[-n|--nofsck]\n"
280 "\t[-r|--resizefs]\n"
c80325ca
AK
281 "\t[-t|--test]\n"
282 "\t[-v|--verbose]\n"
04e023be 283 "\t[-y|--yes]\n"
4c64ed4c 284 "\t[--version]" "\n"
269930c0
AK
285 "\tLogicalVolume[Path]\n",
286
1a9ea74d 287 autobackup_ARG, force_ARG, extents_ARG, nofsck_ARG, resizefs_ARG,
c2d72fd4 288 size_ARG, test_ARG, yes_ARG)
269930c0
AK
289
290xx(lvremove,
291 "Remove logical volume(s) from the system",
292 "lvremove\n"
c80325ca
AK
293 "\t[-A|--autobackup y|n]\n"
294 "\t[-d|--debug]\n"
295 "\t[-f|--force]\n"
296 "\t[-h|--help]\n"
297 "\t[-t|--test]\n"
298 "\t[-v|--verbose]\n"
4c64ed4c 299 "\t[--version]" "\n"
269930c0
AK
300 "\tLogicalVolume[Path] [LogicalVolume[Path]...]\n",
301
c2d72fd4 302 autobackup_ARG, force_ARG, test_ARG)
269930c0
AK
303
304xx(lvrename,
305 "Rename a logical volume",
306 "lvrename "
a03f2320
AK
307 "\t[-A|--autobackup {y|n}] " "\n"
308 "\t[-d|--debug] " "\n"
c80325ca 309 "\t[-h|-?|--help] " "\n"
a03f2320
AK
310 "\t[-t|--test] " "\n"
311 "\t[-v|--verbose]" "\n"
312 "\t[--version] " "\n"
313 "\t{ OldLogicalVolumePath NewLogicalVolumePath |" "\n"
314 "\t VolumeGroupName OldLogicalVolumeName NewLogicalVolumeName }\n",
269930c0 315
c2d72fd4 316 autobackup_ARG, test_ARG)
269930c0 317
03a8a07d
AK
318xx(lvresize,
319 "Resize a logical volume",
320 "lvresize\n"
c80325ca 321 "\t[-A|--autobackup y|n]\n"
63bea03e 322 "\t[--alloc AllocationPolicy]\n"
c80325ca
AK
323 "\t[-d|--debug]\n"
324 "\t[-h|--help]\n"
52dc2139 325 "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
34fadac4 326 "\t{-l|--extents [+|-]LogicalExtentsNumber[%{VG|LV|FREE}] |\n"
a89d6014 327 "\t -L|--size [+|-]LogicalVolumeSize[kKmMgGtTpPeE]}\n"
1a9ea74d
AK
328 "\t[-n|--nofsck]\n"
329 "\t[-r|--resizefs]\n"
c2d72fd4 330 "\t[-t|--test]\n"
1832f310 331 "\t[--type VolumeType]\n"
c80325ca 332 "\t[-v|--verbose]\n"
4c64ed4c 333 "\t[--version]" "\n"
03a8a07d
AK
334 "\tLogicalVolume[Path] [ PhysicalVolumePath... ]\n",
335
1a9ea74d
AK
336 alloc_ARG, autobackup_ARG, extents_ARG, nofsck_ARG, resizefs_ARG,
337 size_ARG, stripes_ARG, stripesize_ARG, test_ARG, type_ARG)
03a8a07d 338
4c64ed4c
AK
339xx(lvs,
340 "Display information about logical volumes",
341 "lvs" "\n"
8211a13c 342 "\t[-a|--all]\n"
4c64ed4c
AK
343 "\t[--aligned]\n"
344 "\t[-d|--debug]\n"
345 "\t[-h|--help]\n"
346 "\t[--ignorelockingfailure]\n"
347 "\t[--noheadings]\n"
348 "\t[--nosuffix]\n"
349 "\t[-o|--options [+]Field[,Field]]\n"
350 "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
351 "\t[-P|--partial] " "\n"
352 "\t[--segments]\n"
353 "\t[--separator Separator]\n"
e3ad1d19 354 "\t[--trustcache]\n"
4c64ed4c
AK
355 "\t[--unbuffered]\n"
356 "\t[--units hsbkmgtHKMGT]\n"
357 "\t[-v|--verbose]\n"
358 "\t[--version]" "\n"
359 "\t[LogicalVolume[Path] [LogicalVolume[Path]...]]\n",
3e3d5d85 360
8211a13c
AK
361 aligned_ARG, all_ARG, ignorelockingfailure_ARG, noheadings_ARG,
362 nolocking_ARG, nosuffix_ARG, options_ARG, partial_ARG, segments_ARG,
e3ad1d19 363 separator_ARG, sort_ARG, trustcache_ARG, unbuffered_ARG, units_ARG)
4c64ed4c 364
269930c0
AK
365xx(lvscan,
366 "List all logical volumes in all volume groups",
a03f2320 367 "lvscan " "\n"
191abde9 368 "\t[-a|--all]\n"
a03f2320
AK
369 "\t[-b|--blockdevice] " "\n"
370 "\t[-d|--debug] " "\n"
c80325ca 371 "\t[-h|-?|--help] " "\n"
8b46b545 372 "\t[--ignorelockingfailure]\n"
6b4c9ff7 373 "\t[-P|--partial] " "\n"
a03f2320
AK
374 "\t[-v|--verbose] " "\n"
375 "\t[--version]\n",
269930c0 376
191abde9 377 all_ARG, blockdevice_ARG, disk_ARG, ignorelockingfailure_ARG, partial_ARG)
269930c0
AK
378
379xx(pvchange,
380 "Change attributes of physical volume(s)",
381 "pvchange\n"
15e6db35 382 "\t[-a|--all]\n"
c80325ca
AK
383 "\t[-A|--autobackup y|n]\n"
384 "\t[-d|--debug]\n"
385 "\t[-h|--help]\n"
c2d72fd4 386 "\t[-t|--test]\n"
15e6db35 387 "\t[-u|--uuid]\n"
c80325ca 388 "\t[-x|--allocatable y|n]\n"
15e6db35 389 "\t[-v|--verbose]\n"
cf6dd251
AK
390 "\t[--addtag Tag]\n"
391 "\t[--deltag Tag]\n"
15e6db35 392 "\t[--version]" "\n"
269930c0
AK
393 "\t[PhysicalVolumePath...]\n",
394
cf6dd251
AK
395 all_ARG, allocatable_ARG, allocation_ARG, autobackup_ARG, deltag_ARG,
396 addtag_ARG, test_ARG, uuid_ARG)
269930c0 397
3bf5f6f5
AK
398xx(pvresize,
399 "Resize physical volume(s)",
400 "pvresize " "\n"
401 "\t[-d|--debug]" "\n"
402 "\t[-h|-?|--help] " "\n"
a89d6014 403 "\t[--setphysicalvolumesize PhysicalVolumeSize[kKmMgGtTpPeE]" "\n"
3bf5f6f5
AK
404 "\t[-t|--test] " "\n"
405 "\t[-v|--verbose] " "\n"
406 "\t[--version] " "\n"
407 "\tPhysicalVolume [PhysicalVolume...]\n",
408
409 physicalvolumesize_ARG, test_ARG)
410
cc5a4e1d
DW
411xx(pvck,
412 "Check the consistency of physical volume(s)",
413 "pvck "
414 "\t[-d|--debug]\n"
415 "\t[-h|--help]\n"
d915579c 416 "\t[--labelsector sector] " "\n"
cc5a4e1d
DW
417 "\t[-v|--verbose]\n"
418 "\t[--version]" "\n"
d915579c
DW
419 "\tPhysicalVolume [PhysicalVolume...]\n",
420
421 labelsector_ARG)
cc5a4e1d 422
269930c0
AK
423xx(pvcreate,
424 "Initialize physical volume(s) for use by LVM",
a03f2320 425 "pvcreate " "\n"
5a52dca9 426 "\t[--restorefile file]\n"
a03f2320
AK
427 "\t[-d|--debug]" "\n"
428 "\t[-f[f]|--force [--force]] " "\n"
c80325ca 429 "\t[-h|-?|--help] " "\n"
5a52dca9
AK
430 "\t[--labelsector sector] " "\n"
431 "\t[-M|--metadatatype 1|2]" "\n"
432 "\t[--metadatacopies #copies]" "\n"
a89d6014
AK
433 "\t[--metadatasize MetadataSize[kKmMgGtTpPeE]]" "\n"
434 "\t[--setphysicalvolumesize PhysicalVolumeSize[kKmMgGtTpPeE]" "\n"
a03f2320 435 "\t[-t|--test] " "\n"
add7dc2d 436 "\t[-u|--uuid uuid] " "\n"
a03f2320 437 "\t[-v|--verbose] " "\n"
5a52dca9 438 "\t[-y|--yes]" "\n"
2245e1c4 439 "\t[-Z|--zero {y|n}]\n"
a03f2320
AK
440 "\t[--version] " "\n"
441 "\tPhysicalVolume [PhysicalVolume...]\n",
269930c0 442
5a52dca9
AK
443 force_ARG, test_ARG, labelsector_ARG, metadatatype_ARG, metadatacopies_ARG,
444 metadatasize_ARG, physicalvolumesize_ARG, restorefile_ARG, uuidstr_ARG,
2245e1c4 445 yes_ARG, zero_ARG)
269930c0
AK
446
447xx(pvdata,
448 "Display the on-disk metadata for physical volume(s)",
a03f2320
AK
449 "pvdata " "\n"
450 "\t[-a|--all] " "\n"
451 "\t[-d|--debug] " "\n"
452 "\t[-E|--physicalextent] " "\n"
c80325ca 453 "\t[-h|-?|--help]" "\n"
a03f2320
AK
454 "\t[-L|--logicalvolume] " "\n"
455 "\t[-P[P]|--physicalvolume [--physicalvolume]]" "\n"
456 "\t[-U|--uuidlist] " "\n"
457 "\t[-v[v]|--verbose [--verbose]] " "\n"
458 "\t[-V|--volumegroup]" "\n"
459 "\t[--version] " "\n"
460 "\tPhysicalVolume [PhysicalVolume...]\n",
269930c0
AK
461
462 all_ARG, logicalextent_ARG, physicalextent_ARG,
463 physicalvolume_ARG, uuidlist_ARG, volumegroup_ARG)
464
465xx(pvdisplay,
4c64ed4c 466 "Display various attributes of physical volume(s)",
269930c0 467 "pvdisplay\n"
c80325ca
AK
468 "\t[-c|--colon]\n"
469 "\t[-d|--debug]\n"
470 "\t[-h|--help]\n"
8b46b545 471 "\t[--ignorelockingfailure]\n"
c80325ca 472 "\t[-m|--maps]\n"
4c64ed4c 473 "\t[--nosuffix]\n"
c80325ca 474 "\t[-s|--short]\n"
4c64ed4c 475 "\t[--units hsbkmgtHKMGT]\n"
c80325ca 476 "\t[-v|--verbose]\n"
4c64ed4c
AK
477 "\t[--version]" "\n"
478 "\t[PhysicalVolumePath [PhysicalVolumePath...]]\n"
479 "\n"
480 "pvdisplay --columns|-C\n"
481 "\t[--aligned]\n"
200ef4db 482 "\t[-a|--all]\n"
4c64ed4c
AK
483 "\t[-d|--debug]\n"
484 "\t[-h|--help]\n"
485 "\t[--ignorelockingfailure]\n"
486 "\t[--noheadings]\n"
487 "\t[--nosuffix]\n"
488 "\t[-o|--options [+]Field[,Field]]\n"
489 "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
490 "\t[--separator Separator]\n"
491 "\t[--unbuffered]\n"
492 "\t[--units hsbkmgtHKMGT]\n"
493 "\t[-v|--verbose]\n"
494 "\t[--version]" "\n"
495 "\t[PhysicalVolumePath [PhysicalVolumePath...]]\n",
269930c0 496
200ef4db
AK
497 aligned_ARG, all_ARG, colon_ARG, columns_ARG, ignorelockingfailure_ARG,
498 maps_ARG, noheadings_ARG, nosuffix_ARG, options_ARG, separator_ARG,
499 short_ARG, sort_ARG, unbuffered_ARG, units_ARG)
269930c0 500
269930c0
AK
501xx(pvmove,
502 "Move extents from one physical volume to another",
43ecb8ff 503 "pvmove " "\n"
3a61b054 504 "\t[--abort]\n"
43ecb8ff 505 "\t[-A|--autobackup {y|n}]\n"
63bea03e 506 "\t[--alloc AllocationPolicy]\n"
3a61b054 507 "\t[-b|--background]\n"
43ecb8ff 508 "\t[-d|--debug]\n "
43ecb8ff
AK
509 "\t[-h|-?|--help]\n"
510 "\t[-i|--interval seconds]\n"
511 "\t[-t|--test]\n "
512 "\t[-v|--verbose]\n "
513 "\t[--version]\n"
57c74fb5 514 "\t[{-n|--name} LogicalVolume]\n"
43ecb8ff 515/* "\t[{-n|--name} LogicalVolume[:LogicalExtent[-LogicalExtent]...]]\n" */
9bd40d31 516 "\tSourcePhysicalVolume[:PhysicalExtent[-PhysicalExtent]...]}\n"
43ecb8ff 517 "\t[DestinationPhysicalVolume[:PhysicalExtent[-PhysicalExtent]...]...]\n",
269930c0 518
3e3d5d85 519 abort_ARG, alloc_ARG, autobackup_ARG, background_ARG,
00b47204 520 interval_ARG, name_ARG, test_ARG)
269930c0 521
5a52dca9
AK
522xx(pvremove,
523 "Remove LVM label(s) from physical volume(s)",
524 "pvremove " "\n"
525 "\t[-d|--debug]" "\n"
526 "\t[-f[f]|--force [--force]] " "\n"
c80325ca 527 "\t[-h|-?|--help] " "\n"
5a52dca9
AK
528 "\t[-t|--test] " "\n"
529 "\t[-v|--verbose] " "\n"
530 "\t[-y|--yes]" "\n"
531 "\t[--version] " "\n"
532 "\tPhysicalVolume [PhysicalVolume...]\n",
533
534 force_ARG, test_ARG, yes_ARG)
535
4c64ed4c
AK
536xx(pvs,
537 "Display information about physical volumes",
538 "pvs" "\n"
539 "\t[--aligned]\n"
c29d2465 540 "\t[-a|--all]\n"
4c64ed4c
AK
541 "\t[-d|--debug]" "\n"
542 "\t[-h|-?|--help] " "\n"
543 "\t[--noheadings]\n"
544 "\t[--ignorelockingfailure]\n"
545 "\t[--nosuffix]\n"
546 "\t[-o|--options [+]Field[,Field]]\n"
547 "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
f855ac38 548 "\t[-P|--partial] " "\n"
c54a9405 549 "\t[--segments]\n"
4c64ed4c 550 "\t[--separator Separator]\n"
e3ad1d19 551 "\t[--trustcache]\n"
4c64ed4c
AK
552 "\t[--unbuffered]\n"
553 "\t[--units hsbkmgtHKMGT]\n"
554 "\t[-v|--verbose]\n"
555 "\t[--version]\n"
556 "\t[PhysicalVolume [PhysicalVolume...]]\n",
3e3d5d85 557
c29d2465 558 aligned_ARG, all_ARG, ignorelockingfailure_ARG, noheadings_ARG,
f855ac38 559 nolocking_ARG, nosuffix_ARG, options_ARG, partial_ARG, segments_ARG,
e3ad1d19 560 separator_ARG, sort_ARG, trustcache_ARG, unbuffered_ARG, units_ARG)
4c64ed4c 561
269930c0
AK
562xx(pvscan,
563 "List all physical volumes",
a03f2320
AK
564 "pvscan " "\n"
565 "\t[-d|--debug] " "\n"
c80325ca
AK
566 "\t{-e|--exported | -n|--novolumegroup} " "\n"
567 "\t[-h|-?|--help]" "\n"
8b46b545 568 "\t[--ignorelockingfailure]\n"
6b4c9ff7 569 "\t[-P|--partial] " "\n"
a03f2320
AK
570 "\t[-s|--short] " "\n"
571 "\t[-u|--uuid] " "\n"
572 "\t[-v|--verbose] " "\n"
573 "\t[--version]\n",
269930c0 574
8b46b545
HM
575 exported_ARG, ignorelockingfailure_ARG, novolumegroup_ARG, partial_ARG,
576 short_ARG, uuid_ARG)
269930c0 577
156dd4f1
AK
578xx(segtypes,
579 "List available segment types",
580 "segtypes\n")
581
269930c0
AK
582xx(vgcfgbackup,
583 "Backup volume group configuration(s)",
a03f2320
AK
584 "vgcfgbackup " "\n"
585 "\t[-d|--debug] " "\n"
952d12a5 586 "\t[-f|--file filename] " "\n"
c80325ca 587 "\t[-h|-?|--help] " "\n"
8b46b545 588 "\t[--ignorelockingfailure]\n"
407332cb 589 "\t[-P|--partial] " "\n"
a03f2320 590 "\t[-v|--verbose]" "\n"
4c64ed4c 591 "\t[--version] " "\n"
2041d905 592 "\t[VolumeGroupName...]\n",
8b46b545
HM
593
594 file_ARG, ignorelockingfailure_ARG, partial_ARG)
269930c0
AK
595
596xx(vgcfgrestore,
597 "Restore volume group configuration",
a03f2320
AK
598 "vgcfgrestore " "\n"
599 "\t[-d|--debug] " "\n"
952d12a5 600 "\t[-f|--file filename] " "\n"
a03f2320 601 "\t[-l[l]|--list [--list]]" "\n"
5a52dca9 602 "\t[-M|--metadatatype 1|2]" "\n"
a03f2320
AK
603 "\t[-n|--name VolumeGroupName] " "\n"
604 "\t[-h|--help]" "\n"
a03f2320
AK
605 "\t[-t|--test] " "\n"
606 "\t[-v|--verbose]" "\n"
607 "\t[--version] " "\n"
288adea2 608 "\tVolumeGroupName",
269930c0 609
5a52dca9 610 file_ARG, list_ARG, metadatatype_ARG, name_ARG, test_ARG)
269930c0
AK
611
612xx(vgchange,
613 "Change volume group attributes",
a03f2320
AK
614 "vgchange" "\n"
615 "\t[-A|--autobackup {y|n}] " "\n"
63bea03e 616 "\t[--alloc AllocationPolicy] " "\n"
f53c6aa6 617 "\t[-P|--partial] " "\n"
a03f2320
AK
618 "\t[-d|--debug] " "\n"
619 "\t[-h|--help] " "\n"
8b46b545 620 "\t[--ignorelockingfailure]\n"
53c774b9 621 "\t[--ignoremonitoring]\n"
3e3d5d85 622 "\t[--monitor {y|n}]\n"
a03f2320 623 "\t[-t|--test]" "\n"
15e6db35 624 "\t[-u|--uuid] " "\n"
a03f2320
AK
625 "\t[-v|--verbose] " "\n"
626 "\t[--version]" "\n"
d6cf4325 627 "\t{-a|--available [e|l]{y|n} |" "\n"
343a8c92 628 "\t -c|--clustered {y|n} |" "\n"
b80f32dd 629 "\t -x|--resizeable {y|n} |" "\n"
cf6dd251 630 "\t -l|--logicalvolume MaxLogicalVolumes |" "\n"
e95d8284 631 "\t -p|--maxphysicalvolumes MaxPhysicalVolumes |" "\n"
a89d6014 632 "\t -s|--physicalextentsize PhysicalExtentSize[kKmMgGtTpPeE] |" "\n"
cf6dd251
AK
633 "\t --addtag Tag |\n"
634 "\t --deltag Tag}\n"
a03f2320 635 "\t[VolumeGroupName...]\n",
269930c0 636
a0a23eff 637 addtag_ARG, alloc_ARG, allocation_ARG, autobackup_ARG, available_ARG,
53c774b9
AK
638 clustered_ARG, deltag_ARG, ignorelockingfailure_ARG, ignoremonitoring_ARG,
639 logicalvolume_ARG, maxphysicalvolumes_ARG, monitor_ARG, partial_ARG,
640 physicalextentsize_ARG, resizeable_ARG, resizable_ARG, test_ARG, uuid_ARG)
269930c0
AK
641
642xx(vgck,
643 "Check the consistency of volume group(s)",
644 "vgck "
c80325ca
AK
645 "\t[-d|--debug]\n"
646 "\t[-h|--help]\n"
647 "\t[-v|--verbose]\n"
43ecb8ff 648 "\t[--version]" "\n"
269930c0
AK
649 "\t[VolumeGroupName...]\n" )
650
5a52dca9
AK
651xx(vgconvert,
652 "Change volume group metadata format",
653 "vgconvert " "\n"
654 "\t[-d|--debug]" "\n"
655 "\t[-h|--help] " "\n"
656 "\t[--labelsector sector] " "\n"
657 "\t[-M|--metadatatype 1|2]" "\n"
658 "\t[--metadatacopies #copies]" "\n"
a89d6014 659 "\t[--metadatasize MetadataSize[kKmMgGtTpPeE]]" "\n"
5a52dca9
AK
660 "\t[-t|--test] " "\n"
661 "\t[-v|--verbose] " "\n"
662 "\t[--version] " "\n"
663 "\tVolumeGroupName [VolumeGroupName...]\n",
664
665 force_ARG, test_ARG, labelsector_ARG, metadatatype_ARG, metadatacopies_ARG,
666 metadatasize_ARG )
667
269930c0
AK
668xx(vgcreate,
669 "Create a volume group",
a03f2320
AK
670 "vgcreate" "\n"
671 "\t[-A|--autobackup {y|n}] " "\n"
cf6dd251 672 "\t[--addtag Tag] " "\n"
63bea03e 673 "\t[--alloc AllocationPolicy] " "\n"
147b7d5e 674 "\t[-c|--clustered {y|n}] " "\n"
a03f2320 675 "\t[-d|--debug]" "\n"
25b73380 676 "\t[-h|--help]" "\n"
a03f2320 677 "\t[-l|--maxlogicalvolumes MaxLogicalVolumes]" "\n"
5a52dca9 678 "\t[-M|--metadatatype 1|2] " "\n"
a03f2320 679 "\t[-p|--maxphysicalvolumes MaxPhysicalVolumes] " "\n"
a89d6014 680 "\t[-s|--physicalextentsize PhysicalExtentSize[kKmMgGtTpPeE]] " "\n"
a03f2320
AK
681 "\t[-t|--test] " "\n"
682 "\t[-v|--verbose]" "\n"
683 "\t[--version] " "\n"
684 "\tVolumeGroupName PhysicalVolume [PhysicalVolume...]\n",
269930c0 685
343a8c92 686 addtag_ARG, alloc_ARG, autobackup_ARG, clustered_ARG, maxlogicalvolumes_ARG,
a0a23eff 687 maxphysicalvolumes_ARG, metadatatype_ARG, physicalextentsize_ARG, test_ARG)
269930c0
AK
688
689xx(vgdisplay,
690 "Display volume group information",
a03f2320
AK
691 "vgdisplay " "\n"
692 "\t[-c|--colon | -s|--short | -v|--verbose]" "\n"
693 "\t[-d|--debug] " "\n"
694 "\t[-h|--help] " "\n"
5a52dca9 695 "\t[--ignorelockingfailure]" "\n"
4c64ed4c 696 "\t[--nosuffix]\n"
7ae5a778 697 "\t[-P|--partial] " "\n"
4c64ed4c 698 "\t[--units hsbkmgtHKMGT]\n"
a03f2320 699 "\t[-A|--activevolumegroups | [-D|--disk]" "\n"
7ae5a778 700 "\t[--version]" "\n"
4c64ed4c
AK
701 "\t[VolumeGroupName [VolumeGroupName...]]\n"
702 "\n"
703 "vgdisplay --columns|-C\n"
704 "\t[--aligned]\n"
705 "\t[-d|--debug] " "\n"
706 "\t[-h|--help] " "\n"
707 "\t[--ignorelockingfailure]" "\n"
708 "\t[--noheadings]\n"
709 "\t[--nosuffix]\n"
710 "\t[-o|--options [+]Field[,Field]]\n"
711 "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
712 "\t[-P|--partial] " "\n"
713 "\t[--separator Separator]\n"
714 "\t[--unbuffered]\n"
715 "\t[--units hsbkmgtHKMGT]\n"
716 "\t[--verbose]" "\n"
717 "\t[--version]" "\n"
718 "\t[VolumeGroupName [VolumeGroupName...]]\n",
269930c0 719
4c64ed4c
AK
720 activevolumegroups_ARG, aligned_ARG, colon_ARG, columns_ARG, disk_ARG,
721 ignorelockingfailure_ARG, noheadings_ARG, nosuffix_ARG, options_ARG,
bc0d0ce0 722 partial_ARG, short_ARG, separator_ARG, sort_ARG, unbuffered_ARG, units_ARG)
269930c0
AK
723
724xx(vgexport,
725 "Unregister volume group(s) from the system",
a03f2320
AK
726 "vgexport " "\n"
727 "\t[-a|--all] " "\n"
728 "\t[-d|--debug] " "\n"
729 "\t[-h|--help]" "\n"
730 "\t[-v|--verbose] " "\n"
731 "\t[--version] " "\n"
732 "\tVolumeGroupName [VolumeGroupName...]\n",
269930c0 733
c2d72fd4 734 all_ARG, test_ARG)
269930c0
AK
735
736xx(vgextend,
737 "Add physical volumes to a volume group",
738 "vgextend\n"
c80325ca
AK
739 "\t[-A|--autobackup y|n]\n"
740 "\t[-d|--debug]\n"
741 "\t[-h|--help]\n"
742 "\t[-t|--test]\n"
743 "\t[-v|--verbose]\n"
4c64ed4c 744 "\t[--version]" "\n"
a03f2320 745 "\tVolumeGroupName PhysicalDevicePath [PhysicalDevicePath...]\n",
269930c0 746
c2d72fd4 747 autobackup_ARG, test_ARG)
269930c0
AK
748
749xx(vgimport,
750 "Register exported volume group with system",
a03f2320 751 "vgimport " "\n"
c80325ca 752 "\t[-a|--all]\n"
a03f2320
AK
753 "\t[-d|--debug] " "\n"
754 "\t[-f|--force] " "\n"
755 "\t[-h|--help] " "\n"
756 "\t[-t|--test] " "\n"
757 "\t[-v|--verbose]" "\n"
4c64ed4c 758 "\t[--version]" "\n"
df91af91 759 "\tVolumeGroupName..." "\n",
269930c0 760
df91af91 761 all_ARG, force_ARG, test_ARG)
269930c0
AK
762
763xx(vgmerge,
764 "Merge volume groups",
765 "vgmerge\n"
c80325ca
AK
766 "\t[-A|--autobackup y|n]\n"
767 "\t[-d|--debug]\n"
768 "\t[-h|--help]\n"
769 "\t[-l|--list]\n"
770 "\t[-t|--test]\n"
771 "\t[-v|--verbose]\n"
4c64ed4c 772 "\t[--version]" "\n"
269930c0
AK
773 "\tDestinationVolumeGroupName SourceVolumeGroupName\n",
774
775 autobackup_ARG, list_ARG, test_ARG)
776
777xx(vgmknodes,
778 "Create the special files for volume group devices in /dev",
779 "vgmknodes\n"
c80325ca
AK
780 "\t[-d|--debug]\n"
781 "\t[-h|--help]\n"
0a0f13e6 782 "\t[--ignorelockingfailure]\n"
c80325ca 783 "\t[-v|--verbose]\n"
4c64ed4c 784 "\t[--version]" "\n"
0a0f13e6
AK
785 "\t[VolumeGroupName...]\n",
786
787 ignorelockingfailure_ARG)
269930c0
AK
788
789xx(vgreduce,
790 "Remove physical volume(s) from a volume group",
791 "vgreduce\n"
c80325ca
AK
792 "\t[-a|--all]\n"
793 "\t[-A|--autobackup y|n]\n"
794 "\t[-d|--debug]\n"
795 "\t[-h|--help]\n"
c9dcba6b 796 "\t[--mirrorsonly]\n"
a421f743 797 "\t[--removemissing]\n"
c80325ca
AK
798 "\t[-t|--test]\n"
799 "\t[-v|--verbose]\n"
4c64ed4c 800 "\t[--version]" "\n"
269930c0
AK
801 "\tVolumeGroupName\n"
802 "\t[PhysicalVolumePath...]\n",
803
c9dcba6b 804 all_ARG, autobackup_ARG, mirrorsonly_ARG, removemissing_ARG, test_ARG)
269930c0
AK
805
806xx(vgremove,
807 "Remove volume group(s)",
808 "vgremove\n"
c80325ca
AK
809 "\t[-d|--debug]\n"
810 "\t[-h|--help]\n"
811 "\t[-t|--test]\n"
812 "\t[-v|--verbose]\n"
4c64ed4c 813 "\t[--version]" "\n"
c2d72fd4
AK
814 "\tVolumeGroupName [VolumeGroupName...]\n",
815
816 test_ARG)
269930c0
AK
817
818xx(vgrename,
819 "Rename a volume group",
820 "vgrename\n"
c80325ca
AK
821 "\t[-A|--autobackup y|n]\n"
822 "\t[-d|--debug]\n"
823 "\t[-h|--help]\n"
824 "\t[-t|--test]\n"
825 "\t[-v|--verbose]\n"
4c64ed4c 826 "\t[--version]" "\n"
a03f2320 827 "\tOldVolumeGroupPath NewVolumeGroupPath |\n"
269930c0
AK
828 "\tOldVolumeGroupName NewVolumeGroupName\n",
829
c2d72fd4 830 autobackup_ARG, force_ARG, test_ARG)
269930c0 831
4c64ed4c
AK
832xx(vgs,
833 "Display information about volume groups",
834 "vgs" "\n"
835 "\t[--aligned]\n"
8211a13c 836 "\t[-a|--all]\n"
4c64ed4c
AK
837 "\t[-d|--debug]\n"
838 "\t[-h|--help]\n"
839 "\t[--ignorelockingfailure]\n"
840 "\t[--noheadings]\n"
841 "\t[--nosuffix]\n"
842 "\t[-o|--options [+]Field[,Field]]\n"
843 "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
844 "\t[-P|--partial] " "\n"
845 "\t[--separator Separator]\n"
e3ad1d19 846 "\t[--trustcache]\n"
4c64ed4c
AK
847 "\t[--unbuffered]\n"
848 "\t[--units hsbkmgtHKMGT]\n"
849 "\t[-v|--verbose]\n"
850 "\t[--version]\n"
851 "\t[VolumeGroupName [VolumeGroupName...]]\n",
3e3d5d85 852
8211a13c
AK
853 aligned_ARG, all_ARG, ignorelockingfailure_ARG, noheadings_ARG,
854 nolocking_ARG, nosuffix_ARG, options_ARG, partial_ARG, separator_ARG,
e3ad1d19 855 sort_ARG, trustcache_ARG, unbuffered_ARG, units_ARG)
4c64ed4c 856
269930c0
AK
857xx(vgscan,
858 "Search for all volume groups",
859 "vgscan "
c80325ca
AK
860 "\t[-d|--debug]\n"
861 "\t[-h|--help]\n"
8b46b545 862 "\t[--ignorelockingfailure]\n"
5a8fa8c9 863 "\t[--mknodes]\n"
c80325ca 864 "\t[-P|--partial] " "\n"
3e3d5d85 865 "\t[-v|--verbose]\n"
4c64ed4c 866 "\t[--version]" "\n",
8b46b545 867
5a8fa8c9 868 ignorelockingfailure_ARG, mknodes_ARG, partial_ARG)
269930c0
AK
869
870xx(vgsplit,
871 "Move physical volumes into a new volume group",
a03f2320
AK
872 "vgsplit " "\n"
873 "\t[-A|--autobackup {y|n}] " "\n"
874 "\t[-d|--debug] " "\n"
875 "\t[-h|--help] " "\n"
876 "\t[-l|--list]" "\n"
5a52dca9 877 "\t[-M|--metadatatype 1|2] " "\n"
a03f2320
AK
878 "\t[-t|--test] " "\n"
879 "\t[-v|--verbose] " "\n"
880 "\t[--version]" "\n"
881 "\tExistingVolumeGroupName NewVolumeGroupName" "\n"
882 "\tPhysicalVolumePath [PhysicalVolumePath...]\n",
269930c0 883
fbbe942c 884 autobackup_ARG, list_ARG, metadatatype_ARG, test_ARG)
fae0c576
AK
885
886xx(version,
887 "Display software and driver version information",
888 "version\n" )
889
This page took 0.154593 seconds and 5 git commands to generate.