commit 16923e7f1bc1576af1d247eb130f2bac39fcce61
parent e77d9dcd1d04e41c6e06518936604b530cbbb566
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 5 Jan 2025 16:15:59 +0100
add manpage for taler-exchange-sanctionscheck
Diffstat:
2 files changed, 70 insertions(+), 0 deletions(-)
diff --git a/conf.py b/conf.py
@@ -568,6 +568,13 @@ man_pages = [
1,
),
(
+ "manpages/taler-exchange-sanctionscheck.1",
+ "taler-exchange-sanctionscheck",
+ "check KYC attributes of all accounts against a sanctions list",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
"manpages/taler-exchange-wirewatch.1",
"taler-exchange-wirewatch",
"watch for incoming wire transfers",
diff --git a/manpages/taler-exchange-sanctionscheck.1.rst b/manpages/taler-exchange-sanctionscheck.1.rst
@@ -0,0 +1,63 @@
+taler-exchange-sanctioncheck(1)
+###############################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-exchange-sanctioncheck** - check existing accounts against a sanctions list
+
+Synopsis
+========
+
+**taler-exchange-sanctioncheck**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-v** | **--version**] --
+SANCTIONCHECKER [SANCTIONCHECKER_ARGUMENTS
+
+Description
+===========
+
+**taler-exchange-sanctioncheck** is a command-line tool to check all
+existing accounts (and their KYC attributes) against a sanctions list,
+freezing matches and flagging partial matches for investigation by AML
+staff.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the exchange to operate
+ from *FILENAME*.
+
+**-I** \| **--ignore-not-found**
+ Do not fail if the bank says that the exchange bank account does not (yet) exist.
+ Keep trying.
+
+**-L** *LOGLEVEL* \| **--loglevel=**\ \ *LOGLEVEL*
+ Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+ ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+ Send logging output to *FILENAME*.
+
+**-v** \| **--version**
+ Print version information.
+
+These options must be followed by the name of the sanctions list checking
+helper tool (taler-exchange-helper-sanctions-AUTHORITY) and its command-line
+arguments.
+
+See Also
+========
+
+taler-exchange-httpd(1), taler-exchange.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
