commit 4f5292abdceaa96aafb343ad6a5216cf4d11a8ee
parent 39ce3df6e89f6d6badf043e8d0b481e86a5e088d
Author: Christian Grothoff <christian@grothoff.org>
Date: Fri, 6 Sep 2024 15:11:43 +0200
new merchant man pages
Diffstat:
5 files changed, 233 insertions(+), 75 deletions(-)
diff --git a/conf.py b/conf.py
@@ -571,13 +571,27 @@ man_pages = [
1,
),
(
- "manpages/taler-merchant-exchange.1",
- "taler-merchant-exchange",
+ "manpages/taler-merchant-reconciliation.1",
+ "taler-merchant-reconciliation",
"ask exchange which deposits were aggregated for a particular wire transfer that credited a merchant account",
"GNU Taler contributors",
1,
),
(
+ "manpages/taler-merchant-kyccheck.1",
+ "taler-merchant-kyccheck",
+ "ask exchange about KYC status of merchant bank accounts",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-merchant-exchangekeyupdate.1",
+ "taler-merchant-exchangekeyupdate",
+ "keep exchange key material up-to-date",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
"manpages/taler-merchant-benchmark.1",
"taler-merchant-benchmark",
"generate Taler-style benchmarking payments",
diff --git a/manpages/taler-merchant-exchange.1.rst b/manpages/taler-merchant-exchange.1.rst
@@ -1,73 +0,0 @@
-taler-merchant-exchange(1)
-##########################
-
-.. only:: html
-
- Name
- ====
-
- **taler-merchant-exchange** - reconcile bank transfers with Taler exchange
-
-
-Synopsis
-========
-
-**taler-merchant-exchange**
-[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
-[**-h** | **--help**]
-[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
-[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
-[**-T** *USEC* | **--timetravel**\ \ *USEC*]
-[**-t** | **--test**]
-[**-v** | **--version**]
-
-Description
-===========
-
-**taler-merchant-exchange** is a background job that reconciles
-wire transfers that credit the merchant's bank account with
-the respective contracts that have been paid by asking the
-exchange to provide a list of all deposits that were aggregated
-into a wire transfer.
-
-The tool is part of a set of processes that allow a merchant backend to
-validate that the exchange paid the merchant correctly.
-
-Its options are as follows:
-
-**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
- Use the configuration and other resources for the merchant to operate
- from *FILENAME*.
-
-**-h** \| **--help**
- Print short help on options.
-
-**-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*.
-
-**-T** *USEC* \| **--timetravel=**\ \ *USEC*
- Modify the system time by *USEC* microseconds.
- *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``).
- This option is intended for debugging/testing only.
-
-**-t** \| **--test**
- Run in test mode. Only runs until the current list of bank
- transactions have all been checked.
-
-**-v** \| **–version**
- Print version information.
-
-See Also
-========
-
-taler-merchant-depositcheck(1), taler-merchant-wirewatch(1), taler.conf(5).
-
-Bugs
-====
-
-Report bugs by using https://bugs.taler.net or by sending electronic
-mail to <taler@gnu.org>.
diff --git a/manpages/taler-merchant-exchangekeyupdate.1.rst b/manpages/taler-merchant-exchangekeyupdate.1.rst
@@ -0,0 +1,72 @@
+taler-merchant-exchangekeyupdate(1)
+###################################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-merchant-exchangekeyupdate** - keep key material (and configuration data) of each configured Taler exchange current
+
+
+Synopsis
+========
+
+**taler-merchant-exchangekeyupdate**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-T** *USEC* | **--timetravel**\ \ *USEC*]
+[**-t** | **--test**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**taler-merchant-exchangekeyupdate** is a background job that
+downloads the current key material and configuration data from
+each configured exchange and keeps an up-to-date copy in our
+local database.
+
+The tool is part of a set of processes that allow a merchant backend to ensure
+that the backend can properly interact with an exchange.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the merchant to operate
+ from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-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*.
+
+**-T** *USEC* \| **--timetravel=**\ \ *USEC*
+ Modify the system time by *USEC* microseconds.
+ *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``).
+ This option is intended for debugging/testing only.
+
+**-t** \| **--test**
+ Run in test mode. Only runs until the current list of bank
+ transactions have all been checked.
+
+**-v** \| **–version**
+ Print version information.
+
+See Also
+========
+
+taler-merchant-kyccheck(1), taler-exchange-offline(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler-merchant-kyccheck.1.rst b/manpages/taler-merchant-kyccheck.1.rst
@@ -0,0 +1,72 @@
+taler-merchant-kyccheck(1)
+##########################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-merchant-kyccheck** - check KYC status of merchant (bank accounts) with Taler exchanges
+
+
+Synopsis
+========
+
+**taler-merchant-kyccheck**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-T** *USEC* | **--timetravel**\ \ *USEC*]
+[**-t** | **--test**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**taler-merchant-kyccheck** is a background job that asks the exchange about
+the KYC status (and associated exposed limits) of the various bank accounts of
+the merchant backend. The resulting information can then be obtained via the
+``/kyc-status`` endpoint.
+
+The tool is part of a set of processes that allow a merchant backend to ensure
+that the backend can properly interact with an exchange.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the merchant to operate
+ from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-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*.
+
+**-T** *USEC* \| **--timetravel=**\ \ *USEC*
+ Modify the system time by *USEC* microseconds.
+ *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``).
+ This option is intended for debugging/testing only.
+
+**-t** \| **--test**
+ Run in test mode. Only runs until the current list of bank
+ transactions have all been checked.
+
+**-v** \| **–version**
+ Print version information.
+
+See Also
+========
+
+taler-merchant-exchangekeyupdate(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler-merchant-reconciliation.1.rst b/manpages/taler-merchant-reconciliation.1.rst
@@ -0,0 +1,73 @@
+taler-merchant-reconciliation(1)
+################################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-merchant-reconciliation** - reconcile bank transfers with Taler exchange
+
+
+Synopsis
+========
+
+**taler-merchant-reconciliation**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-T** *USEC* | **--timetravel**\ \ *USEC*]
+[**-t** | **--test**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**taler-merchant-reconciliation** is a background job that reconciles
+wire transfers that credit the merchant's bank account with
+the respective contracts that have been paid by asking the
+exchange to provide a list of all deposits that were aggregated
+into a wire transfer.
+
+The tool is part of a set of processes that allow a merchant backend to
+validate that the exchange paid the merchant correctly.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the merchant to operate
+ from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-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*.
+
+**-T** *USEC* \| **--timetravel=**\ \ *USEC*
+ Modify the system time by *USEC* microseconds.
+ *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``).
+ This option is intended for debugging/testing only.
+
+**-t** \| **--test**
+ Run in test mode. Only runs until the current list of bank
+ transactions have all been checked.
+
+**-v** \| **–version**
+ Print version information.
+
+See Also
+========
+
+taler-merchant-depositcheck(1), taler-merchant-wirewatch(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
