commit 0d9471089b4d8ab40a902d1b277997e464bbf6a7
parent 1ee5aa1689dcf0e2724b4df7cc1572ec2d3b69bb
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Sun, 20 Oct 2024 19:05:47 +0200
add man page for taler-exchange-kyc-trigger
Diffstat:
2 files changed, 69 insertions(+), 0 deletions(-)
diff --git a/conf.py b/conf.py
@@ -564,6 +564,13 @@ man_pages = [
1,
),
(
+ "manpages/taler-exchange-kyc-trigger.1",
+ "taler-exchange-kyc-trigger",
+ "trigger AML/KYC measures by simulating wallet balances thresholds being crossed for testing AML/KYC procedures",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
"manpages/taler-exchange-wirewatch.1",
"taler-exchange-wirewatch",
"watch for incoming wire transfers",
diff --git a/manpages/taler-exchange-kyc-trigger.1.rst b/manpages/taler-exchange-kyc-trigger.1.rst
@@ -0,0 +1,62 @@
+taler-exchange-kyc-trigger(1)
+#############################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-exchange-kyc-trigger** - trigger AML/KYC processes at the exchange for testing
+
+
+Synopsis
+========
+
+**taler-exchange-kyc-trigger**
+[**-b**_*AMOUNT*]
+[**-c** *FILENAME*]
+[**-h**]
+
+Description
+===========
+
+**taler-exchange-kyc-trigger** is a simple tool to simulate a wallet that
+exceeds a balance threshold and thus triggers some AML/KYC logic. It is useful
+to test AML/KYC procedures. Such procedures must be configured to trigger on
+wallet balance thresholds. Other triggers are currently not supported.
+
+The tool gets the exchange base URL and the currency from the configuration
+file. Additionally, you may specify a file name under "RESERVE_PRIV_FILE" in
+the "[exchange-testing]" section. In this case, the tool will try to read the
+reserve private key from that file, or if it does not exist, create one there.
+
+Its options are as follows:
+
+**-b** *BALANCE*
+ Specifies the balance threshold that the simulated wallet has
+ crossed.
+
+**-c** *FILENAME*
+ Write the database configuration to FILENAME. The tool
+ will append the required ``CONFIG`` option for the
+ Postgresql access to the respective file.
+
+**-h**
+ Print short help on options.
+
+Output
+======
+
+The output will be details from the exchange's response.
+
+
+See Also
+========
+
+taler-exchange-httpd(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
