Common Properties

All option types in Clon, including those you define yourself (see New Option Types), have a set of basic, common properties. Here is a list of them.


The option’s short name. A string or nil.


The option’s long name. A string or nil.


The option’s descriptive text. A string or nil. The same formatting recommendations as for arbitrary text apply (see Text).


The option’s associated environment variable. A string or nil.


When non-nil, the option won’t appear in the help string. Hidden options can still be displayed individually though (see Help).

Note that an option is required to have at least one name (either short or long). Non-nil but empty names are also prohibited, and of course, a short name cannot begin with a dash (otherwise, it would be mistaken for a long name, but did I really need to mention this?).