From 05d5335651f98c9e320dd826212efea113a353aa Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 20 Jan 2021 00:40:28 -0500 Subject: (Developer Tools): new section in developers-manual - Add taler-config-generate(1) to developers-manual. This includes some minor reformatting, to fit in w/ the surrounding text. --- developers-manual.rst | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) diff --git a/developers-manual.rst b/developers-manual.rst index 681ef4e0..25d5afb2 100644 --- a/developers-manual.rst +++ b/developers-manual.rst @@ -1507,3 +1507,98 @@ use when talking to end users or even system administrators. :term:`deposit` :term:`expiration` time, but which is still (again) valid for an operation because it was :term:`melted` while it was still valid, and then later again credited during a :term:`recoup` process + + + +Developer Tools +=============== + +This section describes various internal programs to make life easier for the +developer. See also user-facing tools in :doc:`manpages`. + + +taler-config-generate +--------------------- + +**taler-config-generate** - tool to simplify Taler configuration generation + +Synopsis +~~~~~~~~ + +**taler-config-generate** +[**-C** *CURRENCY* | **––currency=**\ ‌\ *CURRENCY*] +[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*] +[**-e** | **––exchange**] +[**-f** *AMOUNT* | *––wirefee=*\ ‌\ *AMOUNT*] +[**-h** | **––help**] +[**-J** *JSON* | **––wire-json-exchange=**\ ‌\ *JSON*] +[**-j** *JSON* | **––wire-json-merchant=**\ ‌\ *JSON*] +[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*] +[**-m** | **––merchant**] +[**-t** | **––trusted**] +[**-v** | **––version**] +[**-w** *WIREFORMAT* | **––wire** *WIREFORMAT*] +[**––bank-uri**] +[**––exchange-bank-account**] +[**––merchant-bank-account**] + +Description +~~~~~~~~~~~ + +**taler-config-generate** can be used to generate configuration files +for the Taler exchange or Taler merchants. + +**-C** *CURRENCY* \| **––currency=**\ ‌\ *CURRENCY* + Which currency should we use in the configuration. + +**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME* + Location where to write the generated configuration. Existing file + will be updated, not overwritten. + +**-e** \| **––exchange** + Generate configuration for a Taler exchange. + +**-f** *AMOUNT* \| *-wirefee=*\ ‌\ *AMOUNT* + Setup wire transfer fees for the next 5 years for the exchange (for + all wire methods). + +**-h** \| **––help** + Shows this man page. + +**-J** *JSON* \| **––wire-json-exchange=**\ ‌\ *JSON* + Wire configuration to use for the exchange. + +**-j** *JSON* \| **––wire-json-merchant=**\ ‌\ *JSON* + Wire configuration to use for the merchant. + +**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL* + Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and + ERROR. + +**-m** \| **––merchant** + Generate configuration for a Taler merchant. + +**-t** \| **––trusted** + Setup current exchange as trusted with current merchant. Generally + only useful when configuring for testcases. + +**-v** \| **––version** + Print version information. + +**-w** *WIREFORMAT* \| **––wire** *WIREFORMAT* + Specifies which wire format to use (i.e. “test” or “sepa”) + +**––bank-uri** + Alternative to specify wire configuration to use for the exchange and + merchant for the “test” wire method. Only useful if WIREFORMAT was + set to “test”. Specifies the URI of the bank. + +**––exchange-bank-account** + Alternative to specify wire configuration to use for the exchange for + the “test” wire method. Only useful if WIREFORMAT was set to “test”. + Specifies the bank account number of the exchange. + +**––merchant-bank-account** + Alternative to specify wire configuration to use for the merchant for + the “test” wire method. Only useful if WIREFORMAT was set to “test”. + Specifies the bank account number of the merchant. -- cgit v1.2.3