option - Factor Documentation (original) (raw)
Vocabulary
command-line.parser
Class description
An option that can be specified on the command-line. It has the following slots:
| name | The name of the argument (prefixed by dashes "-" if optional). |
|---|---|
| type | The class type of the argument. |
| help | Some help text to display. |
| variable | An optional variable used to set a parsed value. |
| default | A default value if not present on the command-line. |
| convert | A converter from a string argument. |
| validate | A validater to constrain the specified argument. |
| const | A constant value to be used if the argument is specified. |
| required? | A flag to indicate this option is required. |
| meta | A meta variable name used to display. |
| #args | The number of arguments to parse specified as an integer, "*" (zero or more), "+" (one or more), or "?" (optionally one) argument. |
Definition
TUPLE: option
name type help variable default convert validate const
required? meta #args ;
Methods