Tizen 2.1 base
[external/device-mapper.git] / tools / commands.h
1 /*
2  * Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
3  * Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
4  *
5  * This file is part of LVM2.
6  *
7  * This copyrighted material is made available to anyone wishing to use,
8  * modify, copy, or redistribute it subject to the terms and conditions
9  * of the GNU Lesser General Public License v.2.1.
10  *
11  * You should have received a copy of the GNU Lesser General Public License
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
14  */
15
16 /***********  Replace with script?
17 xx(e2fsadm,
18    "Resize logical volume and ext2 filesystem",
19    "e2fsadm "
20    "[-d|--debug] " "[-h|--help] " "[-n|--nofsck]" "\n"
21    "\t{[-l|--extents] [+|-]LogicalExtentsNumber |" "\n"
22    "\t [-L|--size] [+|-]LogicalVolumeSize[bBsSkKmMgGtTpPeE]}" "\n"
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
31 xx(dumpconfig,
32    "Dump active configuration",
33    PERMITTED_READ_ONLY,
34    "dumpconfig "
35    "\t[-f|--file filename] " "\n"
36    "[ConfigurationVariable...]\n",
37    file_ARG)
38
39 xx(formats,
40    "List available metadata formats",
41    PERMITTED_READ_ONLY,
42    "formats\n")
43
44 xx(help,
45    "Display help for commands",
46    PERMITTED_READ_ONLY,
47    "help <command>" "\n")
48
49 /*********
50 xx(lvactivate,
51    "Activate logical volume on given partition(s)",
52    "lvactivate "
53    "\t[-d|--debug]\n"
54    "\t[-h|--help]\n"
55    "\t[-v|--verbose]\n"
56    "Logical Volume(s)\n")
57 ***********/
58
59 xx(lvchange,
60    "Change the attributes of logical volume(s)",
61    CACHE_VGMETADATA | PERMITTED_READ_ONLY,
62    "lvchange\n"
63    "\t[-A|--autobackup y|n]\n"
64    "\t[-a|--available [e|l]y|n]\n"
65    "\t[--addtag Tag]\n"
66    "\t[--alloc AllocationPolicy]\n"
67    "\t[-C|--contiguous y|n]\n"
68    "\t[-d|--debug]\n"
69    "\t[--deltag Tag]\n"
70    "\t[-f|--force]\n"
71    "\t[-h|--help]\n"
72    "\t[--ignorelockingfailure]\n"
73    "\t[--ignoremonitoring]\n"
74    "\t[--monitor {y|n}]\n"
75    "\t[--poll {y|n}]\n"
76    "\t[--noudevsync]\n"
77    "\t[-M|--persistent y|n] [--major major] [--minor minor]\n"
78    "\t[-P|--partial] " "\n"
79    "\t[-p|--permission r|rw]\n"
80    "\t[-r|--readahead ReadAheadSectors|auto|none]\n"
81    "\t[--refresh]\n"
82    "\t[--resync]\n"
83    "\t[--sysinit]\n"
84    "\t[-t|--test]\n"
85    "\t[-v|--verbose]\n"
86    "\t[-y|--yes]\n"
87    "\t[--version]" "\n"
88    "\tLogicalVolume[Path] [LogicalVolume[Path]...]\n",
89
90    alloc_ARG, autobackup_ARG, available_ARG, contiguous_ARG, force_ARG,
91    ignorelockingfailure_ARG, ignoremonitoring_ARG, major_ARG, minor_ARG,
92    monitor_ARG, noudevsync_ARG, partial_ARG, permission_ARG, persistent_ARG,
93    poll_ARG, readahead_ARG, resync_ARG, refresh_ARG, addtag_ARG, deltag_ARG,
94    sysinit_ARG, test_ARG, yes_ARG)
95
96 xx(lvconvert,
97    "Change logical volume layout",
98    0,
99    "lvconvert "
100    "[-m|--mirrors Mirrors [{--mirrorlog {disk|core|mirrored}|--corelog}]]\n"
101    "\t[--repair [--use-policies]]\n"
102    "\t[-R|--regionsize MirrorLogRegionSize]\n"
103    "\t[--alloc AllocationPolicy]\n"
104    "\t[-b|--background]\n"
105    "\t[-d|--debug]\n"
106    "\t[-f|--force]\n"
107    "\t[-h|-?|--help]\n"
108    "\t[-i|--interval seconds]\n"
109    "\t[--stripes Stripes [-I|--stripesize StripeSize]]\n"
110    "\t[--noudevsync]\n"
111    "\t[-v|--verbose]\n"
112    "\t[-y|--yes]\n"
113    "\t[--version]" "\n"
114    "\tLogicalVolume[Path] [PhysicalVolume[Path]...]\n\n"
115
116    "lvconvert "
117    "[--splitmirrors Images --name SplitLogicalVolumeName]\n"
118    "\tLogicalVolume[Path] [SplittablePhysicalVolume[Path]...]\n\n"
119
120    "lvconvert "
121    "[-s|--snapshot]\n"
122    "\t[-c|--chunksize]\n"
123    "\t[-d|--debug]\n"
124    "\t[-h|-?|--help]\n"
125    "\t[--noudevsync]\n"
126    "\t[-v|--verbose]\n"
127    "\t[-Z|--zero {y|n}]\n"
128    "\t[--version]" "\n"
129    "\tOriginalLogicalVolume[Path] SnapshotLogicalVolume[Path]\n\n"
130
131    "lvconvert "
132    "--merge\n"
133    "\t[-b|--background]\n"
134    "\t[-i|--interval seconds]\n"
135    "\t[-d|--debug]\n"
136    "\t[-h|-?|--help]\n"
137    "\t[-v|--verbose]\n"
138    "\tSnapshotLogicalVolume[Path]\n",
139
140    alloc_ARG, background_ARG, chunksize_ARG, corelog_ARG, interval_ARG,
141    merge_ARG, mirrorlog_ARG, mirrors_ARG, name_ARG, noudevsync_ARG,
142    regionsize_ARG, repair_ARG, snapshot_ARG, splitmirrors_ARG,
143    stripes_long_ARG, stripesize_ARG, test_ARG,
144    use_policies_ARG, yes_ARG, force_ARG, zero_ARG)
145
146 xx(lvcreate,
147    "Create a logical volume",
148    0,
149    "lvcreate " "\n"
150    "\t[-A|--autobackup {y|n}]\n"
151    "\t[--addtag Tag]\n"
152    "\t[--alloc AllocationPolicy]\n"
153    "\t[-C|--contiguous {y|n}]\n"
154    "\t[-d|--debug]\n"
155    "\t[-h|-?|--help]\n"
156    "\t[--ignoremonitoring]\n"
157    "\t[--monitor {y|n}]\n"
158    "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
159    "\t{-l|--extents LogicalExtentsNumber[%{VG|PVS|FREE}] |\n"
160    "\t -L|--size LogicalVolumeSize[bBsSkKmMgGtTpPeE]}\n"
161    "\t[-M|--persistent {y|n}] [--major major] [--minor minor]\n"
162    "\t[-m|--mirrors Mirrors [--nosync] [{--mirrorlog {disk|core|mirrored}|--corelog}]]\n"
163    "\t[-n|--name LogicalVolumeName]\n"
164    "\t[--noudevsync]\n"
165    "\t[-p|--permission {r|rw}]\n"
166    "\t[-r|--readahead ReadAheadSectors|auto|none]\n"
167    "\t[-R|--regionsize MirrorLogRegionSize]\n"
168    "\t[-t|--test]\n"
169    "\t[--type VolumeType]\n"
170    "\t[-v|--verbose]\n"
171    "\t[-Z|--zero {y|n}]\n"
172    "\t[--version]\n"
173    "\tVolumeGroupName [PhysicalVolumePath...]\n\n"
174
175    "lvcreate \n"
176    "\t{ {-s|--snapshot} OriginalLogicalVolume[Path] |\n"
177    "\t  [-s|--snapshot] VolumeGroupName[Path] --virtualsize VirtualSize}\n"
178    "\t[-c|--chunksize]\n"
179    "\t[-A|--autobackup {y|n}]\n"
180    "\t[--addtag Tag]\n"
181    "\t[--alloc AllocationPolicy]\n"
182    "\t[-C|--contiguous {y|n}]\n"
183    "\t[-d|--debug]\n"
184    "\t[-h|-?|--help]\n"
185    "\t[--ignoremonitoring]\n"
186    "\t[--monitor {y|n}]\n"
187    "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
188    "\t{-l|--extents LogicalExtentsNumber[%{VG|FREE|ORIGIN}] |\n"
189    "\t -L|--size LogicalVolumeSize[bBsSkKmMgGtTpPeE]}\n"
190    "\t[-M|--persistent {y|n}] [--major major] [--minor minor]\n"
191    "\t[-n|--name LogicalVolumeName]\n"
192    "\t[--noudevsync]\n"
193    "\t[-p|--permission {r|rw}]\n"
194    "\t[-r|--readahead ReadAheadSectors|auto|none]\n"
195    "\t[-t|--test]\n"
196    "\t[-v|--verbose]\n"
197    "\t[--version]\n"
198
199    "\t[PhysicalVolumePath...]\n\n",
200
201    addtag_ARG, alloc_ARG, autobackup_ARG, chunksize_ARG, contiguous_ARG,
202    corelog_ARG, extents_ARG, ignoremonitoring_ARG, major_ARG, minor_ARG,
203    mirrorlog_ARG, mirrors_ARG, monitor_ARG, name_ARG, nosync_ARG, noudevsync_ARG,
204    permission_ARG, persistent_ARG, readahead_ARG, regionsize_ARG, size_ARG,
205    snapshot_ARG, stripes_ARG, stripesize_ARG, test_ARG, type_ARG,
206    virtualoriginsize_ARG, virtualsize_ARG, zero_ARG)
207
208 xx(lvdisplay,
209    "Display information about a logical volume",
210    PERMITTED_READ_ONLY,
211    "lvdisplay\n"
212    "\t[-a|--all]\n"
213    "\t[-c|--colon]\n"
214    "\t[-d|--debug]\n"
215    "\t[-h|--help]\n"
216    "\t[--ignorelockingfailure]\n"
217    "\t[-m|--maps]\n"
218    "\t[--nosuffix]\n"
219    "\t[-P|--partial] " "\n"
220    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
221    "\t[-v|--verbose]\n"
222    "\t[--version]" "\n"
223    "\t[LogicalVolume[Path] [LogicalVolume[Path]...]]\n"
224    "\n"
225    "lvdisplay --columns|-C\n"
226    "\t[--aligned]\n"
227    "\t[-a|--all]\n"
228    "\t[-d|--debug]\n"
229    "\t[-h|--help]\n"
230    "\t[--ignorelockingfailure]\n"
231    "\t[--noheadings]\n"
232    "\t[--nosuffix]\n"
233    "\t[-o|--options [+]Field[,Field]]\n"
234    "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
235    "\t[-P|--partial] " "\n"
236    "\t[--segments]\n"
237    "\t[--separator Separator]\n"
238    "\t[--unbuffered]\n"
239    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
240    "\t[-v|--verbose]\n"
241    "\t[--version]" "\n"
242    "\t[LogicalVolume[Path] [LogicalVolume[Path]...]]\n",
243
244     aligned_ARG, all_ARG, colon_ARG, columns_ARG,
245     ignorelockingfailure_ARG, maps_ARG, noheadings_ARG, nosuffix_ARG,
246     options_ARG, sort_ARG, partial_ARG, segments_ARG, separator_ARG,
247     unbuffered_ARG, units_ARG)
248
249 xx(lvextend,
250    "Add space to a logical volume",
251    0,
252    "lvextend\n"
253    "\t[-A|--autobackup y|n]\n"
254    "\t[--alloc AllocationPolicy]\n"
255    "\t[-d|--debug]\n"
256    "\t[-f|--force]\n"
257    "\t[-h|--help]\n"
258    "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
259    "\t{-l|--extents [+]LogicalExtentsNumber[%{VG|LV|PVS|FREE|ORIGIN}] |\n"
260    "\t -L|--size [+]LogicalVolumeSize[bBsSkKmMgGtTpPeE]}\n"
261    "\t[-m|--mirrors Mirrors]\n"
262    "\t[--use-policies]\n"
263    "\t[-n|--nofsck]\n"
264    "\t[--noudevsync]\n"
265    "\t[-r|--resizefs]\n"
266    "\t[-t|--test]\n"
267    "\t[--type VolumeType]\n"
268    "\t[-v|--verbose]\n"
269    "\t[--version]" "\n"
270    "\tLogicalVolume[Path] [ PhysicalVolumePath... ]\n",
271
272    alloc_ARG, autobackup_ARG, extents_ARG, force_ARG, mirrors_ARG,
273    nofsck_ARG, noudevsync_ARG, resizefs_ARG, size_ARG, stripes_ARG,
274    stripesize_ARG, test_ARG, type_ARG, use_policies_ARG)
275
276 xx(lvmchange,
277    "With the device mapper, this is obsolete and does nothing.",
278    0,
279    "lvmchange\n"
280    "\t[-d|--debug]\n"
281    "\t[-h|--help]\n"
282    "\t[-R|--reset]\n"
283    "\t[-v|--verbose]\n"
284    "\t[--version]" "\n",
285
286     reset_ARG)
287
288 xx(lvmdiskscan,
289    "List devices that may be used as physical volumes",
290    PERMITTED_READ_ONLY,
291    "lvmdiskscan\n"
292    "\t[-d|--debug]\n"
293    "\t[-h|--help]\n"
294    "\t[-l|--lvmpartition]\n"
295    "\t[--version]" "\n",
296
297    lvmpartition_ARG)
298
299 xx(lvmsadc,
300    "Collect activity data",
301    0,
302    "lvmsadc\n"
303    "\t[-d|--debug]\n"
304    "\t[-h|--help]\n"
305    "\t[-v|--verbose]\n"
306    "\t[--version]" "\n"
307    "\t[LogFilePath]\n" )
308
309 xx(lvmsar,
310    "Create activity report",
311    0,
312    "lvmsar\n"
313    "\t[-d|--debug]\n"
314    "\t[-f|--full]\n"
315    "\t[-h|--help]\n"
316    "\t[-s|--stdin]\n"
317    "\t[-v|--verbose]\n"
318    "\t[--version]" "\n"
319    "\tLogFilePath\n",
320
321    full_ARG, stdin_ARG)
322
323 xx(lvreduce,
324    "Reduce the size of a logical volume",
325    0,
326    "lvreduce\n"
327    "\t[-A|--autobackup y|n]\n"
328    "\t[-d|--debug]\n"
329    "\t[-f|--force]\n"
330    "\t[-h|--help]\n"
331    "\t{-l|--extents [-]LogicalExtentsNumber[%{VG|LV|FREE|ORIGIN}] |\n"
332    "\t -L|--size [-]LogicalVolumeSize[bBsSkKmMgGtTpPeE]}\n"
333    "\t[-n|--nofsck]\n"
334    "\t[--noudevsync]\n"
335    "\t[-r|--resizefs]\n"
336    "\t[-t|--test]\n"
337    "\t[-v|--verbose]\n"
338    "\t[-y|--yes]\n"
339    "\t[--version]" "\n"
340    "\tLogicalVolume[Path]\n",
341
342    autobackup_ARG, force_ARG,  extents_ARG, nofsck_ARG, noudevsync_ARG,
343    resizefs_ARG, size_ARG, test_ARG, yes_ARG)
344
345 xx(lvremove,
346    "Remove logical volume(s) from the system",
347    0,
348    "lvremove\n"
349    "\t[-A|--autobackup y|n]\n"
350    "\t[-d|--debug]\n"
351    "\t[-f|--force]\n"
352    "\t[-h|--help]\n"
353    "\t[--noudevsync]\n"
354    "\t[-t|--test]\n"
355    "\t[-v|--verbose]\n"
356    "\t[--version]" "\n"
357    "\tLogicalVolume[Path] [LogicalVolume[Path]...]\n",
358
359    autobackup_ARG, force_ARG, noudevsync_ARG, test_ARG)
360
361 xx(lvrename,
362    "Rename a logical volume",
363    0,
364    "lvrename "
365    "\t[-A|--autobackup {y|n}] " "\n"
366    "\t[-d|--debug] " "\n"
367    "\t[-h|-?|--help] " "\n"
368    "\t[--noudevsync]\n"
369    "\t[-t|--test] " "\n"
370    "\t[-v|--verbose]" "\n"
371    "\t[--version] " "\n"
372    "\t{ OldLogicalVolumePath NewLogicalVolumePath |" "\n"
373    "\t  VolumeGroupName OldLogicalVolumeName NewLogicalVolumeName }\n",
374
375    autobackup_ARG, noudevsync_ARG, test_ARG)
376
377 xx(lvresize,
378    "Resize a logical volume",
379    0,
380    "lvresize\n"
381    "\t[-A|--autobackup y|n]\n"
382    "\t[--alloc AllocationPolicy]\n"
383    "\t[-d|--debug]\n"
384    "\t[-f|--force]\n"
385    "\t[-h|--help]\n"
386    "\t[-i|--stripes Stripes [-I|--stripesize StripeSize]]\n"
387    "\t{-l|--extents [+|-]LogicalExtentsNumber[%{VG|LV|PVS|FREE|ORIGIN}] |\n"
388    "\t -L|--size [+|-]LogicalVolumeSize[bBsSkKmMgGtTpPeE]}\n"
389    "\t[-n|--nofsck]\n"
390    "\t[--noudevsync]\n"
391    "\t[-r|--resizefs]\n"
392    "\t[-t|--test]\n"
393    "\t[--type VolumeType]\n"
394    "\t[-v|--verbose]\n"
395    "\t[--version]" "\n"
396    "\tLogicalVolume[Path] [ PhysicalVolumePath... ]\n",
397
398    alloc_ARG, autobackup_ARG, extents_ARG, force_ARG, nofsck_ARG,
399    noudevsync_ARG, resizefs_ARG, size_ARG, stripes_ARG, stripesize_ARG,
400    test_ARG, type_ARG)
401
402 xx(lvs,
403    "Display information about logical volumes",
404    PERMITTED_READ_ONLY,
405    "lvs" "\n"
406    "\t[-a|--all]\n"
407    "\t[--aligned]\n"
408    "\t[-d|--debug]\n"
409    "\t[-h|--help]\n"
410    "\t[--ignorelockingfailure]\n"
411    "\t[--nameprefixes]\n"
412    "\t[--noheadings]\n"
413    "\t[--nosuffix]\n"
414    "\t[-o|--options [+]Field[,Field]]\n"
415    "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
416    "\t[-P|--partial] " "\n"
417    "\t[--rows]\n"
418    "\t[--segments]\n"
419    "\t[--separator Separator]\n"
420    "\t[--trustcache]\n"
421    "\t[--unbuffered]\n"
422    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
423    "\t[--unquoted]\n"
424    "\t[-v|--verbose]\n"
425    "\t[--version]" "\n"
426    "\t[LogicalVolume[Path] [LogicalVolume[Path]...]]\n",
427
428    aligned_ARG, all_ARG, ignorelockingfailure_ARG, nameprefixes_ARG,
429    noheadings_ARG, nolocking_ARG, nosuffix_ARG, options_ARG, partial_ARG, 
430    rows_ARG, segments_ARG, separator_ARG, sort_ARG, trustcache_ARG,
431    unbuffered_ARG, units_ARG, unquoted_ARG)
432
433 xx(lvscan,
434    "List all logical volumes in all volume groups",
435    PERMITTED_READ_ONLY,
436    "lvscan " "\n"
437    "\t[-a|--all]\n"
438    "\t[-b|--blockdevice] " "\n"
439    "\t[-d|--debug] " "\n"
440    "\t[-h|-?|--help] " "\n"
441    "\t[--ignorelockingfailure]\n"
442    "\t[-P|--partial] " "\n"
443    "\t[-v|--verbose] " "\n"
444    "\t[--version]\n",
445
446    all_ARG, blockdevice_ARG, ignorelockingfailure_ARG, partial_ARG)
447
448 xx(pvchange,
449    "Change attributes of physical volume(s)",
450    0,
451    "pvchange\n"
452    "\t[-a|--all]\n"
453    "\t[-A|--autobackup y|n]\n"
454    "\t[-d|--debug]\n"
455    "\t[-f|--force]\n"
456    "\t[-h|--help]\n"
457    "\t[-t|--test]\n"
458    "\t[-u|--uuid]\n"
459    "\t[-x|--allocatable y|n]\n"
460    "\t[--metadataignore y|n]\n"
461    "\t[-v|--verbose]\n"
462    "\t[--addtag Tag]\n"
463    "\t[--deltag Tag]\n"
464    "\t[--version]" "\n"
465    "\t[PhysicalVolumePath...]\n",
466
467    all_ARG, allocatable_ARG, allocation_ARG, autobackup_ARG, deltag_ARG,
468    addtag_ARG, force_ARG, metadataignore_ARG, test_ARG, uuid_ARG)
469
470 xx(pvresize,
471    "Resize physical volume(s)",
472    0,
473    "pvresize " "\n"
474    "\t[-d|--debug]" "\n"
475    "\t[-h|-?|--help] " "\n"
476    "\t[--setphysicalvolumesize PhysicalVolumeSize[bBsSkKmMgGtTpPeE]" "\n"
477    "\t[-t|--test] " "\n"
478    "\t[-v|--verbose] " "\n"
479    "\t[--version] " "\n"
480    "\tPhysicalVolume [PhysicalVolume...]\n",
481
482    physicalvolumesize_ARG, test_ARG)
483
484 xx(pvck,
485    "Check the consistency of physical volume(s)",
486    0,
487    "pvck "
488    "\t[-d|--debug]\n"
489    "\t[-h|--help]\n"
490    "\t[--labelsector sector] " "\n"
491    "\t[-v|--verbose]\n"
492    "\t[--version]" "\n"
493    "\tPhysicalVolume [PhysicalVolume...]\n",
494
495    labelsector_ARG)
496
497 xx(pvcreate,
498    "Initialize physical volume(s) for use by LVM",
499    0,
500    "pvcreate " "\n"
501    "\t[--norestorefile]\n"
502    "\t[--restorefile file]\n"
503    "\t[-d|--debug]" "\n"
504    "\t[-f[f]|--force [--force]] " "\n"
505    "\t[-h|-?|--help] " "\n"
506    "\t[--labelsector sector] " "\n"
507    "\t[-M|--metadatatype 1|2]" "\n"
508    "\t[--pvmetadatacopies #copies]" "\n"
509    "\t[--metadatasize MetadataSize[bBsSkKmMgGtTpPeE]]" "\n"
510    "\t[--dataalignment Alignment[bBsSkKmMgGtTpPeE]]" "\n"
511    "\t[--dataalignmentoffset AlignmentOffset[bBsSkKmMgGtTpPeE]]" "\n"
512    "\t[--setphysicalvolumesize PhysicalVolumeSize[bBsSkKmMgGtTpPeE]" "\n"
513    "\t[-t|--test] " "\n"
514    "\t[-u|--uuid uuid] " "\n"
515    "\t[-v|--verbose] " "\n"
516    "\t[-y|--yes]" "\n"
517    "\t[-Z|--zero {y|n}]\n"
518    "\t[--version] " "\n"
519    "\tPhysicalVolume [PhysicalVolume...]\n",
520
521    dataalignment_ARG, dataalignmentoffset_ARG, force_ARG, test_ARG,
522    labelsector_ARG, metadatatype_ARG, metadatacopies_ARG,
523    metadatasize_ARG, metadataignore_ARG, norestorefile_ARG,
524    physicalvolumesize_ARG, pvmetadatacopies_ARG,
525    restorefile_ARG, uuidstr_ARG, yes_ARG, zero_ARG)
526
527 xx(pvdata,
528    "Display the on-disk metadata for physical volume(s)",
529    0,
530    "pvdata " "\n"
531    "\t[-a|--all] " "\n"
532    "\t[-d|--debug] " "\n"
533    "\t[-E|--physicalextent] " "\n"
534    "\t[-h|-?|--help]" "\n"
535    "\t[-L|--logicalvolume] " "\n"
536    "\t[-P[P]|--physicalvolume [--physicalvolume]]" "\n"
537    "\t[-U|--uuidlist] " "\n"
538    "\t[-v[v]|--verbose [--verbose]] " "\n"
539    "\t[-V|--volumegroup]" "\n"
540    "\t[--version] " "\n"
541    "\tPhysicalVolume [PhysicalVolume...]\n",
542
543    all_ARG,  logicalextent_ARG, physicalextent_ARG,
544    physicalvolume_ARG, uuidlist_ARG, volumegroup_ARG)
545
546 xx(pvdisplay,
547    "Display various attributes of physical volume(s)",
548    CACHE_VGMETADATA | PERMITTED_READ_ONLY,
549    "pvdisplay\n"
550    "\t[-c|--colon]\n"
551    "\t[-d|--debug]\n"
552    "\t[-h|--help]\n"
553    "\t[--ignorelockingfailure]\n"
554    "\t[-m|--maps]\n"
555    "\t[--nosuffix]\n"
556    "\t[-s|--short]\n"
557    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
558    "\t[-v|--verbose]\n"
559    "\t[--version]" "\n"
560    "\t[PhysicalVolumePath [PhysicalVolumePath...]]\n"
561    "\n"
562    "pvdisplay --columns|-C\n"
563    "\t[--aligned]\n"
564    "\t[-a|--all]\n"
565    "\t[-d|--debug]\n"
566    "\t[-h|--help]\n"
567    "\t[--ignorelockingfailure]\n"
568    "\t[--noheadings]\n"
569    "\t[--nosuffix]\n"
570    "\t[-o|--options [+]Field[,Field]]\n"
571    "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
572    "\t[--separator Separator]\n"
573    "\t[--unbuffered]\n"
574    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
575    "\t[-v|--verbose]\n"
576    "\t[--version]" "\n"
577    "\t[PhysicalVolumePath [PhysicalVolumePath...]]\n",
578
579    aligned_ARG, all_ARG, colon_ARG, columns_ARG, ignorelockingfailure_ARG,
580    maps_ARG, noheadings_ARG, nosuffix_ARG, options_ARG, separator_ARG,
581    short_ARG, sort_ARG, unbuffered_ARG, units_ARG)
582
583 xx(pvmove,
584    "Move extents from one physical volume to another",
585    0,
586    "pvmove " "\n"
587    "\t[--abort]\n"
588    "\t[-A|--autobackup {y|n}]\n"
589    "\t[--alloc AllocationPolicy]\n"
590    "\t[-b|--background]\n"
591    "\t[-d|--debug]\n "
592    "\t[-h|-?|--help]\n"
593    "\t[-i|--interval seconds]\n"
594    "\t[--noudevsync]\n"
595    "\t[-t|--test]\n "
596    "\t[-v|--verbose]\n "
597    "\t[--version]\n"
598    "\t[{-n|--name} LogicalVolume]\n"
599 /* "\t[{-n|--name} LogicalVolume[:LogicalExtent[-LogicalExtent]...]]\n" */
600    "\tSourcePhysicalVolume[:PhysicalExtent[-PhysicalExtent]...]}\n"
601    "\t[DestinationPhysicalVolume[:PhysicalExtent[-PhysicalExtent]...]...]\n",
602
603    abort_ARG, alloc_ARG, autobackup_ARG, background_ARG,
604    interval_ARG, name_ARG, noudevsync_ARG, test_ARG)
605
606 xx(pvremove,
607    "Remove LVM label(s) from physical volume(s)",
608    0,
609    "pvremove " "\n"
610    "\t[-d|--debug]" "\n"
611    "\t[-f[f]|--force [--force]] " "\n"
612    "\t[-h|-?|--help] " "\n"
613    "\t[-t|--test] " "\n"
614    "\t[-v|--verbose] " "\n"
615    "\t[-y|--yes]" "\n"
616    "\t[--version] " "\n"
617    "\tPhysicalVolume [PhysicalVolume...]\n",
618
619    force_ARG, test_ARG, yes_ARG)
620
621 xx(pvs,
622    "Display information about physical volumes",
623    CACHE_VGMETADATA | PERMITTED_READ_ONLY,
624    "pvs" "\n"
625    "\t[-a|--all]\n"
626    "\t[--aligned]\n"
627    "\t[-d|--debug]" "\n"
628    "\t[-h|-?|--help] " "\n"
629    "\t[--ignorelockingfailure]\n"
630    "\t[--nameprefixes]\n"
631    "\t[--noheadings]\n"
632    "\t[--nosuffix]\n"
633    "\t[-o|--options [+]Field[,Field]]\n"
634    "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
635    "\t[-P|--partial] " "\n"
636    "\t[--rows]\n"
637    "\t[--segments]\n"
638    "\t[--separator Separator]\n"
639    "\t[--trustcache]\n"
640    "\t[--unbuffered]\n"
641    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
642    "\t[--unquoted]\n"
643    "\t[-v|--verbose]\n"
644    "\t[--version]\n"
645    "\t[PhysicalVolume [PhysicalVolume...]]\n",
646
647    aligned_ARG, all_ARG, ignorelockingfailure_ARG, nameprefixes_ARG,
648    noheadings_ARG, nolocking_ARG, nosuffix_ARG, options_ARG, partial_ARG,
649    rows_ARG, segments_ARG, separator_ARG, sort_ARG, trustcache_ARG,
650    unbuffered_ARG, units_ARG, unquoted_ARG)
651
652 xx(pvscan,
653    "List all physical volumes",
654    PERMITTED_READ_ONLY,
655    "pvscan " "\n"
656    "\t[-d|--debug] " "\n"
657    "\t{-e|--exported | -n|--novolumegroup} " "\n"
658    "\t[-h|-?|--help]" "\n"
659    "\t[--ignorelockingfailure]\n"
660    "\t[-P|--partial] " "\n"
661    "\t[-s|--short] " "\n"
662    "\t[-u|--uuid] " "\n"
663    "\t[-v|--verbose] " "\n"
664    "\t[--version]\n",
665
666    exported_ARG, ignorelockingfailure_ARG, novolumegroup_ARG, partial_ARG,
667    short_ARG, uuid_ARG)
668
669 xx(segtypes,
670    "List available segment types",
671    PERMITTED_READ_ONLY,
672    "segtypes\n")
673
674 xx(vgcfgbackup,
675    "Backup volume group configuration(s)",
676    PERMITTED_READ_ONLY,
677    "vgcfgbackup " "\n"
678    "\t[-d|--debug] " "\n"
679    "\t[-f|--file filename] " "\n"
680    "\t[-h|-?|--help] " "\n"
681    "\t[--ignorelockingfailure]\n"
682    "\t[-P|--partial] " "\n"
683    "\t[-v|--verbose]" "\n"
684    "\t[--version] " "\n"
685    "\t[VolumeGroupName...]\n",
686
687    file_ARG, ignorelockingfailure_ARG, partial_ARG)
688
689 xx(vgcfgrestore,
690    "Restore volume group configuration",
691    0,
692    "vgcfgrestore " "\n"
693    "\t[-d|--debug] " "\n"
694    "\t[-f|--file filename] " "\n"
695    "\t[-l[l]|--list [--list]]" "\n"
696    "\t[-M|--metadatatype 1|2]" "\n"
697    "\t[-h|--help]" "\n"
698    "\t[-t|--test] " "\n"
699    "\t[-v|--verbose]" "\n"
700    "\t[--version] " "\n"
701    "\tVolumeGroupName",
702
703    file_ARG, list_ARG, metadatatype_ARG, test_ARG)
704
705 xx(vgchange,
706    "Change volume group attributes",
707    CACHE_VGMETADATA | PERMITTED_READ_ONLY,
708    "vgchange" "\n"
709    "\t[-A|--autobackup {y|n}] " "\n"
710    "\t[--alloc AllocationPolicy] " "\n"
711    "\t[-P|--partial] " "\n"
712    "\t[-d|--debug] " "\n"
713    "\t[-h|--help] " "\n"
714    "\t[--ignorelockingfailure]\n"
715    "\t[--ignoremonitoring]\n"
716    "\t[--monitor {y|n}]\n"
717    "\t[--[vg]metadatacopies #copies] " "\n"
718    "\t[--poll {y|n}]\n"
719    "\t[--noudevsync]\n"
720    "\t[--refresh]\n"
721    "\t[--sysinit]\n"
722    "\t[-t|--test]" "\n"
723    "\t[-u|--uuid] " "\n"
724    "\t[-v|--verbose] " "\n"
725    "\t[--version]" "\n"
726    "\t{-a|--available [e|l]{y|n}  |" "\n"
727    "\t -c|--clustered {y|n} |" "\n"
728    "\t -x|--resizeable {y|n} |" "\n"
729    "\t -l|--logicalvolume MaxLogicalVolumes |" "\n"
730    "\t -p|--maxphysicalvolumes MaxPhysicalVolumes |" "\n"
731    "\t -s|--physicalextentsize PhysicalExtentSize[bBsSkKmMgGtTpPeE] |" "\n"
732    "\t --addtag Tag |\n"
733    "\t --deltag Tag}\n"
734    "\t[VolumeGroupName...]\n",
735
736    addtag_ARG, alloc_ARG, allocation_ARG, autobackup_ARG, available_ARG,
737    clustered_ARG, deltag_ARG, ignorelockingfailure_ARG, ignoremonitoring_ARG,
738    logicalvolume_ARG, maxphysicalvolumes_ARG, monitor_ARG, noudevsync_ARG,
739    metadatacopies_ARG, vgmetadatacopies_ARG, partial_ARG,
740    physicalextentsize_ARG, poll_ARG, refresh_ARG, resizeable_ARG,
741    resizable_ARG, sysinit_ARG, test_ARG, uuid_ARG)
742
743 xx(vgck,
744    "Check the consistency of volume group(s)",
745    0,
746    "vgck "
747    "\t[-d|--debug]\n"
748    "\t[-h|--help]\n"
749    "\t[-v|--verbose]\n"
750    "\t[--version]" "\n"
751    "\t[VolumeGroupName...]\n" )
752
753 xx(vgconvert,
754    "Change volume group metadata format",
755    0,
756    "vgconvert  " "\n"
757    "\t[-d|--debug]" "\n"
758    "\t[-h|--help] " "\n"
759    "\t[--labelsector sector] " "\n"
760    "\t[-M|--metadatatype 1|2]" "\n"
761    "\t[--pvmetadatacopies #copies]" "\n"
762    "\t[--metadatasize MetadataSize[bBsSkKmMgGtTpPeE]]" "\n"
763    "\t[-t|--test] " "\n"
764    "\t[-v|--verbose] " "\n"
765    "\t[--version] " "\n"
766    "\tVolumeGroupName [VolumeGroupName...]\n",
767
768    force_ARG, test_ARG, labelsector_ARG, metadatatype_ARG, metadatacopies_ARG,
769    pvmetadatacopies_ARG, metadatasize_ARG )
770
771 xx(vgcreate,
772    "Create a volume group",
773    0,
774    "vgcreate" "\n"
775    "\t[-A|--autobackup {y|n}] " "\n"
776    "\t[--addtag Tag] " "\n"
777    "\t[--alloc AllocationPolicy] " "\n"
778    "\t[-c|--clustered {y|n}] " "\n"
779    "\t[-d|--debug]" "\n"
780    "\t[-h|--help]" "\n"
781    "\t[-l|--maxlogicalvolumes MaxLogicalVolumes]" "\n"
782    "\t[-M|--metadatatype 1|2] " "\n"
783    "\t[--[vg]metadatacopies #copies] " "\n"
784    "\t[-p|--maxphysicalvolumes MaxPhysicalVolumes] " "\n"
785    "\t[-s|--physicalextentsize PhysicalExtentSize[bBsSkKmMgGtTpPeE]] " "\n"
786    "\t[-t|--test] " "\n"
787    "\t[-v|--verbose]" "\n"
788    "\t[--version] " "\n"
789    "\t[ PHYSICAL DEVICE OPTIONS ] " "\n"
790    "\tVolumeGroupName PhysicalDevicePath [PhysicalDevicePath...]\n",
791
792    addtag_ARG, alloc_ARG, autobackup_ARG, clustered_ARG, maxlogicalvolumes_ARG,
793    maxphysicalvolumes_ARG, metadatatype_ARG, physicalextentsize_ARG, test_ARG,
794    force_ARG, yes_ARG, zero_ARG, labelsector_ARG, metadatasize_ARG,
795    pvmetadatacopies_ARG, metadatacopies_ARG, vgmetadatacopies_ARG,
796    dataalignment_ARG, dataalignmentoffset_ARG)
797
798 xx(vgdisplay,
799    "Display volume group information",
800    PERMITTED_READ_ONLY,
801    "vgdisplay " "\n"
802    "\t[-A|--activevolumegroups]" "\n"
803    "\t[-c|--colon | -s|--short | -v|--verbose]" "\n"
804    "\t[-d|--debug] " "\n"
805    "\t[-h|--help] " "\n"
806    "\t[--ignorelockingfailure]" "\n"
807    "\t[--nosuffix]\n"
808    "\t[-P|--partial] " "\n"
809    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
810    "\t[--version]" "\n"
811    "\t[VolumeGroupName [VolumeGroupName...]]\n"
812    "\n"
813    "vgdisplay --columns|-C\n"
814    "\t[--aligned]\n"
815    "\t[-d|--debug] " "\n"
816    "\t[-h|--help] " "\n"
817    "\t[--ignorelockingfailure]" "\n"
818    "\t[--noheadings]\n"
819    "\t[--nosuffix]\n"
820    "\t[-o|--options [+]Field[,Field]]\n"
821    "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
822    "\t[-P|--partial] " "\n"
823    "\t[--separator Separator]\n"
824    "\t[--unbuffered]\n"
825    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
826    "\t[--verbose]" "\n"
827    "\t[--version]" "\n"
828    "\t[VolumeGroupName [VolumeGroupName...]]\n",
829
830    activevolumegroups_ARG, aligned_ARG, colon_ARG, columns_ARG,
831    ignorelockingfailure_ARG, noheadings_ARG, nosuffix_ARG, options_ARG,
832    partial_ARG, short_ARG, separator_ARG, sort_ARG, unbuffered_ARG, units_ARG)
833
834 xx(vgexport,
835    "Unregister volume group(s) from the system",
836    0,
837    "vgexport " "\n"
838    "\t[-a|--all] " "\n"
839    "\t[-d|--debug] " "\n"
840    "\t[-h|--help]" "\n"
841    "\t[-v|--verbose] " "\n"
842    "\t[--version] " "\n"
843    "\tVolumeGroupName [VolumeGroupName...]\n",
844
845    all_ARG, test_ARG)
846
847 xx(vgextend,
848    "Add physical volumes to a volume group",
849    0,
850    "vgextend\n"
851    "\t[-A|--autobackup y|n]\n"
852    "\t[--restoremissing]\n"
853    "\t[-d|--debug]\n"
854    "\t[-f|--force]\n"
855    "\t[-h|--help]\n"
856    "\t[-t|--test]\n"
857    "\t[-v|--verbose]\n"
858    "\t[--version]" "\n"
859    "\t[ PHYSICAL DEVICE OPTIONS ] " "\n"
860    "\tVolumeGroupName PhysicalDevicePath [PhysicalDevicePath...]\n",
861
862    autobackup_ARG, test_ARG,
863    force_ARG, yes_ARG, zero_ARG, labelsector_ARG, metadatatype_ARG,
864    metadatasize_ARG, pvmetadatacopies_ARG, metadatacopies_ARG,
865    metadataignore_ARG, dataalignment_ARG, dataalignmentoffset_ARG,
866    restoremissing_ARG)
867
868 xx(vgimport,
869    "Register exported volume group with system",
870    0,
871    "vgimport " "\n"
872    "\t[-a|--all]\n"
873    "\t[-d|--debug] " "\n"
874    "\t[-f|--force] " "\n"
875    "\t[-h|--help] " "\n"
876    "\t[-t|--test] " "\n"
877    "\t[-v|--verbose]" "\n"
878    "\t[--version]" "\n"
879    "\tVolumeGroupName..." "\n",
880
881    all_ARG, force_ARG, test_ARG)
882
883 xx(vgmerge,
884    "Merge volume groups",
885    0,
886    "vgmerge\n"
887    "\t[-A|--autobackup y|n]\n"
888    "\t[-d|--debug]\n"
889    "\t[-h|--help]\n"
890    "\t[-l|--list]\n"
891    "\t[-t|--test]\n"
892    "\t[-v|--verbose]\n"
893    "\t[--version]" "\n"
894    "\tDestinationVolumeGroupName SourceVolumeGroupName\n",
895
896    autobackup_ARG, list_ARG, test_ARG)
897
898 xx(vgmknodes,
899    "Create the special files for volume group devices in /dev",
900    0,
901    "vgmknodes\n"
902    "\t[-d|--debug]\n"
903    "\t[-h|--help]\n"
904    "\t[--ignorelockingfailure]\n"
905    "\t[--refresh]\n"
906    "\t[-v|--verbose]\n"
907    "\t[--version]" "\n"
908    "\t[VolumeGroupName...]\n",
909
910    ignorelockingfailure_ARG, refresh_ARG)
911
912 xx(vgreduce,
913    "Remove physical volume(s) from a volume group",
914    0,
915    "vgreduce\n"
916    "\t[-a|--all]\n"
917    "\t[-A|--autobackup y|n]\n"
918    "\t[-d|--debug]\n"
919    "\t[-h|--help]\n"
920    "\t[--mirrorsonly]\n"
921    "\t[--removemissing]\n"
922    "\t[-f|--force]\n"
923    "\t[-t|--test]\n"
924    "\t[-v|--verbose]\n"
925    "\t[--version]" "\n"
926    "\tVolumeGroupName\n"
927    "\t[PhysicalVolumePath...]\n",
928
929    all_ARG, autobackup_ARG, force_ARG, mirrorsonly_ARG, removemissing_ARG,
930    test_ARG)
931
932 xx(vgremove,
933    "Remove volume group(s)",
934    0,
935    "vgremove\n"
936    "\t[-d|--debug]\n"
937    "\t[-f|--force]\n"
938    "\t[-h|--help]\n"
939    "\t[--noudevsync]\n"
940    "\t[-t|--test]\n"
941    "\t[-v|--verbose]\n"
942    "\t[--version]" "\n"
943    "\tVolumeGroupName [VolumeGroupName...]\n",
944
945    force_ARG, noudevsync_ARG, test_ARG)
946
947 xx(vgrename,
948    "Rename a volume group",
949    0,
950    "vgrename\n"
951    "\t[-A|--autobackup y|n]\n"
952    "\t[-d|--debug]\n"
953    "\t[-h|--help]\n"
954    "\t[-t|--test]\n"
955    "\t[-v|--verbose]\n"
956    "\t[--version]" "\n"
957    "\tOldVolumeGroupPath NewVolumeGroupPath |\n"
958    "\tOldVolumeGroupName NewVolumeGroupName\n",
959
960    autobackup_ARG, force_ARG, test_ARG)
961
962 xx(vgs,
963    "Display information about volume groups",
964    PERMITTED_READ_ONLY,
965    "vgs" "\n"
966    "\t[--aligned]\n"
967    "\t[-a|--all]\n"
968    "\t[-d|--debug]\n"
969    "\t[-h|--help]\n"
970    "\t[--ignorelockingfailure]\n"
971    "\t[--nameprefixes]\n"
972    "\t[--noheadings]\n"
973    "\t[--nosuffix]\n"
974    "\t[-o|--options [+]Field[,Field]]\n"
975    "\t[-O|--sort [+|-]key1[,[+|-]key2[,...]]]\n"
976    "\t[-P|--partial] " "\n"
977    "\t[--rows]\n"
978    "\t[--separator Separator]\n"
979    "\t[--trustcache]\n"
980    "\t[--unbuffered]\n"
981    "\t[--units hHbBsSkKmMgGtTpPeE]\n"
982    "\t[--unquoted]\n"
983    "\t[-v|--verbose]\n"
984    "\t[--version]\n"
985    "\t[VolumeGroupName [VolumeGroupName...]]\n",
986
987    aligned_ARG, all_ARG, ignorelockingfailure_ARG, nameprefixes_ARG,
988    noheadings_ARG, nolocking_ARG, nosuffix_ARG, options_ARG, partial_ARG, 
989    rows_ARG, separator_ARG, sort_ARG, trustcache_ARG, unbuffered_ARG, units_ARG,
990    unquoted_ARG)
991
992 xx(vgscan,
993    "Search for all volume groups",
994    PERMITTED_READ_ONLY,
995    "vgscan "
996    "\t[-d|--debug]\n"
997    "\t[-h|--help]\n"
998    "\t[--ignorelockingfailure]\n"
999    "\t[--mknodes]\n"
1000    "\t[-P|--partial] " "\n"
1001    "\t[-v|--verbose]\n"
1002    "\t[--version]" "\n",
1003
1004    ignorelockingfailure_ARG, mknodes_ARG, partial_ARG)
1005
1006 xx(vgsplit,
1007    "Move physical volumes into a new or existing volume group",
1008    0,
1009    "vgsplit " "\n"
1010    "\t[-A|--autobackup {y|n}] " "\n"
1011    "\t[--alloc AllocationPolicy] " "\n"
1012    "\t[-c|--clustered {y|n}] " "\n"
1013    "\t[-d|--debug] " "\n"
1014    "\t[-h|--help] " "\n"
1015    "\t[-l|--maxlogicalvolumes MaxLogicalVolumes]" "\n"
1016    "\t[-M|--metadatatype 1|2] " "\n"
1017    "\t[--[vg]metadatacopies #copies] " "\n"
1018    "\t[-n|--name LogicalVolumeName]\n"
1019    "\t[-p|--maxphysicalvolumes MaxPhysicalVolumes] " "\n"
1020    "\t[-t|--test] " "\n"
1021    "\t[-v|--verbose] " "\n"
1022    "\t[--version]" "\n"
1023    "\tSourceVolumeGroupName DestinationVolumeGroupName" "\n"
1024    "\t[PhysicalVolumePath...]\n",
1025
1026    alloc_ARG, autobackup_ARG, clustered_ARG,
1027    maxlogicalvolumes_ARG, maxphysicalvolumes_ARG,
1028    metadatatype_ARG, vgmetadatacopies_ARG, name_ARG, test_ARG)
1029
1030 xx(version,
1031    "Display software and driver version information",
1032    PERMITTED_READ_ONLY,
1033    "version\n" )
1034