aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2013-08-01 14:13:59 +0200
committerMattias Andrée <maandree@operamail.com>2013-08-01 14:13:59 +0200
commit947ef34b157f37c6100ccdeaf1e7e93d8189c377 (patch)
tree5e87fe5d78be50fe2c32b518f33bf759ed10dba8
parentdoc c version, except how to use opts (diff)
downloadargparser-947ef34b157f37c6100ccdeaf1e7e93d8189c377.tar.gz
argparser-947ef34b157f37c6100ccdeaf1e7e93d8189c377.tar.bz2
argparser-947ef34b157f37c6100ccdeaf1e7e93d8189c377.tar.xz
doc opts for c version
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--info/argparser.texinfo15
1 files changed, 15 insertions, 0 deletions
diff --git a/info/argparser.texinfo b/info/argparser.texinfo
index c7a0f21..33abf9c 100644
--- a/info/argparser.texinfo
+++ b/info/argparser.texinfo
@@ -242,6 +242,21 @@ associated with the option, the index of the primary alternative, and
finally a variadic parameter with the alternatives, meaning that each
alternative is an argument.
+To list all valid options, use the method @code{args_get_opts} which returns
+a string array of all options, and @code{args_get_opts_count} which returns
+the number of strings in the array returned by @code{args_get_opts}.
+@code{args_opts_contains} with a option checks whether the option is available,
+while @code{args_opts_used} checks whether it is used. @code{args_opts_new}
+adds option and @code{args_opts_clear} removes all values stored for a
+option. @code{args_opts_append} which takes a option and a value as
+parameters store a value for a option and @code{args_opts_put} sets all
+value for an option, it works the same way, except a string array of values
+is used rather than just a string with a value, @code{args_opts_put_count}
+stores the number of values. The get a number of values for a option, which
+include @code{NULL} for argumentless occurrences, use @code{args_opts_get_count},
+and to retrieve the array of values, use @code{args_opts_get}. Both takes
+only the option as parameter.
+
@c@node Bash version