summaryrefslogtreecommitdiff
path: root/doc/cli.1
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2015-10-29 11:08:49 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2015-10-29 11:08:49 +0200
commit4c13393de7c54d3e2075ca89a0e3ade1415c59f8 (patch)
tree1b8d83feb9f80a8b63f790ae01cfec2cfa35a575 /doc/cli.1
parent0d23ec6f54eeada0917e94324e16b1cf52210b4d (diff)
Regenerate man pages
Diffstat (limited to 'doc/cli.1')
-rw-r--r--doc/cli.112
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/cli.1 b/doc/cli.1
index a79b7c7..6030674 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -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