aboutsummaryrefslogtreecommitdiffstats
path: root/tools/README.gpgconf
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2004-02-26 18:22:02 +0000
committerMarcus Brinkmann <[email protected]>2004-02-26 18:22:02 +0000
commit255d2cea0435ad834581726ef2a424b1626c9872 (patch)
treed313860ee0262cf9ffa07cc4dfaafc34d0546bec /tools/README.gpgconf
parent2004-02-26 Marcus Brinkmann <[email protected]> (diff)
downloadgnupg-255d2cea0435ad834581726ef2a424b1626c9872.tar.gz
gnupg-255d2cea0435ad834581726ef2a424b1626c9872.zip
2004-02-26 Marcus Brinkmann <[email protected]>
* README.gpgconf: Fix description of arguments. * gpgconf-comp.c (option_check_validity): Rewritten to properly support optional arguments in lists.
Diffstat (limited to 'tools/README.gpgconf')
-rw-r--r--tools/README.gpgconf31
1 files changed, 14 insertions, 17 deletions
diff --git a/tools/README.gpgconf b/tools/README.gpgconf
index 2f6a2e073..0973939d0 100644
--- a/tools/README.gpgconf
+++ b/tools/README.gpgconf
@@ -80,17 +80,17 @@ Some fields contain an option argument. The format of an option
argument depends on the type of the option and on some flags:
The simplest case is that the option does not take an argument at all
-(TYPE is 0). Then the option argument is either empty if the option
-is not set, or an unsigned number that specifies how often the option
-occurs. If the LIST flag is not set, then the only valid number is 1.
-Options that don't take an argument never have the "default" flag set.
+(TYPE is 0). Then the option argument is an unsigned number that
+specifies how often the option occurs. If the LIST flag is not set,
+then the only valid number is 1. Options that don't take an argument
+never have the "default" or "optional arg" flag set.
If the option takes a number argument (ALT-TYPE is 2 or 3), and it can
only occur once (LIST flag is not set), then the option argument is
-either empty if the option is not set, or it is a number. A number is
-a string that begins with an optional minus character, followed by one
-or more digits. The number must fit into an integer variable
-(unsigned or signed, depending on ALT-TYPE).
+either empty (only allowed if the argument is optional), or it is a
+number. A number is a string that begins with an optional minus
+character, followed by one or more digits. The number must fit into
+an integer variable (unsigned or signed, depending on ALT-TYPE).
If the option takes a number argument and it can occur more than once,
then the option argument is either empty, or it is a comma-separated
@@ -98,19 +98,16 @@ list of numbers as described above.
If the option takes a string argument (ALT-TYPE is 1), and it can only
occur once (LIST flag is not set) then the option argument is either
-empty if the option is not set, or it starts with a double quote
-character (") followed by a percent-escaped string that is the
-argument value. Note that there is only a leading double quote
+empty (only allowed if the argument is optional), or it starts with a
+double quote character (") followed by a percent-escaped string that
+is the argument value. Note that there is only a leading double quote
character, no trailing one. The double quote character is only needed
to be able to differentiate between no value and the empty string as
value.
-If the option takes a string argument and it can occur more than once,
-then the option argument is either empty or it starts with a double
-quote character (") followed by a comma-separated list of
-percent-escaped strings. Obviously any commas in the individual
-strings must be percent-escaped.
-
+If the option takes a number argument and it can occur more than once,
+then the option argument is either empty, or it is a comma-separated
+list of string arguments as described above.
FIXME: Document the active language and active character set. Allow
to change it via the command line?