MainParameter
Related Docs:
object MainParameter
| package cli
Specification of values following this parameter name:
Specification of values following this parameter name:
- positive number: exactly this number of values must follow this parameter name
- negative number: at least abs(this number) of values must follow this parameter name (variable arity)
- zero: no values must follow this parameter name
Values following this parameter name will be consumed up to the next parameter.
A usage message of this parameter in a two-column layout.
A usage message of this parameter in a two-column layout.
The first column shows the names in one line, the second column shows one ore more lines of description. The lines of the description are taken as given, no automatic word wrap is done.
minimum width of the names column (defaults to 0)
the usage message
A main parameter has a number of values specified by its
arity.The values can be retrieved as a sequence by the
valuesoption.A main parameter is different from a list parameter by the absence of a name in the command line. There is, however, an internal name (
MainParameter.internalName) that can be used in the command line to avoid ambiguities.Main-parameter values can be given at the beginning or at the end of the arguments sequence (or both mixed up, but that may be confusing). Beware, that values at the end might be consumed by a variable-arity parameter in a position right before.