diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli.1 | 12 | ||||
| -rw-r--r-- | doc/cli.xhtml | 13 |
2 files changed, 25 insertions, 0 deletions
@@ -80,6 +80,11 @@ Generate option value modifiers in addition to accessors\. Generate functions for determining whether the option was specified on the command line\. +.IP "\fB--generate-parse\fP" +Generate \fBparse()\fP functions instead of parsing constructors\. This is +primarily useful for being able to parse into an already initialized options +class instance, for example, to implement merging/overriding\. + .IP "\fB--generate-description\fP" Generate the option description list that can be examined at runtime\. @@ -107,6 +112,13 @@ If no short documentation string is provided, use the complete long documentation string in usage\. By default, in this situation only the first sentence from the long string is used\. +.IP "\fB--short-usage\fP" +If specified together with \fB--long-usage\fP, generate both short and long +usage versions\. In this mode, the usage printing functions are called +\fBprint_short_usage()\fP and \fBprint_long_usage()\fP and for the long +usage the long documentation string is always used, even if the short +version is provided\. + .IP "\fB--option-length\fP \fIlen\fP" Indent option descriptions \fIlen\fP characters when printing usage\. This is useful when you have multiple options classes, potentially in separate diff --git a/doc/cli.xhtml b/doc/cli.xhtml index 9a6d3fd..1e905bc 100644 --- a/doc/cli.xhtml +++ b/doc/cli.xhtml @@ -104,6 +104,12 @@ <dd>Generate functions for determining whether the option was specified on the command line.</dd> + <dt><code><b>--generate-parse</b></code></dt> + <dd>Generate <code><b>parse()</b></code> functions instead of parsing + constructors. This is primarily useful for being able to parse into an + already initialized options class instance, for example, to implement + merging/overriding.</dd> + <dt><code><b>--generate-description</b></code></dt> <dd>Generate the option description list that can be examined at runtime.</dd> @@ -131,6 +137,13 @@ documentation string in usage. By default, in this situation only the first sentence from the long string is used.</dd> + <dt><code><b>--short-usage</b></code></dt> + <dd>If specified together with <code><b>--long-usage</b></code>, generate both + short and long usage versions. In this mode, the usage printing functions + are called <code><b>print_short_usage()</b></code> and + <code><b>print_long_usage()</b></code> and for the long usage the long + documentation string is always used, even if the short version is provided.</dd> + <dt><code><b>--option-length</b></code> <i>len</i></dt> <dd>Indent option descriptions <i>len</i> characters when printing usage. This is useful when you have multiple options classes, potentially in separate |