diff options
author | David Teigland <teigland@redhat.com> | 2017-01-06 16:56:59 -0600 |
---|---|---|
committer | David Teigland <teigland@redhat.com> | 2017-01-09 16:20:09 -0600 |
commit | ba47736e9481809ae3e4da776db5f68f8b3bd4e0 (patch) | |
tree | bded48be30852c0ac80a5d070a78d0cbb30c8b95 | |
parent | 40ef88f0da19e5ab122962047cefa2a2b310ab83 (diff) | |
download | lvm2-dev-dct-cmd-defs67.tar.gz |
args: add man page descriptionsdev-dct-cmd-defs67
This will allow for full generation of man pages.
-rw-r--r-- | tools/args.h | 719 | ||||
-rw-r--r-- | tools/create-commands.c | 283 | ||||
-rw-r--r-- | tools/lvmcmdline.c | 2 | ||||
-rw-r--r-- | tools/tools.h | 3 |
4 files changed, 739 insertions, 268 deletions
diff --git a/tools/args.h b/tools/args.h index 690b4eed2..d06dcceae 100644 --- a/tools/args.h +++ b/tools/args.h @@ -17,221 +17,522 @@ * Put all long args that don't have a corresponding short option first. */ /* *INDENT-OFF* */ -arg(ARG_UNUSED, '-', "", 0, 0, 0) /* place holder for unused 0 value */ - -arg(abort_ARG, '\0', "abort", 0, 0, 0) -arg(activationmode_ARG, '\0', "activationmode", activationmode_VAL, 0, 0) -arg(addtag_ARG, '\0', "addtag", tag_VAL, ARG_GROUPABLE, 0) -arg(aligned_ARG, '\0', "aligned", 0, 0, 0) -arg(alloc_ARG, '\0', "alloc", alloc_VAL, 0, 0) -arg(atomic_ARG, '\0', "atomic", 0, 0, 0) -arg(atversion_ARG, '\0', "atversion", string_VAL, 0, 0) -arg(binary_ARG, '\0', "binary", 0, 0, 0) -arg(bootloaderareasize_ARG, '\0', "bootloaderareasize", sizemb_VAL, 0, 0) -arg(cache_long_ARG, '\0', "cache", 0, 0, 0) -arg(cachemode_ARG, '\0', "cachemode", cachemode_VAL, 0, 0) -arg(cachepool_ARG, '\0', "cachepool", lv_VAL, 0, 0) -arg(commandprofile_ARG, '\0', "commandprofile", string_VAL, 0, 0) -arg(config_ARG, '\0', "config", string_VAL, 0, 0) -arg(configreport_ARG, '\0', "configreport", configreport_VAL, ARG_GROUPABLE, 1) -arg(configtype_ARG, '\0', "typeconfig", configtype_VAL, 0, 0) -arg(corelog_ARG, '\0', "corelog", 0, 0, 0) -arg(dataalignment_ARG, '\0', "dataalignment", sizekb_VAL, 0, 0) -arg(dataalignmentoffset_ARG, '\0', "dataalignmentoffset", sizekb_VAL, 0, 0) -arg(deltag_ARG, '\0', "deltag", tag_VAL, ARG_GROUPABLE, 0) -arg(detachprofile_ARG, '\0', "detachprofile", 0, 0, 0) -arg(discards_ARG, '\0', "discards", discards_VAL, 0, 0) -arg(driverloaded_ARG, '\0', "driverloaded", bool_VAL, 0, 0) -arg(errorwhenfull_ARG, '\0', "errorwhenfull", bool_VAL, 0, 0) -arg(force_long_ARG, '\0', "force", 0, ARG_COUNTABLE, 0) -arg(foreign_ARG, '\0', "foreign", 0, 0, 0) -arg(handlemissingpvs_ARG, '\0', "handlemissingpvs", 0, 0, 0) -arg(ignoreadvanced_ARG, '\0', "ignoreadvanced", 0, 0, 0) -arg(ignorelocal_ARG, '\0', "ignorelocal", 0, 0, 0) -arg(ignorelockingfailure_ARG, '\0', "ignorelockingfailure", 0, 0, 0) -arg(ignoremonitoring_ARG, '\0', "ignoremonitoring", 0, 0, 0) -arg(ignoreskippedcluster_ARG, '\0', "ignoreskippedcluster", 0, 0, 0) -arg(ignoreunsupported_ARG, '\0', "ignoreunsupported", 0, 0, 0) -arg(labelsector_ARG, '\0', "labelsector", number_VAL, 0, 0) -arg(lockopt_ARG, '\0', "lockopt", string_VAL, 0, 0) -arg(lockstart_ARG, '\0', "lockstart", 0, 0, 0) -arg(lockstop_ARG, '\0', "lockstop", 0, 0, 0) -arg(locktype_ARG, '\0', "locktype", locktype_VAL, 0, 0) -arg(logonly_ARG, '\0', "logonly", 0, 0, 0) -arg(maxrecoveryrate_ARG, '\0', "maxrecoveryrate", sizekb_VAL, 0, 0) -arg(merge_ARG, '\0', "merge", 0, 0, 0) -arg(mergemirrors_ARG, '\0', "mergemirrors", 0, 0, 0) -arg(mergesnapshot_ARG, '\0', "mergesnapshot", 0, 0, 0) -arg(mergethin_ARG, '\0', "mergethin", 0, 0, 0) -arg(mergedconfig_ARG, '\0', "mergedconfig", 0, 0, 0) -arg(metadatacopies_ARG, '\0', "metadatacopies", metadatacopies_VAL, 0, 0) -arg(metadataignore_ARG, '\0', "metadataignore", bool_VAL, 0, 0) -arg(metadataprofile_ARG, '\0', "metadataprofile", string_VAL, 0, 0) -arg(metadatasize_ARG, '\0', "metadatasize", sizemb_VAL, 0, 0) -arg(minor_ARG, '\0', "minor", number_VAL, ARG_GROUPABLE, 0) -arg(minrecoveryrate_ARG, '\0', "minrecoveryrate", sizekb_VAL, 0, 0) -arg(mirrorlog_ARG, '\0', "mirrorlog", mirrorlog_VAL, 0, 0) -arg(mirrorsonly_ARG, '\0', "mirrorsonly", 0, 0, 0) -arg(mknodes_ARG, '\0', "mknodes", 0, 0, 0) -arg(monitor_ARG, '\0', "monitor", bool_VAL, 0, 0) -arg(nameprefixes_ARG, '\0', "nameprefixes", 0, 0, 0) -arg(noheadings_ARG, '\0', "noheadings", 0, 0, 0) -arg(nohistory_ARG, '\0', "nohistory", 0, 0, 0) -arg(nolocking_ARG, '\0', "nolocking", 0, 0, 0) -arg(norestorefile_ARG, '\0', "norestorefile", 0, 0, 0) -arg(nosuffix_ARG, '\0', "nosuffix", 0, 0, 0) -arg(nosync_ARG, '\0', "nosync", 0, 0, 0) -arg(notifydbus_ARG, '\0', "notifydbus", 0, 0, 0) -arg(noudevsync_ARG, '\0', "noudevsync", 0, 0, 0) -arg(originname_ARG, '\0', "originname", lv_VAL, 0, 0) -arg(physicalvolumesize_ARG, '\0', "setphysicalvolumesize", sizemb_VAL, 0, 0) -arg(poll_ARG, '\0', "poll", bool_VAL, 0, 0) -arg(polloperation_ARG, '\0', "polloperation", polloperation_VAL, 0, 0) -arg(pooldatasize_ARG, '\0', "pooldatasize", sizemb_VAL, 0, 0) -arg(poolmetadata_ARG, '\0', "poolmetadata", lv_VAL, 0, 0) -arg(poolmetadatasize_ARG, '\0', "poolmetadatasize", sizemb_VAL, 0, 0) -arg(poolmetadataspare_ARG, '\0', "poolmetadataspare", bool_VAL, 0, 0) -arg(profile_ARG, '\0', "profile", string_VAL, 0, 0) -arg(pvmetadatacopies_ARG, '\0', "pvmetadatacopies", pvmetadatacopies_VAL, 0, 0) -arg(raidrebuild_ARG, '\0', "raidrebuild", pv_VAL, ARG_GROUPABLE, 0) -arg(raidmaxrecoveryrate_ARG, '\0', "raidmaxrecoveryrate", sizekb_VAL, 0, 0) -arg(raidminrecoveryrate_ARG, '\0', "raidminrecoveryrate", sizekb_VAL, 0, 0) -arg(raidsyncaction_ARG, '\0', "raidsyncaction", syncaction_VAL, 0, 0) -arg(raidwritebehind_ARG, '\0', "raidwritebehind", number_VAL, 0, 0) -arg(raidwritemostly_ARG, '\0', "raidwritemostly", writemostly_VAL, ARG_GROUPABLE, 0) -arg(readonly_ARG, '\0', "readonly", 0, 0, 0) -arg(refresh_ARG, '\0', "refresh", 0, 0, 0) -arg(removemissing_ARG, '\0', "removemissing", 0, 0, 0) -arg(rebuild_ARG, '\0', "rebuild", pv_VAL, ARG_GROUPABLE, 0) -arg(repair_ARG, '\0', "repair", 0, 0, 0) -arg(replace_ARG, '\0', "replace", pv_VAL, ARG_GROUPABLE, 0) -arg(reportformat_ARG, '\0', "reportformat", reportformat_VAL, 0, 0) -arg(restorefile_ARG, '\0', "restorefile", string_VAL, 0, 0) -arg(restoremissing_ARG, '\0', "restoremissing", 0, 0, 0) -arg(resync_ARG, '\0', "resync", 0, 0, 0) -arg(rows_ARG, '\0', "rows", 0, 0, 0) -arg(segments_ARG, '\0', "segments", 0, 0, 0) -arg(separator_ARG, '\0', "separator", string_VAL, 0, 0) -arg(shared_ARG, '\0', "shared", 0, 0, 0) -arg(sinceversion_ARG, '\0', "sinceversion", string_VAL, 0, 0) -arg(split_ARG, '\0', "split", 0, 0, 0) -arg(splitcache_ARG, '\0', "splitcache", 0, 0, 0) -arg(splitmirrors_ARG, '\0', "splitmirrors", number_VAL, 0, 0) -arg(splitsnapshot_ARG, '\0', "splitsnapshot", 0, 0, 0) -arg(showdeprecated_ARG, '\0', "showdeprecated", 0, 0, 0) -arg(showunsupported_ARG, '\0', "showunsupported", 0, 0, 0) -arg(startpoll_ARG, '\0', "startpoll", 0, 0, 0) -arg(stripes_long_ARG, '\0', "stripes", number_VAL, 0, 0) -arg(swapmetadata_ARG, '\0', "swapmetadata", 0, 0, 0) -arg(syncaction_ARG, '\0', "syncaction", syncaction_VAL, 0, 0) -arg(sysinit_ARG, '\0', "sysinit", 0, 0, 0) -arg(systemid_ARG, '\0', "systemid", string_VAL, 0, 0) -arg(thinpool_ARG, '\0', "thinpool", lv_VAL, 0, 0) -arg(trackchanges_ARG, '\0', "trackchanges", 0, 0, 0) -arg(trustcache_ARG, '\0', "trustcache", 0, 0, 0) -arg(type_ARG, '\0', "type", segtype_VAL, 0, 0) -arg(unbuffered_ARG, '\0', "unbuffered", 0, 0, 0) -arg(uncache_ARG, '\0', "uncache", 0, 0, 0) -arg(cachepolicy_ARG, '\0', "cachepolicy", string_VAL, 0, 0) -arg(cachesettings_ARG, '\0', "cachesettings", string_VAL, ARG_GROUPABLE, 0) -arg(unconfigured_ARG, '\0', "unconfigured", 0, 0, 0) -arg(units_ARG, '\0', "units", units_VAL, 0, 0) -arg(unquoted_ARG, '\0', "unquoted", 0, 0, 0) -arg(usepolicies_ARG, '\0', "usepolicies", 0, 0, 0) -arg(validate_ARG, '\0', "validate", 0, 0, 0) -arg(version_ARG, '\0', "version", 0, 0, 0) -arg(vgmetadatacopies_ARG, '\0', "vgmetadatacopies", vgmetadatacopies_VAL, 0, 0) -arg(virtualoriginsize_ARG, '\0', "virtualoriginsize", sizemb_VAL, 0, 0) -arg(withsummary_ARG, '\0', "withsummary", 0, 0, 0) -arg(withcomments_ARG, '\0', "withcomments", 0, 0, 0) -arg(withspaces_ARG, '\0', "withspaces", 0, 0, 0) -arg(withversions_ARG, '\0', "withversions", 0, 0, 0) -arg(writebehind_ARG, '\0', "writebehind", number_VAL, 0, 0) -arg(writemostly_ARG, '\0', "writemostly", writemostly_VAL, ARG_GROUPABLE, 0) +arg(ARG_UNUSED, '-', "", 0, 0, 0, NULL) /* place holder for unused 0 value */ + +arg(abort_ARG, '\0', "abort", 0, 0, 0, + "#pvmove\n" + "Abort any pvmove operations in progress. If a pvmove was started\n" + "with the --atomic option, then all LVs will remain on the source PV.\n" + "Otherwise, segments that have been moved will remain on the\n" + "destination PV, while unmoved segments will remain on the source PV.\n" + "#lvpoll\n" + "Stop processing a poll operation in lvmpolld.\n") + +arg(activationmode_ARG, '\0', "activationmode", activationmode_VAL, 0, 0, + "Determines if LV activation is allowed when PVs are missing,\n" + "e.g. because of a device failure.\n" + "\\fBcomplete\\fP only allows LVs with no missing PVs to be activated,\n" + "and is the most restrictive mode.\n" + "\\fBdegraded\\fP allows RAID LVs with missing PVs to be activated.\n" + "(This does not include the \"mirror\" type, see \"raid1\" instead.)\n" + "\\fBpartial\\fP allows any LV with missing PVs to be activated, and\n" + "should only be used for recovery or repair.\n" + "For default, see lvm.conf/activation_mode.\n") + +arg(addtag_ARG, '\0', "addtag", tag_VAL, ARG_GROUPABLE, 0, + "Adds a tag to a PV, VG or LV. This option can be repeated to add\n" + "multiple tags at once. See lvm(8) for information about tags.\n") + +arg(aligned_ARG, '\0', "aligned", 0, 0, 0, + "Use with --separator to align the output columns\n") + +arg(alloc_ARG, '\0', "alloc", alloc_VAL, 0, 0, + "Determines the allocation policy when a command needs to allocate\n" + "Physical Extents (PEs) from the VG. Each VG and LV has an allocation policy\n" + "which can be changed with vgchange/lvchange, or overriden on the\n" + "command line.\n" + "\\fBnormal\\fP applies common sense rules such as not placing parallel stripes\n" + "on the same PV.\n" + "\\fBinherit\\fP applies the VG policy to an LV.\n" + "\\fBcontiguous\\fP requires new PEs be placed adjacent to existing PEs.\n" + "\\fBcling\\fP places new PEs on the same PV as existing PEs in the same\n" + "stripe of the LV.\n" + "If there are sufficient PEs for an allocation, but normal does not\n" + "use them, \\fBanywhere\\fP will use them even if it reduces performance,\n" + "e.g. by placing two stripes on the same PV.\n" + "Optional positional PV args on the command line can also be used to limit\n" + "which PVs the command will use for allocation.\n") + +arg(atomic_ARG, '\0', "atomic", 0, 0, 0, + "Makes a pvmove operation atomic, ensuring that all affected LVs are\n" + "moved to the destination PV, or none are if the operation is aborted.\n") + +arg(atversion_ARG, '\0', "atversion", string_VAL, 0, 0, + "Specify an LVM version in x.y.z format where x is the major version,\n" + "the y is the minor version and z is the patchlevel (e.g. 2.2.106).\n" + "When configuration is displayed, the configuration settings recognized\n" + "at this LVM version will be considered only. This can be used\n" + "to display a configuration that a certain LVM version understands and\n" + "which does not contain any newer settings for which LVM would\n" + "issue a warning message when checking the configuration.\n") + +arg(binary_ARG, '\0', "binary", 0, 0, 0, + "Use binary values \"0\" or \"1\" instead of descriptive literal values\n" + "for columns that have exactly two valid values to report (not counting\n" + "the \"unknown\" value which denotes that the value could not be determined).\n") + +arg(bootloaderareasize_ARG, '\0', "bootloaderareasize", sizemb_VAL, 0, 0, + "Create a separate bootloader area of specified size besides PV's data\n" + "area. The bootloader area is an area of reserved space on the PV from\n" + "which LVM will not allocate any extents and it's kept untouched. This is\n" + "primarily aimed for use with bootloaders to embed their own data or metadata.\n" + "The start of the bootloader area is always aligned, see also --dataalignment\n" + "and --dataalignmentoffset. The bootloader area size may eventually\n" + "end up increased due to the alignment, but it's never less than the\n" + "size that is requested. To see the bootloader area start and size of\n" + "an existing PV use pvs -o +pv_ba_start,pv_ba_size.\n") + +arg(cache_long_ARG, '\0', "cache", 0, 0, 0, + "#pvscan\n" + "Scan one or more devices and send the metadata to lvmetad.\n" + "#vgscan\n" + "Scan all devices and send the metadata to lvmetad.\n" + "#lvscan\n" + "Scan the devices used by an LV and send the metadata to lvmetad.\n") + +arg(cachemode_ARG, '\0', "cachemode", cachemode_VAL, 0, 0, + "Specifies when writes to a cache LV should be considered complete.\n" + "\\fBwriteback\\fP considers a write complete as soon as it is\n" + "stored in the cache pool.\n" + "\\fBwritethough\\fP considers a write complete only when it has\n" + "been stored in both the cache pool and on the origin LV.\n" + "While writethrough may be slower for writes, it is more\n" + "resilient if something should happen to a device associated with the\n" + "cache pool LV. With writethrough, all reads are served\n" + "from the origin LV (all reads miss the cache) and all writes are\n" + "forwarded to the origin LV; additionally, write hits cause cache\n" + "block invalidates. See lvmcache(7) for more information.\n") + +arg(cachepool_ARG, '\0', "cachepool", lv_VAL, 0, 0, + "The name of a cache pool LV.\n") + +arg(commandprofile_ARG, '\0', "commandprofile", string_VAL, 0, 0, + "The command profile to use for command configuration.\n" + "See lvm.conf(5) for more information about profiles.\n") + +arg(config_ARG, '\0', "config", string_VAL, 0, 0, + "Config settings for the command. These override lvm.conf settings.\n" + "The String arg uses the same format as lvm.conf,\n" + "or may use section/field syntax.\n" + "See lvm.conf(5) for more information about config.\n") + +arg(configreport_ARG, '\0', "configreport", configreport_VAL, ARG_GROUPABLE, 1, + "See lvmreport(7).\n") + +arg(configtype_ARG, '\0', "typeconfig", configtype_VAL, 0, 0, + "See lvmreport(7).\n") + +arg(corelog_ARG, '\0', "corelog", 0, 0, 0, + "An alias for --mirrorlog core.\n") + +arg(dataalignment_ARG, '\0', "dataalignment", sizekb_VAL, 0, 0, + "Align the start of the data to a multiple of this number.\n" + "Also specify an appropriate Physical Extent size when creating a VG.\n" + "To see the location of the first Physical Extent of an existing PV,\n" + "use pvs -o +pe_start. In addition, it may be shifted by an alignment offset.\n" + "See lvm.conf/data_alignment_offset_detection and --dataalignmentoffset.\n") + +arg(dataalignmentoffset_ARG, '\0', "dataalignmentoffset", sizekb_VAL, 0, 0, + "Shift the start of the data area by this additional offset.\n") + +arg(deltag_ARG, '\0', "deltag", tag_VAL, ARG_GROUPABLE, 0, + "Deletes a tag from a PV, VG or LV. This option can be repeated to delete\n" + "multiple tags at once. See lvm(8) for information about tags.\n") + +arg(detachprofile_ARG, '\0', "detachprofile", 0, 0, 0, + "Detaches a metadata profile from a VG or LV.\n" + "See lvm.conf(5) for more information about profiles.\n") + +arg(discards_ARG, '\0', "discards", discards_VAL, 0, 0, + "Specifies how the device-mapper thin pool layer in the kernel should\n" + "handle discards.\n" + "\\fBignore\\fP causes the thin pool to ignore discards.\n" + "\\fBnopassdown\\fP causes the thin pool to process discards itself to\n" + "allow reuse of unneeded extents in the thin pool.\n" + "\\fBpassdown\\fP causes the thin pool to process discards itself\n" + "(like nopassdown) and pass the discards to the underlying device.\n") + +arg(driverloaded_ARG, '\0', "driverloaded", bool_VAL, 0, 0, + "If set to no, the command will not attempt to use device-mapper.\n" + "For testing and debugging.\n") + +arg(errorwhenfull_ARG, '\0', "errorwhenfull", bool_VAL, 0, 0, + "Specifies thin pool behavior when data space is exhausted.\n" + "When yes, device-mapper will immediately return an error\n" + "when a thin pool is full and an I/O request requires space.\n" + "When no, device-mapper will queue these I/O requests for a\n" + "period of time to allow the thin pool to be extended.\n" + "Errors are returned if no space is available after the timeout.\n" + "(Also see dm-thin-pool kernel module option no_space_timeout.)\n") + +arg(force_long_ARG, '\0', "force", 0, ARG_COUNTABLE, 0, NULL) + +arg(foreign_ARG, '\0', "foreign", 0, 0, 0, + "Report foreign VGs that would otherwise be skipped.\n" + "See lvmsystemid(7) for more information about foreign VGs.\n") + +arg(handlemissingpvs_ARG, '\0', "handlemissingpvs", 0, 0, 0, + "Allows a polling operation to continue when PVs are missing,\n" + "e.g. for repairs due to faulty devices.\n") + +arg(ignoreadvanced_ARG, '\0', "ignoreadvanced", 0, 0, 0, + "Exclude advanced configuration settings from the output.\n") + +arg(ignorelocal_ARG, '\0', "ignorelocal", 0, 0, 0, + "Ignore local section.\n") + +arg(ignorelockingfailure_ARG, '\0', "ignorelockingfailure", 0, 0, 0, + "Allows a command to continue with read-only metadata\n" + "operations after locking failures.\n") + +arg(ignoremonitoring_ARG, '\0', "ignoremonitoring", 0, 0, 0, + "Do not interact with dmeventd unless --monitor is specified.\n" + "Do not use this if dmeventd is already monitoring a device.\n") + +arg(ignoreskippedcluster_ARG, '\0', "ignoreskippedcluster", 0, 0, 0, + "Use to avoid exiting with an non-zero status code if the command is run\n" + "without clustered locking and clustered VGs are skipped.\n") + +arg(ignoreunsupported_ARG, '\0', "ignoreunsupported", 0, 0, 0, + "Exclude unsupported configuration settings from the output. These settings are\n" + "either used for debugging and development purposes only or their support is not\n" + "yet complete and they are not meant to be used in production. The \\fBcurrent\\fP\n" + "and \\fBdiff\\fP types include unsupported settings in their output by default,\n" + "all the other types ignore unsupported settings.\n") + +arg(labelsector_ARG, '\0', "labelsector", number_VAL, 0, 0, + "By default the PV is labelled with an LVM2 identifier in its second\n" + "sector (sector 1). This lets you use a different sector near the\n" + "start of the disk (between 0 and 3 inclusive - see LABEL_SCAN_SECTORS\n" + "in the source). Use with care.\n") + +arg(lockopt_ARG, '\0', "lockopt", string_VAL, 0, 0, + "Used to pass options for special cases to lvmlockd.\n" + "See lvmlockd(8) for more information.\n") + +arg(lockstart_ARG, '\0', "lockstart", 0, 0, 0, + "Start the lockspace of a shared VG in lvmlockd.\n" + "lvmlockd locks becomes available for the VG, allowing LVM to use the VG.\n" + "See lvmlockd(8) for more information.\n") + +arg(lockstop_ARG, '\0', "lockstop", 0, 0, 0, + "Stop the lockspace of a shared VG in lvmlockd.\n" + "lvmlockd locks become unavailable for the VG, preventing LVM from using the VG.\n" + "See lvmlockd(8) for more information.\n") + +arg(locktype_ARG, '\0', "locktype", locktype_VAL, 0, 0, + "#vgchange\n" + "Change the VG lock type to or from a shared lock type used with lvmlockd.\n" + "See lvmlockd(8) for more information.\n" + "#vgcreate\n" + "Specify the VG lock type directly in place of using --shared.\n" + "See lvmlockd(8) for more information.\n") + +arg(logonly_ARG, '\0', "logonly", 0, 0, 0, + "Suppress command report and display only log report.\n") + +arg(maxrecoveryrate_ARG, '\0', "maxrecoveryrate", sizekb_VAL, 0, 0, + "Sets the maximum recovery rate for a RAID LV. The rate value\n" + "is an amount of data per second for each device in the array.\n" + "Setting the rate to 0 means it will be unbounded.\n") + +arg(merge_ARG, '\0', "merge", 0, 0, 0, + "An alias for --mergethin, --mergemirrors, or --mergesnapshot,\n" + "depending on the type of LV.\n") + +arg(mergemirrors_ARG, '\0', "mergemirrors", 0, 0, 0, + "Merge LV images that were split from a raid1 LV.\n" + "See --splitmirrors with --trackchanges.\n") + +arg(mergesnapshot_ARG, '\0', "mergesnapshot", 0, 0, 0, + "Merge COW snapshot LV into its origin.\n" + "When merging a snapshot, if both the origin and snapshot LVs are not open,\n" + "the merge will start immediately. Otherwise, the merge will start the\n" + "first time either the origin or snapshot LV are activated and both are\n" + "closed. Merging a snapshot into an origin that cannot be closed, for\n" + "example a root filesystem, is deferred until the next time the origin\n" + "volume is activated. When merging starts, the resulting LV will have the\n" + "origin's name, minor number and UUID. While the merge is in progress,\n" + "reads or writes to the origin appear as being directed to the snapshot\n" + "being merged. When the merge finishes, the merged snapshot is removed.\n" + "Multiple snapshots may be specified on the command line or a @tag may be\n" + "used to specify multiple snapshots be merged to their respective origin.\n") + +arg(mergethin_ARG, '\0', "mergethin", 0, 0, 0, + "Merge thin LV into its origin LV.\n" + "The origin thin LV takes the content of the thin snapshot,\n" + "and the thin snapshot LV is removed.\n") + +arg(mergedconfig_ARG, '\0', "mergedconfig", 0, 0, 0, + "When the command is run with --config\n" + "and/or --commandprofile (or using LVM_COMMAND_PROFILE\n" + "environment variable), --profile, or --metadataprofile,\n" + "merge all the contents of the \"config cascade\" before displaying it.\n" + "Without merging, only the configuration at the front of the\n" + "cascade is displayed.\n" + "See lvm.conf(5) for more information about config.\n") + +arg(metadatacopies_ARG, '\0', "metadatacopies", metadatacopies_VAL, 0, 0, + "For commands starting with 'pv', this is an alias for --pvmetadatacopies.\n" + "For commands starting with 'vg', this is an alias for --vgmetadatacopies.\n") + +arg(metadataignore_ARG, '\0', "metadataignore", bool_VAL, 0, 0, + "Specifies the metadataignore property of a PV.\n" + "If yes, metadata areas on the PV are ignored, and lvm will\n" + "not store metadata in the metadata areas of the PV.\n" + "If no, lvm will store metadata on the PV.\n") + +arg(metadataprofile_ARG, '\0', "metadataprofile", string_VAL, 0, 0, + "The metadata profile to use for command configuration.\n" + "See lvm.conf(5) for more information about profiles.\n") + +arg(metadatasize_ARG, '\0', "metadatasize", sizemb_VAL, 0, 0, + "The approximate amount of space used for each VG metadata area.\n" + "The size may be rounded.\n") + +arg(minor_ARG, '\0', "minor", number_VAL, ARG_GROUPABLE, 0, + "A block device minor number.\n") + +arg(minrecoveryrate_ARG, '\0', "minrecoveryrate", sizekb_VAL, 0, 0, + "Sets the minimum recovery rate for a RAID LV. The rate value\n" + "is an amount of data per second for each device in the array.\n" + "Setting the rate to 0 means it will be unbounded.\n") + +arg(mirrorlog_ARG, '\0', "mirrorlog", mirrorlog_VAL, 0, 0, + "Specifies the type of mirror log for LVs with the \"mirror\" type\n" + "(does not apply to the \"raid1\" type.)\n" + "\\fBdisk\\fP is a persistent log and requires a small amount of\n" + "storage space, usually on a separate device from the data being mirrored.\n" + "\\fBcore\\fP is not persistent; the log is kept only in memory.\n" + "In this case, the mirror must be synchronized (by copying LV data from\n" + "the first device to others) each time the LV is activated, e.g. after reboot.\n" + "\\fBmirrored\\fP is a persistent log that is itself mirrored.\n") + +arg(mirrorsonly_ARG, '\0', "mirrorsonly", 0, 0, 0, NULL) + +arg(mknodes_ARG, '\0', "mknodes", 0, 0, 0, + "Also checks the LVM special files in /dev that are needed for active\n" + "LVs and creates any missing ones and removes unused ones.\n") + +arg(monitor_ARG, '\0', "monitor", bool_VAL, 0, 0, + "Start (yes) or stop (no) monitoring an LV with dmeventd.\n" + "dmeventd monitors kernel events for an LV, and performs\n" + "automated maintenance for the LV in reponse to specific events.\n" + "See dmeventd(8) for more information.\n") + +arg(nameprefixes_ARG, '\0', "nameprefixes", 0, 0, 0, + "Add an \"LVM2_\" prefix plus the field name to the output. Useful\n" + "with --noheadings to produce a list of field=value pairs that can\n" + "be used to set environment variables (for example, in udev rules).\n") + +arg(noheadings_ARG, '\0', "noheadings", 0, 0, 0, + "Suppress the headings line that is normally the first line of output.\n" + "Useful if grepping the output.\n") + +arg(nohistory_ARG, '\0', "nohistory", 0, 0, 0, + "Do not record history of LVs being removed.\n" + "This has no effect unless the configuration setting\n" + "metadata/record_lvs_history is enabled.\n") + +arg(nolocking_ARG, '\0', "nolocking", 0, 0, 0, + "Disable locking.\n") + +arg(norestorefile_ARG, '\0', "norestorefile", 0, 0, 0, + "In conjunction with --uuid, this allows a uuid to be specified\n" + "without also requiring that a backup of the metadata be provided.\n") + +arg(nosuffix_ARG, '\0', "nosuffix", 0, 0, 0, + "Suppress the suffix on output sizes. Use with --units\n" + "(except h and H) if processing the output.\n") + +arg(nosync_ARG, '\0', "nosync", 0, 0, 0, + "Causes the creation of mirror, raid1, raid4, raid5 and raid10 to skip the\n" + "initial synchronization. In case of mirror, raid1 and raid10, any data\n" + "written afterwards will be mirrored, but the original contents will not be\n" + "copied. In case of raid4 and raid5, no parity blocks will be written,\n" + "though any data written afterwards will cause parity blocks to be stored.\n" + "This is useful for skipping a potentially long and resource intensive initial\n" + "sync of an empty mirror/raid1/raid4/raid5 and raid10 LV.\n" + "This option is not valid for raid6, because raid6 relies on proper parity\n" + "(P and Q Syndromes) being created during initial synchronization in order\n" + "to reconstruct proper user date in case of device failures.\n" + "raid0 and raid0_meta do not provide any data copies or parity support\n" + "and thus do not support initial synchronization.\n") + +arg(notifydbus_ARG, '\0', "notifydbus", 0, 0, 0, + "Send a notification to D-Bus. The command will exit with an error\n" + "if LVM is not built with support for D-Bus notification, or if the\n" + "notify_dbus config setting is disabled.\n") + +arg(noudevsync_ARG, '\0', "noudevsync", 0, 0, 0, + "Disables udev synchronisation. The process will not wait for notification\n" + "from udev. It will continue irrespective of any possible udev processing\n" + "in the background. Only use this if udev is not running or has rules that\n" + "ignore the devices LVM creates.\n) + +arg(originname_ARG, '\0', "originname", lv_VAL, 0, 0, NULL) +arg(physicalvolumesize_ARG, '\0', "setphysicalvolumesize", sizemb_VAL, 0, 0, NULL) +arg(poll_ARG, '\0', "poll", bool_VAL, 0, 0, NULL) +arg(polloperation_ARG, '\0', "polloperation", polloperation_VAL, 0, 0, NULL) +arg(pooldatasize_ARG, '\0', "pooldatasize", sizemb_VAL, 0, 0, NULL) +arg(poolmetadata_ARG, '\0', "poolmetadata", lv_VAL, 0, 0, NULL) +arg(poolmetadatasize_ARG, '\0', "poolmetadatasize", sizemb_VAL, 0, 0, NULL) +arg(poolmetadataspare_ARG, '\0', "poolmetadataspare", bool_VAL, 0, 0, NULL) + +arg(profile_ARG, '\0', "profile", string_VAL, 0, 0, + "An alias for --commandprofile or --metadataprofile, depending\n" + "on the command.\n") + +arg(pvmetadatacopies_ARG, '\0', "pvmetadatacopies", pvmetadatacopies_VAL, 0, 0, NULL) +arg(raidrebuild_ARG, '\0', "raidrebuild", pv_VAL, ARG_GROUPABLE, 0, NULL) +arg(raidmaxrecoveryrate_ARG, '\0', "raidmaxrecoveryrate", sizekb_VAL, 0, 0, NULL) +arg(raidminrecoveryrate_ARG, '\0', "raidminrecoveryrate", sizekb_VAL, 0, 0, NULL) +arg(raidsyncaction_ARG, '\0', "raidsyncaction", syncaction_VAL, 0, 0, NULL) +arg(raidwritebehind_ARG, '\0', "raidwritebehind", number_VAL, 0, 0, NULL) +arg(raidwritemostly_ARG, '\0', "raidwritemostly", writemostly_VAL, ARG_GROUPABLE, 0, NULL) +arg(readonly_ARG, '\0', "readonly", 0, 0, 0, NULL) +arg(refresh_ARG, '\0', "refresh", 0, 0, 0, NULL) +arg(removemissing_ARG, '\0', "removemissing", 0, 0, 0, NULL) +arg(rebuild_ARG, '\0', "rebuild", pv_VAL, ARG_GROUPABLE, 0, NULL) +arg(repair_ARG, '\0', "repair", 0, 0, 0, NULL) +arg(replace_ARG, '\0', "replace", pv_VAL, ARG_GROUPABLE, 0, NULL) +arg(reportformat_ARG, '\0', "reportformat", reportformat_VAL, 0, 0, NULL) +arg(restorefile_ARG, '\0', "restorefile", string_VAL, 0, 0, NULL) +arg(restoremissing_ARG, '\0', "restoremissing", 0, 0, 0, NULL) +arg(resync_ARG, '\0', "resync", 0, 0, 0, NULL) +arg(rows_ARG, '\0', "rows", 0, 0, 0, NULL) +arg(segments_ARG, '\0', "segments", 0, 0, 0, NULL) +arg(separator_ARG, '\0', "separator", string_VAL, 0, 0, NULL) +arg(shared_ARG, '\0', "shared", 0, 0, 0, NULL) +arg(sinceversion_ARG, '\0', "sinceversion", string_VAL, 0, 0, NULL) +arg(split_ARG, '\0', "split", 0, 0, 0, NULL) +arg(splitcache_ARG, '\0', "splitcache", 0, 0, 0, NULL) +arg(splitmirrors_ARG, '\0', "splitmirrors", number_VAL, 0, 0, NULL) +arg(splitsnapshot_ARG, '\0', "splitsnapshot", 0, 0, 0, NULL) +arg(showdeprecated_ARG, '\0', "showdeprecated", 0, 0, 0, NULL) +arg(showunsupported_ARG, '\0', "showunsupported", 0, 0, 0, NULL) +arg(startpoll_ARG, '\0', "startpoll", 0, 0, 0, NULL) +arg(stripes_long_ARG, '\0', "stripes", number_VAL, 0, 0, NULL) +arg(swapmetadata_ARG, '\0', "swapmetadata", 0, 0, 0, NULL) +arg(syncaction_ARG, '\0', "syncaction", syncaction_VAL, 0, 0, NULL) +arg(sysinit_ARG, '\0', "sysinit", 0, 0, 0, NULL) +arg(systemid_ARG, '\0', "systemid", string_VAL, 0, 0, NULL) +arg(thinpool_ARG, '\0', "thinpool", lv_VAL, 0, 0, NULL) +arg(trackchanges_ARG, '\0', "trackchanges", 0, 0, 0, NULL) +arg(trustcache_ARG, '\0', "trustcache", 0, 0, 0, NULL) +arg(type_ARG, '\0', "type", segtype_VAL, 0, 0, NULL) +arg(unbuffered_ARG, '\0', "unbuffered", 0, 0, 0, NULL) +arg(uncache_ARG, '\0', "uncache", 0, 0, 0, NULL) +arg(cachepolicy_ARG, '\0', "cachepolicy", string_VAL, 0, 0, NULL) +arg(cachesettings_ARG, '\0', "cachesettings", string_VAL, ARG_GROUPABLE, 0, NULL) +arg(unconfigured_ARG, '\0', "unconfigured", 0, 0, 0, NULL) +arg(units_ARG, '\0', "units", units_VAL, 0, 0, NULL) +arg(unquoted_ARG, '\0', "unquoted", 0, 0, 0, NULL) +arg(usepolicies_ARG, '\0', "usepolicies", 0, 0, 0, NULL) +arg(validate_ARG, '\0', "validate", 0, 0, 0, NULL) +arg(version_ARG, '\0', "version", 0, 0, 0, NULL) +arg(vgmetadatacopies_ARG, '\0', "vgmetadatacopies", vgmetadatacopies_VAL, 0, 0, NULL) +arg(virtualoriginsize_ARG, '\0', "virtualoriginsize", sizemb_VAL, 0, 0, NULL) +arg(withsummary_ARG, '\0', "withsummary", 0, 0, 0, NULL) +arg(withcomments_ARG, '\0', "withcomments", 0, 0, 0, NULL) +arg(withspaces_ARG, '\0', "withspaces", 0, 0, 0, NULL) +arg(withversions_ARG, '\0', "withversions", 0, 0, 0, NULL) +arg(writebehind_ARG, '\0', "writebehind", number_VAL, 0, 0, NULL) +arg(writemostly_ARG, '\0', "writemostly", writemostly_VAL, ARG_GROUPABLE, 0, NULL) /* Allow some variations */ -arg(allocation_ARG, '\0', "allocation", bool_VAL, 0, 0) -arg(available_ARG, '\0', "available", activation_VAL, 0, 0) -arg(resizable_ARG, '\0', "resizable", bool_VAL, 0, 0) +arg(allocation_ARG, '\0', "allocation", bool_VAL, 0, 0, NULL) +arg(available_ARG, '\0', "available", activation_VAL, 0, 0, NULL) +arg(resizable_ARG, '\0', "resizable", bool_VAL, 0, 0, NULL) /* * ... and now the short args. */ -arg(activate_ARG, 'a', "activate", activation_VAL, 0, 0) -arg(all_ARG, 'a', "all", 0, 0, 0) -arg(autobackup_ARG, 'A', "autobackup", bool_VAL, 0, 0) -arg(activevolumegroups_ARG, 'A', "activevolumegroups", 0, 0, 0) -arg(background_ARG, 'b', "background", 0, 0, 0) -arg(backgroundfork_ARG, 'b', "background", 0, 0, 0) -arg(basevgname_ARG, 'n', "basevgname", string_VAL, 0, 0) -arg(blockdevice_ARG, 'b', "blockdevice", 0, 0, 0) -arg(chunksize_ARG, 'c', "chunksize", sizekb_VAL, 0, 0) -arg(clustered_ARG, 'c', "clustered", bool_VAL, 0, 0) -arg(colon_ARG, 'c', "colon", 0, 0, 0) -arg(columns_ARG, 'C', "columns", 0, 0, 0) -arg(contiguous_ARG, 'C', "contiguous", bool_VAL, 0, 0) -arg(debug_ARG, 'd', "debug", 0, ARG_COUNTABLE, 0) -arg(exported_ARG, 'e', "exported", 0, 0, 0) -arg(physicalextent_ARG, 'E', "physicalextent", 0, 0, 0) -arg(file_ARG, 'f', "file", string_VAL, 0, 0) -arg(force_ARG, 'f', "force", 0, ARG_COUNTABLE, 0) -arg(full_ARG, 'f', "full", 0, 0, 0) -arg(help_ARG, 'h', "help", 0, ARG_COUNTABLE, 0) -arg(cache_ARG, 'H', "cache", 0, 0, 0) -arg(history_ARG, 'H', "history", 0, 0, 0) -arg(help2_ARG, '?', "", 0, 0, 0) -arg(import_ARG, 'i', "import", 0, 0, 0) -arg(interval_ARG, 'i', "interval", number_VAL, 0, 0) -arg(iop_version_ARG, 'i', "iop_version", 0, 0, 0) -arg(stripes_ARG, 'i', "stripes", number_VAL, 0, 0) -arg(stripesize_ARG, 'I', "stripesize", sizekb_VAL, 0, 0) -arg(logicalvolume_ARG, 'l', "logicalvolume", number_VAL, 0, 0) -arg(maxlogicalvolumes_ARG, 'l', "maxlogicalvolumes", number_VAL, 0, 0) -arg(extents_ARG, 'l', "extents", numsignedper_VAL, 0, 0) -arg(list_ARG, 'l', "list", 0, 0, 0) -arg(lvmpartition_ARG, 'l', "lvmpartition", 0, 0, 0) -arg(size_ARG, 'L', "size", sizemb_VAL, 0, 0) -arg(persistent_ARG, 'M', "persistent", bool_VAL, 0, 0) -arg(major_ARG, 'j', "major", number_VAL, ARG_GROUPABLE, 0) -arg(setactivationskip_ARG, 'k', "setactivationskip", bool_VAL, 0, 0) -arg(ignoreactivationskip_ARG, 'K', "ignoreactivationskip", 0, 0, 0) -arg(maps_ARG, 'm', "maps", 0, 0, 0) -arg(mirrors_ARG, 'm', "mirrors", numsigned_VAL, 0, 0) -arg(metadatatype_ARG, 'M', "metadatatype", metadatatype_VAL, 0, 0) -arg(name_ARG, 'n', "name", string_VAL, 0, 0) -arg(nofsck_ARG, 'n', "nofsck", 0, 0, 0) -arg(novolumegroup_ARG, 'n', "novolumegroup", 0, 0, 0) -arg(oldpath_ARG, 'n', "oldpath", 0, 0, 0) -arg(options_ARG, 'o', "options", string_VAL, ARG_GROUPABLE, 0) -arg(sort_ARG, 'O', "sort", string_VAL, ARG_GROUPABLE, 0) -arg(maxphysicalvolumes_ARG, 'p', "maxphysicalvolumes", uint32_VAL, 0, 0) -arg(permission_ARG, 'p', "permission", permission_VAL, 0, 0) -arg(partial_ARG, 'P', "partial", 0, 0, 0) -arg(physicalvolume_ARG, 'P', "physicalvolume", 0, 0, 0) -arg(quiet_ARG, 'q', "quiet", 0, ARG_COUNTABLE, 0) -arg(readahead_ARG, 'r', "readahead", readahead_VAL, 0, 0) -arg(resizefs_ARG, 'r', "resizefs", 0, 0, 0) -arg(reset_ARG, 'R', "reset", 0, 0, 0) -arg(regionsize_ARG, 'R', "regionsize", sizemb_VAL, 0, 0) -arg(physicalextentsize_ARG, 's', "physicalextentsize", sizemb_VAL, 0, 0) -arg(snapshot_ARG, 's', "snapshot", 0, 0, 0) -arg(short_ARG, 's', "short", 0, 0, 0) -arg(stdin_ARG, 's', "stdin", 0, 0, 0) -arg(select_ARG, 'S', "select", string_VAL, ARG_GROUPABLE, 0) -arg(test_ARG, 't', "test", 0, 0, 0) -arg(thin_ARG, 'T', "thin", 0, 0, 0) -arg(uuid_ARG, 'u', "uuid", 0, 0, 0) -arg(uuidstr_ARG, 'u', "uuid", string_VAL, 0, 0) -arg(uuidlist_ARG, 'U', "uuidlist", 0, 0, 0) -arg(verbose_ARG, 'v', "verbose", 0, ARG_COUNTABLE, 0) -arg(volumegroup_ARG, 'V', "volumegroup", 0, 0, 0) -arg(virtualsize_ARG, 'V', "virtualsize", sizemb_VAL, 0, 0) -arg(wipesignatures_ARG, 'W', "wipesignatures", bool_VAL, 0, 0) -arg(allocatable_ARG, 'x', "allocatable", bool_VAL, 0, 0) -arg(resizeable_ARG, 'x', "resizeable", bool_VAL, 0, 0) -arg(yes_ARG, 'y', "yes", 0, 0, 0) -arg(zero_ARG, 'Z', "zero", bool_VAL, 0, 0) +arg(activate_ARG, 'a', "activate", activation_VAL, 0, 0, NULL) +arg(all_ARG, 'a', "all", 0, 0, 0, NULL) +arg(autobackup_ARG, 'A', "autobackup", bool_VAL, 0, 0, NULL) +arg(activevolumegroups_ARG, 'A', "activevolumegroups", 0, 0, 0, NULL) +arg(background_ARG, 'b', "background", 0, 0, 0, NULL) +arg(backgroundfork_ARG, 'b', "background", 0, 0, 0, NULL) +arg(basevgname_ARG, 'n', "basevgname", string_VAL, 0, 0, NULL) +arg(blockdevice_ARG, 'b', "blockdevice", 0, 0, 0, NULL) +arg(chunksize_ARG, 'c', "chunksize", sizekb_VAL, 0, 0, NULL) +arg(clustered_ARG, 'c', "clustered", bool_VAL, 0, 0, NULL) +arg(colon_ARG, 'c', "colon", 0, 0, 0, NULL) +arg(columns_ARG, 'C', "columns", 0, 0, 0, NULL) +arg(contiguous_ARG, 'C', "contiguous", bool_VAL, 0, 0, NULL) +arg(debug_ARG, 'd', "debug", 0, ARG_COUNTABLE, 0, NULL) +arg(exported_ARG, 'e', "exported", 0, 0, 0, NULL) +arg(physicalextent_ARG, 'E', "physicalextent", 0, 0, 0, NULL) +arg(file_ARG, 'f', "file", string_VAL, 0, 0, NULL) +arg(force_ARG, 'f', "force", 0, ARG_COUNTABLE, 0, NULL) +arg(full_ARG, 'f', "full", 0, 0, 0, NULL) +arg(help_ARG, 'h', "help", 0, ARG_COUNTABLE, 0, NULL) +arg(cache_ARG, 'H', "cache", 0, 0, 0, NULL) +arg(history_ARG, 'H', "history", 0, 0, 0, NULL) +arg(help2_ARG, '?', "", 0, 0, 0, NULL) +arg(import_ARG, 'i', "import", 0, 0, 0, NULL) +arg(interval_ARG, 'i', "interval", number_VAL, 0, 0, NULL) +arg(iop_version_ARG, 'i', "iop_version", 0, 0, 0, NULL) +arg(stripes_ARG, 'i', "stripes", number_VAL, 0, 0, NULL) +arg(stripesize_ARG, 'I', "stripesize", sizekb_VAL, 0, 0, NULL) +arg(logicalvolume_ARG, 'l', "logicalvolume", number_VAL, 0, 0, NULL) +arg(maxlogicalvolumes_ARG, 'l', "maxlogicalvolumes", number_VAL, 0, 0, NULL) +arg(extents_ARG, 'l', "extents", numsignedper_VAL, 0, 0, NULL) +arg(list_ARG, 'l', "list", 0, 0, 0, NULL) +arg(lvmpartition_ARG, 'l', "lvmpartition", 0, 0, 0, NULL) +arg(size_ARG, 'L', "size", sizemb_VAL, 0, 0, NULL) +arg(persistent_ARG, 'M', "persistent", bool_VAL, 0, 0, NULL) +arg(major_ARG, 'j', "major", number_VAL, ARG_GROUPABLE, 0, NULL) +arg(setactivationskip_ARG, 'k', "setactivationskip", bool_VAL, 0, 0, NULL) +arg(ignoreactivationskip_ARG, 'K', "ignoreactivationskip", 0, 0, 0, NULL) +arg(maps_ARG, 'm', "maps", 0, 0, 0, NULL) +arg(mirrors_ARG, 'm', "mirrors", numsigned_VAL, 0, 0, NULL) +arg(metadatatype_ARG, 'M', "metadatatype", metadatatype_VAL, 0, 0, NULL) +arg(name_ARG, 'n', "name", string_VAL, 0, 0, NULL) +arg(nofsck_ARG, 'n', "nofsck", 0, 0, 0, NULL) +arg(novolumegroup_ARG, 'n', "novolumegroup", 0, 0, 0, NULL) +arg(oldpath_ARG, 'n', "oldpath", 0, 0, 0, NULL) +arg(options_ARG, 'o', "options", string_VAL, ARG_GROUPABLE, 0, NULL) +arg(sort_ARG, 'O', "sort", string_VAL, ARG_GROUPABLE, 0, NULL) +arg(maxphysicalvolumes_ARG, 'p', "maxphysicalvolumes", uint32_VAL, 0, 0, NULL) +arg(permission_ARG, 'p', "permission", permission_VAL, 0, 0, NULL) +arg(partial_ARG, 'P', "partial", 0, 0, 0, NULL) +arg(physicalvolume_ARG, 'P', "physicalvolume", 0, 0, 0, NULL) +arg(quiet_ARG, 'q', "quiet", 0, ARG_COUNTABLE, 0, NULL) +arg(readahead_ARG, 'r', "readahead", readahead_VAL, 0, 0, NULL) +arg(resizefs_ARG, 'r', "resizefs", 0, 0, 0, NULL) +arg(reset_ARG, 'R', "reset", 0, 0, 0, NULL) +arg(regionsize_ARG, 'R', "regionsize", sizemb_VAL, 0, 0, NULL) +arg(physicalextentsize_ARG, 's', "physicalextentsize", sizemb_VAL, 0, 0, NULL) +arg(snapshot_ARG, 's', "snapshot", 0, 0, 0, NULL) +arg(short_ARG, 's', "short", 0, 0, 0, NULL) +arg(stdin_ARG, 's', "stdin", 0, 0, 0, NULL) +arg(select_ARG, 'S', "select", string_VAL, ARG_GROUPABLE, 0, NULL) +arg(test_ARG, 't', "test", 0, 0, 0, NULL) +arg(thin_ARG, 'T', "thin", 0, 0, 0, NULL) +arg(uuid_ARG, 'u', "uuid", 0, 0, 0, NULL) +arg(uuidstr_ARG, 'u', "uuid", string_VAL, 0, 0, NULL) +arg(uuidlist_ARG, 'U', "uuidlist", 0, 0, 0, NULL) +arg(verbose_ARG, 'v', "verbose", 0, ARG_COUNTABLE, 0, NULL) +arg(volumegroup_ARG, 'V', "volumegroup", 0, 0, 0, NULL) +arg(virtualsize_ARG, 'V', "virtualsize", sizemb_VAL, 0, 0, NULL) +arg(wipesignatures_ARG, 'W', "wipesignatures", bool_VAL, 0, 0, NULL) +arg(allocatable_ARG, 'x', "allocatable", bool_VAL, 0, 0, NULL) +arg(resizeable_ARG, 'x', "resizeable", bool_VAL, 0, 0, NULL) +arg(yes_ARG, 'y', "yes", 0, 0, 0, NULL) +arg(zero_ARG, 'Z', "zero", bool_VAL, 0, 0, NULL) /* this should always be last */ -arg(ARG_COUNT, '-', "", 0, 0, 0) +arg(ARG_COUNT, '-', "", 0, 0, 0, NULL) /* *INDENT-ON* */ diff --git a/tools/create-commands.c b/tools/create-commands.c index d9f82186f..9633bb5ae 100644 --- a/tools/create-commands.c +++ b/tools/create-commands.c @@ -68,6 +68,7 @@ struct opt_name { int val_enum; /* xyz_VAL when --foo takes a val like "--foo xyz" */ uint32_t unused1; uint32_t unused2; + const char *desc; }; /* also see val_props in tools.h and vals.h */ @@ -104,7 +105,7 @@ enum { /* create foo_ARG enums for --option's */ enum { -#define arg(a, b, c, d, e, f) a , +#define arg(a, b, c, d, e, f, g) a , #include "args.h" #undef arg }; @@ -136,7 +137,7 @@ static struct val_name val_names[VAL_COUNT + 1] = { /* create table of option names, e.g. --foo, and corresponding enum from args.h */ static struct opt_name opt_names[ARG_COUNT + 1] = { -#define arg(a, b, c, d, e, f) { # a, a, b, "", "--" c, d, e, f }, +#define arg(a, b, c, d, e, f, g) { # a, a, b, "", "--" c, d, e, f, g }, #include "args.h" #undef arg }; @@ -180,9 +181,15 @@ static struct cmd_name cmd_names[MAX_CMD_NAMES] = { #undef xx }; +/* array of pointers into opt_names[] that is sorted alphabetically (by long opt name) */ + +static struct opt_name *opt_names_alpha[ARG_COUNT + 1]; + #define MAX_LINE 1024 #define MAX_LINE_ARGC 256 +#define DESC_LINE 256 + #define REQUIRED 1 /* required option */ #define OPTIONAL 0 /* optional option */ #define IGNORE -1 /* ignore option */ @@ -2050,6 +2057,23 @@ void print_man_usage(struct command *cmd) printf("\n"); } +/* + * common options listed in the usage section. + * + * For commands with only one variant, this is only + * the options which are common to all lvm commands + * (in lvm_all, see is_lvm_all_opt). + * + * For commands with more than one variant, this + * is the set of options common to all variants + * (in cname->common_options), (which obviously + * includes the options common to all lvm commands.) + * + * List ordering: + * options with short+long names, alphabetically, + * then options with only long names, alphabetically + */ + void print_man_usage_common(struct command *cmd) { struct cmd_name *cname; @@ -2063,23 +2087,17 @@ void print_man_usage_common(struct command *cmd) printf(".RS 4\n"); printf("["); - /* - * when there's more than one variant, options that - * are common to all commands with a common name. - */ - - if (cname->variants < 2) - goto all; - /* print those with short opts */ - for (opt_enum = 0; opt_enum < ARG_COUNT; opt_enum++) { + for (i = 0; i < ARG_COUNT; i++) { + opt_enum = opt_names_alpha[i]->opt_enum; + if (!cname->common_options[opt_enum]) continue; if (!opt_names[opt_enum].short_opt) continue; - if (is_lvm_all_opt(opt_enum)) + if ((cname->variants < 2) && !is_lvm_all_opt(opt_enum)) continue; if (sep) { @@ -2107,14 +2125,16 @@ void print_man_usage_common(struct command *cmd) } /* print those without short opts */ - for (opt_enum = 0; opt_enum < ARG_COUNT; opt_enum++) { + for (i = 0; i < ARG_COUNT; i++) { + opt_enum = opt_names_alpha[i]->opt_enum; + if (!cname->common_options[opt_enum]) continue; if (opt_names[opt_enum].short_opt) continue; - if (is_lvm_all_opt(opt_enum)) + if ((cname->variants < 2) && !is_lvm_all_opt(opt_enum)) continue; if (sep) { @@ -2140,67 +2160,99 @@ void print_man_usage_common(struct command *cmd) break; } } - all: - /* options that are common to all lvm commands */ - - /* those with short opts */ - for (oo = 0; oo < lvm_all.oo_count; oo++) { - opt_enum = lvm_all.optional_opt_args[oo].opt; - if (!opt_names[opt_enum].short_opt) - continue; + printf(" ]\n"); + return; +} - if (sep) { - printf(","); - printf("\n.br\n"); - printf(" "); - } +/* + * Format of description, when different command names have + * different descriptions: + * + * "#cmdname1" + * "text foo goes here" + * "a second line of text." + * "#cmdname2" + * "text bar goes here" + * "another line of text." + * + * When called for cmdname2, this function should just print: + * + * "text bar goes here" + * "another line of text." + */ - printf(" \\fB-%c\\fP|\\fB%s\\fP", - opt_names[opt_enum].short_opt, - man_long_opt_name(cmd->name, opt_enum)); +static void print_man_option_desc(struct cmd_name *cname, int opt_enum) +{ + const char *desc = opt_names[opt_enum].desc; + char buf[DESC_LINE]; + int started_cname = 0; + int di, bi; - if (lvm_all.optional_opt_args[oo].def.val_bits) { - printf(" "); - print_def(&lvm_all.optional_opt_args[oo].def, 1); - } - sep = 1; + if (!strstr(desc, "#")) { + printf("%s", desc); + return; } - /* those without short opts */ - for (oo = 0; oo < lvm_all.oo_count; oo++) { - opt_enum = lvm_all.optional_opt_args[oo].opt; + for (di = 0; di < strlen(desc); di++) { + buf[bi++] = desc[di]; - if (opt_names[opt_enum].short_opt) + if (bi == DESC_LINE) { + printf("print_man_option_desc line too long\n"); + return; + } + + if (buf[bi-1] != '\n') continue; - if (sep) { - printf(","); - printf("\n.br\n"); - printf(" "); + if (buf[0] != '#') { + if (started_cname) + printf("%s", buf); + + memset(buf, 0, sizeof(buf)); + bi = 0; + continue; } - /* space alignment without short opt */ - printf(" "); + /* Line starting with #cmdname */ - printf(" \\fB%s\\fP", man_long_opt_name(cmd->name, opt_enum)); + /* Must be starting a new command name. */ + if (started_cname) + return; - if (lvm_all.optional_opt_args[oo].def.val_bits) { - printf(" "); - print_def(&lvm_all.optional_opt_args[oo].def, 1); + if (!strncmp(buf + 1, cname->name, strlen(cname->name))) { + /* The start of our command name. */ + started_cname = 1; + memset(buf, 0, sizeof(buf)); + bi = 0; + } else { + /* The start of another command name. */ + memset(buf, 0, sizeof(buf)); + bi = 0; } - sep = 1; } - printf(" ]\n"); + + if (bi && started_cname) + printf("%s", buf); } -void print_man_all_options(struct cmd_name *cname) +/* + * Print a list of all options names for a given + * command name, listed by: + * options with short+long names, alphabetically, + * then options with only long names, alphabetically + */ + +void print_man_all_options_list(struct cmd_name *cname) { int opt_enum, val_enum; int sep = 0; + int i; + + /* print those with both short and long opts */ + for (i = 0; i < ARG_COUNT; i++) { + opt_enum = opt_names_alpha[i]->opt_enum; - /* print those with short opts */ - for (opt_enum = 0; opt_enum < ARG_COUNT; opt_enum++) { if (!cname->all_options[opt_enum]) continue; @@ -2232,7 +2284,9 @@ void print_man_all_options(struct cmd_name *cname) } /* print those without short opts */ - for (opt_enum = 0; opt_enum < ARG_COUNT; opt_enum++) { + for (i = 0; i < ARG_COUNT; i++) { + opt_enum = opt_names_alpha[i]->opt_enum; + if (!cname->all_options[opt_enum]) continue; @@ -2265,7 +2319,79 @@ void print_man_all_options(struct cmd_name *cname) } } -#define DESC_LINE 256 +/* + * All options used for a given command name, along with descriptions. + * listed in order of: + * 1. options that are not common to all lvm commands, alphabetically + * 2. options common to all lvm commands, alphabetically + */ + +void print_man_all_options_desc(struct cmd_name *cname) +{ + int opt_enum, val_enum; + int print_common = 0; + int sep = 0; + int i; + + again: + /* + * Loop 1: print options that are not common to all lvm commands. + * Loop 2: print options common to all lvm commands (lvm_all) + */ + + for (i = 0; i < ARG_COUNT; i++) { + opt_enum = opt_names_alpha[i]->opt_enum; + + if (!cname->all_options[opt_enum]) + continue; + + if (!print_common && is_lvm_all_opt(opt_enum)) + continue; + + if (print_common && !is_lvm_all_opt(opt_enum)) + continue; + + if (sep) + printf("\n.br\n"); + + printf("\n.TP\n"); + + if (opt_names[opt_enum].short_opt) { + printf("\\fB-%c\\fP|\\fB%s\\fP", + opt_names[opt_enum].short_opt, + man_long_opt_name(cname->name, opt_enum)); + } else { + printf("\\fB%s\\fP", man_long_opt_name(cname->name, opt_enum)); + } + + val_enum = opt_names[opt_enum].val_enum; + + if (!val_names[val_enum].fn) { + /* takes no arg */ + } else if (!val_names[val_enum].usage) { + printf(" "); + printf("\\fI"); + printf("%s", val_names[val_enum].name); + printf("\\fP"); + } else { + printf(" "); + print_val_man(val_names[val_enum].usage); + } + + if (opt_names[opt_enum].desc) { + printf("\n"); + printf(".br\n"); + print_man_option_desc(cname, opt_enum); + } + + sep = 1; + } + + if (!print_common) { + print_common = 1; + goto again; + } +} void print_desc_man(const char *desc) { @@ -2338,6 +2464,12 @@ void print_man_command(void) printf("Common options:\n"); printf(".\n"); print_man_usage_common(prev_cmd); + + printf("\n"); + printf(".SH OPTIONS\n"); + printf(".br\n"); + print_man_all_options_desc(cname); + prev_cmd = NULL; } @@ -2396,7 +2528,7 @@ void print_man_command(void) /* listing them all when there's only 1 or 2 is just repetative */ if (cname->variants > 2) { printf(".P\n"); - print_man_all_options(cname); + print_man_all_options_list(cname); printf("\n"); printf(".P\n"); printf("\n"); @@ -2419,6 +2551,12 @@ void print_man_command(void) printf("Common options:\n"); printf(".\n"); print_man_usage_common(cmd); + + printf("\n"); + printf(".SH OPTIONS\n"); + printf(".br\n"); + print_man_all_options_desc(cname); + } printf("\n"); @@ -2730,6 +2868,23 @@ next: } } +static int long_name_compare(const void *on1, const void *on2) +{ + struct opt_name **optname1 = on1; + struct opt_name **optname2 = on2; + return strcmp((*optname1)->long_opt + 2, (*optname2)->long_opt + 2); +} + +static void create_opt_names_alpha(void) +{ + int i; + + for (i = 0; i < ARG_COUNT; i++) + opt_names_alpha[i] = &opt_names[i]; + + qsort(opt_names_alpha, ARG_COUNT, sizeof(long), long_name_compare); +} + void print_command_list(void) { int i; @@ -2754,6 +2909,17 @@ void print_option_list(void) opt_names[i].short_opt ? opt_names[i].short_opt : 0); } +void print_option_alpha_list(void) +{ + int i; + + for (i = 0; i < ARG_COUNT; i++) + printf("%d %s %s %c (%d)\n", + opt_names_alpha[i]->opt_enum, opt_names_alpha[i]->name, + opt_names_alpha[i]->long_opt, opt_names_alpha[i]->short_opt ?: ' ', + opt_names_alpha[i]->short_opt ? opt_names_alpha[i]->short_opt : 0); +} + static void print_help(int argc, char *argv[]) { printf("%s [options] --output <format> <filename>\n", argv[0]); @@ -2791,9 +2957,12 @@ int main(int argc, char *argv[]) exit(EXIT_FAILURE); } + create_opt_names_alpha(); + if (!strcmp(argv[1], "debug")) { print_command_list(); print_option_list(); + print_option_alpha_list(); return 0; } diff --git a/tools/lvmcmdline.c b/tools/lvmcmdline.c index 4f1718b9f..afc941b7c 100644 --- a/tools/lvmcmdline.c +++ b/tools/lvmcmdline.c @@ -64,7 +64,7 @@ static struct val_props _val_props[VAL_COUNT + 1] = { * Table of valid --option's */ static struct arg_props _arg_props[ARG_COUNT + 1] = { -#define arg(a, b, c, d, e, f) {a, b, "", "--" c, d, e, f}, +#define arg(a, b, c, d, e, f, g) {a, b, "", "--" c, d, e, f, g}, #include "args.h" #undef arg }; diff --git a/tools/tools.h b/tools/tools.h index 89ee8ad40..392490f6b 100644 --- a/tools/tools.h +++ b/tools/tools.h @@ -59,7 +59,7 @@ enum { /* define the enums for the command line --options, foo_ARG */ enum { -#define arg(a, b, c, d, e, f) a , +#define arg(a, b, c, d, e, f, g) a , #include "args.h" #undef arg }; @@ -109,6 +109,7 @@ struct arg_props { int val_enum; /* foo_VAL from vals.h */ uint32_t flags; uint32_t prio; + const char *desc; }; struct arg_value_group_list { |