From 0406210f38cebe8a46af29a64b81a083c9f8a762 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Fri, 26 Jun 2020 09:31:27 +0200 Subject: update man pages --- manpages/taler-auditor-dbinit.1.rst | 2 +- manpages/taler-auditor-exchange.1.rst | 2 +- manpages/taler-auditor-sign.1.rst | 2 +- manpages/taler-auditor.1.rst | 2 +- manpages/taler-bank-transfer.1.rst | 2 +- manpages/taler-config-generate.1.rst | 2 +- manpages/taler-exchange-aggregator.1.rst | 2 +- manpages/taler-exchange-benchmark.1.rst | 2 +- manpages/taler-exchange-closer.1.rst | 2 +- manpages/taler-exchange-dbinit.1.rst | 2 +- manpages/taler-exchange-httpd.1.rst | 2 +- manpages/taler-exchange-keycheck.1.rst | 2 +- manpages/taler-exchange-keyup.1.rst | 2 +- manpages/taler-exchange-transfer.1.rst | 2 +- manpages/taler-exchange-wire.1.rst | 2 +- manpages/taler-exchange-wirewatch.1.rst | 2 +- manpages/taler-merchant-benchmark.1.rst | 2 +- manpages/taler-merchant-httpd.1.rst | 2 +- manpages/taler-wallet-cli.1.rst | 2 +- manpages/taler.conf.5.rst | 217 ++++++++++++------------------- 20 files changed, 104 insertions(+), 151 deletions(-) diff --git a/manpages/taler-auditor-dbinit.1.rst b/manpages/taler-auditor-dbinit.1.rst index 463814ac..48509012 100644 --- a/manpages/taler-auditor-dbinit.1.rst +++ b/manpages/taler-auditor-dbinit.1.rst @@ -54,5 +54,5 @@ taler-auditor-httpd(1), taler-auditor(1), taler.conf(5). Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-auditor-exchange.1.rst b/manpages/taler-auditor-exchange.1.rst index 422d8b06..3471cf1a 100644 --- a/manpages/taler-auditor-exchange.1.rst +++ b/manpages/taler-auditor-exchange.1.rst @@ -63,5 +63,5 @@ step). Furthermore, if we do verification, as a (less secure) convenience option, we should make **-** m optional and obtain it from the base URL. -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-auditor-sign.1.rst b/manpages/taler-auditor-sign.1.rst index b9c34fb8..86dfba39 100644 --- a/manpages/taler-auditor-sign.1.rst +++ b/manpages/taler-auditor-sign.1.rst @@ -59,5 +59,5 @@ taler.conf(5) Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-auditor.1.rst b/manpages/taler-auditor.1.rst index d8ee1a96..1d04c487 100644 --- a/manpages/taler-auditor.1.rst +++ b/manpages/taler-auditor.1.rst @@ -47,5 +47,5 @@ gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5), taler-auditor-dbinit(1) Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to . diff --git a/manpages/taler-bank-transfer.1.rst b/manpages/taler-bank-transfer.1.rst index 9e466def..56fe0186 100644 --- a/manpages/taler-bank-transfer.1.rst +++ b/manpages/taler-bank-transfer.1.rst @@ -105,5 +105,5 @@ taler-bank-manage(1), taler.conf(5), https://docs.taler.net/core/api-wire.html#w Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to diff --git a/manpages/taler-config-generate.1.rst b/manpages/taler-config-generate.1.rst index f7fd1cc5..3cd36d10 100644 --- a/manpages/taler-config-generate.1.rst +++ b/manpages/taler-config-generate.1.rst @@ -89,5 +89,5 @@ for the Taler exchange or Taler merchants. Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-aggregator.1.rst b/manpages/taler-exchange-aggregator.1.rst index 255e1e14..1e010fad 100644 --- a/manpages/taler-exchange-aggregator.1.rst +++ b/manpages/taler-exchange-aggregator.1.rst @@ -43,5 +43,5 @@ taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-benchmark.1.rst b/manpages/taler-exchange-benchmark.1.rst index 9bc0c8d0..98bae49e 100644 --- a/manpages/taler-exchange-benchmark.1.rst +++ b/manpages/taler-exchange-benchmark.1.rst @@ -69,5 +69,5 @@ taler-exchange-httpd(1), taler.conf(5) Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-closer.1.rst b/manpages/taler-exchange-closer.1.rst index 8783cd61..7cc9e34c 100644 --- a/manpages/taler-exchange-closer.1.rst +++ b/manpages/taler-exchange-closer.1.rst @@ -43,5 +43,5 @@ taler-exchange-transfer(1), taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-dbinit.1.rst b/manpages/taler-exchange-dbinit.1.rst index 6d9b787b..5a1616d5 100644 --- a/manpages/taler-exchange-dbinit.1.rst +++ b/manpages/taler-exchange-dbinit.1.rst @@ -52,5 +52,5 @@ taler-exchange-reservemod(1), taler.conf(5). Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to . diff --git a/manpages/taler-exchange-httpd.1.rst b/manpages/taler-exchange-httpd.1.rst index 11027684..88a47435 100644 --- a/manpages/taler-exchange-httpd.1.rst +++ b/manpages/taler-exchange-httpd.1.rst @@ -100,5 +100,5 @@ taler-exchange-reservemod(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to . diff --git a/manpages/taler-exchange-keycheck.1.rst b/manpages/taler-exchange-keycheck.1.rst index 3f7b0352..d79bbddb 100644 --- a/manpages/taler-exchange-keycheck.1.rst +++ b/manpages/taler-exchange-keycheck.1.rst @@ -51,5 +51,5 @@ taler-exchange-dbinit(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-keyup.1.rst b/manpages/taler-exchange-keyup.1.rst index cab075a7..d21cbebe 100644 --- a/manpages/taler-exchange-keyup.1.rst +++ b/manpages/taler-exchange-keyup.1.rst @@ -80,5 +80,5 @@ taler-exchange-keycheck(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-transfer.1.rst b/manpages/taler-exchange-transfer.1.rst index 4dac3625..c579e655 100644 --- a/manpages/taler-exchange-transfer.1.rst +++ b/manpages/taler-exchange-transfer.1.rst @@ -42,5 +42,5 @@ taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-wire.1.rst b/manpages/taler-exchange-wire.1.rst index 22ab8572..23242d1c 100644 --- a/manpages/taler-exchange-wire.1.rst +++ b/manpages/taler-exchange-wire.1.rst @@ -42,5 +42,5 @@ taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-exchange-wirewatch.1.rst b/manpages/taler-exchange-wirewatch.1.rst index 8aaa50fb..9c00fd66 100644 --- a/manpages/taler-exchange-wirewatch.1.rst +++ b/manpages/taler-exchange-wirewatch.1.rst @@ -53,5 +53,5 @@ taler-exchange-aggregator(1), taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-merchant-benchmark.1.rst b/manpages/taler-merchant-benchmark.1.rst index b4a1af36..3d688e07 100644 --- a/manpages/taler-merchant-benchmark.1.rst +++ b/manpages/taler-merchant-benchmark.1.rst @@ -99,7 +99,7 @@ Common Options Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . diff --git a/manpages/taler-merchant-httpd.1.rst b/manpages/taler-merchant-httpd.1.rst index 0d12030f..68cd2fbe 100644 --- a/manpages/taler-merchant-httpd.1.rst +++ b/manpages/taler-merchant-httpd.1.rst @@ -53,7 +53,7 @@ SIGTERM Bugs ==== -Report bugs by using Mantis or by sending +Report bugs by using Mantis or by sending electronic mail to diff --git a/manpages/taler-wallet-cli.1.rst b/manpages/taler-wallet-cli.1.rst index 83fe591c..15864478 100644 --- a/manpages/taler-wallet-cli.1.rst +++ b/manpages/taler-wallet-cli.1.rst @@ -57,5 +57,5 @@ for testing. Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to . diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst index d7ca470c..d880bc17 100644 --- a/manpages/taler.conf.5.rst +++ b/manpages/taler.conf.5.rst @@ -141,137 +141,6 @@ CONFIG How to access the database, i.e. “postgres:///taler” to use the “taler” database. Testcases use “talercheck”. -MERCHANT OPTIONS ----------------- - -The following options are from the “[merchant]” section and used by the -merchant backend. - -DB - Plugin to use for the database, i.e. “postgres” - -PORT - Port on which the HTTP server listens, i.e. 8080. - -WIRE_TRANSFER_DELAY - How quickly do we want the exchange to send us money? Note that wire - transfer fees will be higher if we ask for money to be wired often. - Given as a relative time, i.e. “5 s” - -DEFAULT_MAX_WIRE_FEE - Maximum wire fee we are willing to accept from exchanges. Given as a - Taler amount, i.e. “EUR:0.1” - -DEFAULT_MAX_DEPOSIT_FEE - Maximum deposit fee we are willing to cover. Given as a Taler amount, - i.e. “EUR:0.1” - -MERCHANT POSTGRES BACKEND DATABASE OPTIONS ------------------------------------------- - -The following options must be in section “[merchantdb-postgres]” if the -“postgres” plugin was selected for the database. - -CONFIG - How to access the database, i.e. “postgres:///taler” to use the - “taler” database. Testcases use “talercheck”. - -MERCHANT INSTANCES ------------------- - -The merchant configuration must specify a set of instances, containing -at least the “default” instance. The following options must be given in -each “[instance-NAME]” section. - -KEYFILE - Name of the file where the instance´s private key is to be stored, - i.e. “${TALER_CONFIG_HOME}/merchant/instance/name.priv” - -NAME - Human-readable name of the instance, i.e. “Kudos Inc.” - -Additionally, for instances that support tipping, the following options -are required. - -TIP_EXCHANGE - Base-URL of the exchange that holds the reserve for tipping, - i.e. “https://exchange.demo.taler.net/” - -TIP_EXCHANGE_PRIV_FILENAME - Filename with the private key granting access to the reserve, - i.e. “${TALER_CONFIG_HOME}/merchant/reserve/tip.priv” - -KNOWN EXCHANGES (for merchants) -------------------------------- - -The merchant configuration can include a list of known exchanges if the -merchant wants to specify that certain exchanges are explicitly trusted. -For each trusted exchange, a section [merchant-exchange-$NAME] must exist, where -$NAME is a merchant-given name for the exchange. The following options -must be given in each “[exchange-$NAME]” section. - -EXCHANGE_BASE_URL - Base URL of the exchange, i.e. “https://exchange.demo.taler.net/” - -MASTER_KEY - Crockford Base32 encoded master public key, public version of the - exchange´s long-time offline signing key. Can be omitted, in that - case the exchange will NOT be trusted unless it is audited by - a known auditor. - Omitting the MASTER_KEY can be useful if we do not trust the exchange - without an auditor, but should pre-load the keys of this - particular exchange on startup instead of waiting for it to be - required by a client. - -CURRENCY - Name of the currency for which this exchange is used, i.e. “KUDOS”. - The entire section is ignored if the currency does not match the currency - we use, which must be given in the [taler] section. - -KNOWN AUDITORS (for merchants) ------------------------------- - -The merchant configuration can include a list of known exchanges if the -merchant wants to specify that certain auditors are explicitly trusted. -For each trusted exchange, a section [merchant-auditor-$NAME] must exist, where -$NAME is a merchant-given name for the auditor. The following options -must be given in each “[merchant-auditor-$NAME]” section. - -AUDITOR_BASE_URL - Base URL of the auditor, i.e. “https://auditor.demo.taler.net/” - -AUDITOR_KEY - Crockford Base32 encoded auditor public key. - -CURRENCY - Name of the currency for which this auditor is trusted, i.e. “KUDOS” - The entire section is ignored if the currency does not match the currency - we use, which must be given in the [taler] section. - - -MERCHANT ACCOUNT OPTIONS ------------------------- - -PAYTO_URI - Specifies the payto://-URL of the account. The general format is - payto://$METHOD/$DETAILS. - -WIRE_RESPONSE (exchange and merchant) - Specifies the name of the file in which the wire details for this merchant - account should be located. Used by the Taler exchange service and the - taler-merchant-httpd (to generate and then use the file). - -HONOR_instance - Must be set to YES for the instances (where "instance" is the section name - of the instance) of the merchant backend that should accept payments (i.e. - Taler deposit operations) with the corresponding payto URI. - -ACTIVE_instance - Must be set to YES for the instances (where “instance” is the section - name of the instance) of the merchant backend that should use this - bank account in new offers/contracts. Setting ACTIVE_instance to YES - requires also setting HONOR_instance to YES. - EXCHANGE ACCOUNT OPTIONS ------------------------ @@ -386,6 +255,88 @@ FEE_REFUND RSA_KEYSIZE What is the RSA keysize modulos (in bits)? + +MERCHANT OPTIONS +---------------- + +The following options are from the “[merchant]” section and used by the +merchant backend. + +DB + Plugin to use for the database, i.e._“postgres” + +PORT + Port on which the HTTP server listens, i.e. 8080. + +LEGAL_PRESERVATION + How long do we keep data in the database for tax audits after the + transaction has completed? Default is 10 years. + +FORCE_AUDIT + Force the merchant to report every transaction to the auditor + (if the exchange has an auditor). Default is NO. Do not change + except for testing. + + +MERCHANT POSTGRES BACKEND DATABASE OPTIONS +------------------------------------------ + +The following options must be in section “[merchantdb-postgres]” if the +“postgres” plugin was selected for the database. + +CONFIG + How to access the database, i.e. “postgres:///taler” to use the + “taler” database. Testcases use “talercheck”. + + +KNOWN EXCHANGES (for merchants) +------------------------------- + +The merchant configuration can include a list of known exchanges if the +merchant wants to specify that certain exchanges are explicitly trusted. +For each trusted exchange, a section [merchant-exchange-$NAME] must exist, where +$NAME is a merchant-given name for the exchange. The following options +must be given in each “[exchange-$NAME]” section. + +EXCHANGE_BASE_URL + Base URL of the exchange, i.e. “https://exchange.demo.taler.net/” + +MASTER_KEY + Crockford Base32 encoded master public key, public version of the + exchange´s long-time offline signing key. Can be omitted, in that + case the exchange will NOT be trusted unless it is audited by + a known auditor. + Omitting the MASTER_KEY can be useful if we do not trust the exchange + without an auditor, but should pre-load the keys of this + particular exchange on startup instead of waiting for it to be + required by a client. + +CURRENCY + Name of the currency for which this exchange is used, i.e. “KUDOS”. + The entire section is ignored if the currency does not match the currency + we use, which must be given in the [taler] section. + +KNOWN AUDITORS (for merchants) +------------------------------ + +The merchant configuration can include a list of known exchanges if the +merchant wants to specify that certain auditors are explicitly trusted. +For each trusted exchange, a section [merchant-auditor-$NAME] must exist, where +$NAME is a merchant-given name for the auditor. The following options +must be given in each “[merchant-auditor-$NAME]” section. + +AUDITOR_BASE_URL + Base URL of the auditor, i.e. “https://auditor.demo.taler.net/” + +AUDITOR_KEY + Crockford Base32 encoded auditor public key. + +CURRENCY + Name of the currency for which this auditor is trusted, i.e. “KUDOS” + The entire section is ignored if the currency does not match the currency + we use, which must be given in the [taler] section. + + AUDITOR OPTIONS --------------- @@ -398,6 +349,7 @@ DB AUDITOR_PRIV_FILE Name of the file containing the auditor’s private key + AUDITOR POSTGRES BACKEND DATABASE OPTIONS ----------------------------------------- @@ -408,6 +360,7 @@ CONFIG How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use “talercheck”. + SEE ALSO ======== @@ -417,5 +370,5 @@ taler-exchange-keyup(1), taler-exchange-wire(1). BUGS ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to . -- cgit v1.2.3