|
22 | 22 | //! `opt_*` accessors to get argument values out of the matches object.
|
23 | 23 | //!
|
24 | 24 | //! Single-character options are expected to appear on the command line with a
|
25 |
| -//! single preceding dash; multiple-character options are expected to be |
26 |
| -//! proceeded by two dashes. Options that expect an argument accept their |
27 |
| -//! argument following either a space or an equals sign. Single-character |
28 |
| -//! options don't require the space. Everything after double-dash "--" argument |
29 |
| -//! is considered to be a 'free' argument, even if it starts with dash. |
| 25 | +//! single preceding dash eg. `-u`; multiple-character options are expected to be |
| 26 | +//! proceeded by two dashes eg. `--unified`. |
| 27 | +//! Multiple-character options that have a required argument accept such an |
| 28 | +//! argument following either a space or an equals sign eg. `--unified=102` |
| 29 | +//! or `--unified 102`, but those multiple-character options that have an optional |
| 30 | +//! argument only accept such an argument following an equals sign |
| 31 | +//! eg. `--unified=103`, otherwise using `--unified 104` will consider `104` as |
| 32 | +//! being a `free` argument. |
| 33 | +//! Single-character options don't require a space eg. `-u19` but can have one |
| 34 | +//! even for optional arguments eg. `-u 20`, however they can't accept an |
| 35 | +//! equals sign because eg. `-u=20` will consider `=20` (with the `=` prefix |
| 36 | +//! included) to be the expected argument instead of just the `20`. |
| 37 | +//! Everything after the double-dash "--" argument is considered to be a 'free' |
| 38 | +//! argument, even if it starts with dash eg. |
| 39 | +//! `--arg -d9 -- a_free_arg -dash_prefixed_filename_here_as_a_free_arg` |
30 | 40 | //!
|
31 | 41 | //! # Usage
|
32 | 42 | //!
|
|
0 commit comments