taler-docs

commit e167a392aea09bdbcdc68b30fc8bc52119830b07
parent 581427ac10ca2c52f6459e1f2424b0fb7aee7ee0
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sun, 18 Aug 2024 21:27:40 +0200

add -c CONF option to AML programs (and -h, -v, and rename long options to short options)

Diffstat:
M
taler-kyc-manual.rst
 | 
14
+++++++++++---

1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/taler-kyc-manual.rst b/taler-kyc-manual.rst
@@ -583,13 +583,13 @@ When implementing an AML program, developers must
 ensure to provide three main execution paths:
 
 * Generate a list of *required* context field names
-  for the helper (introspection!) when given the "--required-context"
+  for the helper (introspection!) when given the "-r"
   command-line switch. The output should use the same
   syntax as the REQUIRES clause of ``[kyc-check-]``
   configuration sections, except that new lines
   MUST be used to separate fields instead of ";".
 * Generate a list of *required* attribute names
-  for the helper (introspection!) when given the "--required-attributes"
+  for the helper (introspection!) when given the "-a"
   command-line switch. The output should use the same
   list of names as the ATTRIBUTES in the
   ``[kyc-provider-]`` configuration section
@@ -600,6 +600,14 @@ ensure to provide three main execution paths:
   This is the default behavior if no command-line switches
   are provided.
 
+AML programs will be given the exchange's configuration filename with the "-c
+FILENAME" command-line option.  They may or may not use the configuration file
+as they see fit. AML programs should support the canonical "-h" (help) and
+"-v" (version) command-line options to display a help text and their version
+number respectively.  AML programs may be given the "-V" option to put them
+into verbose mode, suggesting that they should log additional information to
+standard error.
+
 If the AML program fails (exits with a failure code or does not provide
 well-formed JSON output) the AML/KYC process continues with the FALLBACK
 measure. This should usually be one that asks AML staff to contact the systems
@@ -614,7 +622,7 @@ administrator.
     // provided under "context" in the main JSON object
     // input to the AML program.  This "context" should
     // satify both the REQUIRES clause of the respective
-    // check and the output of "--requires" from the
+    // check and the output of "-r" from the
     // AML program's command-line option.
     context?: Object;