diff options
Diffstat (limited to 'man')
40 files changed, 377 insertions, 63 deletions
diff --git a/man/libeufin-nexus.1 b/man/libeufin-nexus.1 index cfeb1f7e..c5ac89f5 100644 --- a/man/libeufin-nexus.1 +++ b/man/libeufin-nexus.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "LIBEUFIN-NEXUS" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "LIBEUFIN-NEXUS" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME libeufin-nexus \- service to interface to various bank access APIs . diff --git a/man/libeufin-sandbox.1 b/man/libeufin-sandbox.1 index cb4607ba..32e8bc7c 100644 --- a/man/libeufin-sandbox.1 +++ b/man/libeufin-sandbox.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "LIBEUFIN-SANDBOX" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "LIBEUFIN-SANDBOX" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME libeufin-sandbox \- simulate core banking system with EBICS access to bank accounts . diff --git a/man/sync-config.1 b/man/sync-config.1 index 40fd39f2..83c69ed8 100644 --- a/man/sync-config.1 +++ b/man/sync-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-CONFIG" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "SYNC-CONFIG" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME sync-config \- manipulate Sync configuration files . diff --git a/man/sync-dbinit.1 b/man/sync-dbinit.1 index c6bee24b..e3b524e7 100644 --- a/man/sync-dbinit.1 +++ b/man/sync-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "SYNC-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME sync-dbinit \- initialize the Sync database . diff --git a/man/sync-httpd.1 b/man/sync-httpd.1 index 4b247228..851dbe14 100644 --- a/man/sync-httpd.1 +++ b/man/sync-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "SYNC-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME sync-httpd \- provide the Sync HTTP interface . diff --git a/man/sync.conf.5 b/man/sync.conf.5 index f7086469..f5fe6126 100644 --- a/man/sync.conf.5 +++ b/man/sync.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC.CONF" "5" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "SYNC.CONF" "5" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME sync.conf \- Sync configuration file . diff --git a/man/taler-auditor-dbinit.1 b/man/taler-auditor-dbinit.1 index ccb7ccda..a33aa48f 100644 --- a/man/taler-auditor-dbinit.1 +++ b/man/taler-auditor-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-dbinit \- setup auditor database . diff --git a/man/taler-auditor-exchange.1 b/man/taler-auditor-exchange.1 index f5ffbe67..a5c32169 100644 --- a/man/taler-auditor-exchange.1 +++ b/man/taler-auditor-exchange.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-EXCHANGE" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-EXCHANGE" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-exchange \- add or remove exchange from auditor’s list . diff --git a/man/taler-auditor-httpd.1 b/man/taler-auditor-httpd.1 index 6d9cfb4a..d1ceedb5 100644 --- a/man/taler-auditor-httpd.1 +++ b/man/taler-auditor-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-httpd \- HTTP server providing a RESTful API to access a Taler auditor . diff --git a/man/taler-auditor-offline.1 b/man/taler-auditor-offline.1 index 2906837f..23483a68 100644 --- a/man/taler-auditor-offline.1 +++ b/man/taler-auditor-offline.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-OFFLINE" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-OFFLINE" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-offline \- Taler auditor certifies that it audits a Taler exchange . diff --git a/man/taler-auditor-sync.1 b/man/taler-auditor-sync.1 index 4e006ad6..785b46ce 100644 --- a/man/taler-auditor-sync.1 +++ b/man/taler-auditor-sync.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-SYNC" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-SYNC" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-sync \- tool to safely synchronize auditor database . diff --git a/man/taler-auditor.1 b/man/taler-auditor.1 index 54e3705b..924dfa11 100644 --- a/man/taler-auditor.1 +++ b/man/taler-auditor.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor \- audit exchange . diff --git a/man/taler-config.1 b/man/taler-config.1 index ddff673a..a53e2e9f 100644 --- a/man/taler-config.1 +++ b/man/taler-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-CONFIG" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-CONFIG" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-config \- Taler configuration inspection and editing . diff --git a/man/taler-exchange-aggregator.1 b/man/taler-exchange-aggregator.1 index ae6c3f0f..12b9c63b 100644 --- a/man/taler-exchange-aggregator.1 +++ b/man/taler-exchange-aggregator.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-AGGREGATOR" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-AGGREGATOR" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-aggregator \- aggregate deposits into wire transfers . diff --git a/man/taler-exchange-benchmark.1 b/man/taler-exchange-benchmark.1 index be60dc71..822a2768 100644 --- a/man/taler-exchange-benchmark.1 +++ b/man/taler-exchange-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-BENCHMARK" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-BENCHMARK" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-benchmark \- measure exchange performance . diff --git a/man/taler-exchange-closer.1 b/man/taler-exchange-closer.1 index c6005490..b56fc78a 100644 --- a/man/taler-exchange-closer.1 +++ b/man/taler-exchange-closer.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-CLOSER" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-CLOSER" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-closer \- close idle reserves . diff --git a/man/taler-exchange-dbinit.1 b/man/taler-exchange-dbinit.1 index 8ecd69ed..3c4e4e32 100644 --- a/man/taler-exchange-dbinit.1 +++ b/man/taler-exchange-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-dbinit \- initialize Taler exchange database . diff --git a/man/taler-exchange-drain.1 b/man/taler-exchange-drain.1 new file mode 100644 index 00000000..e8cbf4f6 --- /dev/null +++ b/man/taler-exchange-drain.1 @@ -0,0 +1,78 @@ +.\" Man page generated from reStructuredText. +. +.TH "TALER-EXCHANGE-DRAIN" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.SH NAME +taler-exchange-drain \- drain profits from exchange +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBtaler\-exchange\-drain\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBtaler\-exchange\-drain\fP is used to trigger a wire transfer from the exchange\(aqs escrow account to a normal (non\-escrowed) bank account of the exchange. The entire drain process is necessary to ensure that the auditor is aware of the +balance changes arising from an exchange making profits from fees. +.sp +To use it, you must first create an upload a \(aqdrain\(aq command using \fBtaler\-exchange\-offline\fP\&. Afterwards this command should be run to actually queue the drain. The actual drain will then be executed by \fBtaler\-exchange\-transfer\fP\&. +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the exchange to operate +from \fIFILENAME\fP\&. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, +\fBWARNING\fP, \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-v\fP | \fB\-\-version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +taler\-exchange\-transfer(1), taler\-exchange\-offline(1), taler.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/taler-exchange-expire.1 b/man/taler-exchange-expire.1 index 1688348e..380e4f1c 100644 --- a/man/taler-exchange-expire.1 +++ b/man/taler-exchange-expire.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-EXPIRE" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-EXPIRE" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-expire \- refund expired purses . diff --git a/man/taler-exchange-httpd.1 b/man/taler-exchange-httpd.1 index 7e3029e1..bd4e45af 100644 --- a/man/taler-exchange-httpd.1 +++ b/man/taler-exchange-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-httpd \- run Taler exchange (with RESTful API) . diff --git a/man/taler-exchange-kyc-tester.1 b/man/taler-exchange-kyc-tester.1 new file mode 100644 index 00000000..fcba8e41 --- /dev/null +++ b/man/taler-exchange-kyc-tester.1 @@ -0,0 +1,105 @@ +.\" Man page generated from reStructuredText. +. +.TH "TALER-EXCHANGE-KYC-TESTER" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.SH NAME +taler-exchange-kyc-tester \- test KYC service integration +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBtaler\-exchange\-kyc\-tester\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-i\fP\ \fISECTION_NAME\fP\ |\ \fB\-\-initiate=\fP\fISECTION_NAME\fP] +[\fB\-u\fP\ \fIID\fP\ |\ \fB\-\-user=\fP\fIID\fP] +[\fB\-U\fP\ \fIID\fP\ |\ \fB\-\-legitimization=\fP\fIID\fP] +[\fB\-P\fP\ |\ \fB\-\-print\-payto\-hash\fP] +[\fB\-p\fP\ \fIHASH\fP\ |\ \fB\-\-payto\-hash=\fP\fIHASH\fP] +[\fB\-r\fP\ \fINUMBER\fP\ |\ \fB\-\-rowid=\fP\fINUMBER\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-w\fP\ |\ \fB\-\-run\-webservice\fP] +.SH DESCRIPTION +.sp +\fBtaler\-exchange\-kyc\-tester\fP is used to test the interaction between a Taler exchange and a KYC service. The tool can be used to manually trigger the various steps of a KYC process and to observe the interaction with the respective KYC service. It is supposted to help test the configuration of the integration, and \fInot\fP required at all during production. +.sp +To use it, you must first provide a configuration file with at least one KYC service configured. Some other exchange\-specific options, like the PORT for the HTTP service and the BASE_URL under which the Taler exchange will run are also required. You should be able to use exactly the same configuration file that one would usually give to a Taler exchange. Starting with this, the tool allows the simulation of a KYC process. Note that it will not write any information to the database. +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the exchange to operate +from \fIFILENAME\fP\&. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, +\fBWARNING\fP, \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-i\fP \fISECTION_NAME\fP | \fB\-\-initiate=\fP\fISECTION_NAME\fP +Start a fresh KYC process using the KYC provider configured in SECTION_NAME of the configuration. This will output the HTTP URL where the user has to begin the KYC process to the command\-line. This is usually the first thing to do when using this tool. Outputs the KYC\-logic specific user and legitimization IDs, or NULL if not used by the KYC\-logic at the initiation stage. +.TP +\fB\-u\fP \fIID\fP | \fB\-\-user=\fP\fIID\fP +Run the process with ID for the user identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP as that option will override whatever value is provided here. +.TP +\fB\-U\fP \fIID\fP | \fB\-\-legitimization=\fP\fIID\fP +Run the process with ID for the legitimization process identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP as that option will override whatever value is provided here. +.TP +\fB\-p\fP \fIHASH\fP | \fB\-\-payto\-hash=\fP\fIHASH\fP +Run the process with HASH as the hash of the payto://\-URI that identifies the account or wallet triggering the KYC requirement. If not given, a fresh random value is used. Rarely useful. +.TP +\fB\-P\fP | \fB\-\-print\-payto\-hash\fP +Print the HASH of the payto://\-URI used for the KYC simulation this time. Useful if the hash is needed for a subsequent use in conjunction with \fB\-p\fP\&. +.TP +\fB\-r\fP \fINUMBER\fP | \fB\-\-rowid=\fP\fINUMBER\fP +Run the process with NUMBER as the database row for the legitimization operation. Rarely useful, except maybe for debugging. Defaults to 42. +.TP +\fB\-v\fP | \fB\-\-version\fP +Print version information. +.TP +\fB\-w\fP | \fB\-\-run\-webservice\fP +Run a simulated Taler exchange HTTP service on the configured port with the \fB/kyc\-proof/\fP and \fB/kyc\-webhook/\fP endpoints. +.UNINDENT +.SH SEE ALSO +.sp +taler\-exchange\-httpd(1), taler.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/taler-exchange-offline.1 b/man/taler-exchange-offline.1 index b6e17644..bc02e1cc 100644 --- a/man/taler-exchange-offline.1 +++ b/man/taler-exchange-offline.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-OFFLINE" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-OFFLINE" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-offline \- operations using the offline key of a Taler exchange . @@ -166,6 +166,26 @@ subcommand. Note that an extension on the exchange will only become activated at runtime \fIafter\fP the extension\(aqs configurations has been signed by the offline tool with the signing key and the signed configuration been uploaded to the exchange. +.SS drain +.sp +This subcommand allows an exchange operator to transfer the +profits made from transaction fees to a regular (non\-escrowed) bank +account. Using this command, draining profits from the +escrow account can be done in such a way that the auditor +is aware of the special transaction and does not flag the +resulting balance as fundamentally problematic. Note that +the drained amounts must still total up to less than the fees +earned by the exchange. +.sp +Arguments to the \fBdrain\fP command are the amount to be drained (in the usual +Taler amount format), the section of the exchange configuration specifying the +account to be debited (this argument is currently ignored, and the account is +purely derived from the wire method and the account being set for debiting), +and finally the payto://\-URI to wire the funds to. +.sp +Note that to actually wire the funds, the exchange administrator must run +\fBtaler\-exchange\-drain\fP manually and confirm the operation after the +\fBupload\fP was completed. .SS revoke\-denomination .sp This subcommand signs a revocation message for a denomination key. @@ -233,7 +253,7 @@ the exchange on its \fB/wire\fP endpoint. Note that this does \fInot\fP ensure the exchange will use this bank account for incoming or outgoing wire transfers! For this, the \fBtaler\-exchange\-transfer\fP and \fBtaler\-exchange\-wirewatch\fP tools must be configured. Furthermore, the bank -account information advertized could theoretically differ from that which +account information advertised could theoretically differ from that which these tool actually use, for example if the public bank account is only a front for the actual internal business accounts. .sp @@ -259,13 +279,13 @@ It outputs the signature affirming the deletion of the wire account, in a format suitable for the \fBupload\fP subcommand. .SS wire\-fee .sp -This subcommand informs an exchange about the desired wire fee structure (that is, wire, closing and wad fees) +This subcommand informs an exchange about the desired wire fee structure (that is, wire, and closing fees) for particular wire method and a calendar year (!). The tool does not permit changing wire fees during a calendar year. Also, once the wire fee has been set for a calendar year, it cannot be changed. .sp The subcommand takes the year, wire\-method (see RFC 8905, examples include -\fBx\-taler\-bank\fP or \fBiban\fP), wire fee, closing fee and wad fee as arguments. +\fBx\-taler\-bank\fP or \fBiban\fP), wire fee, and closing fee as arguments. Instead of a year, the string \fBnow\fP can be given for the current year (this is mostly useful for test cases). The wire\-method should follow the GANA registry as given in RFC 8905. The fees must be given in the usual @@ -282,8 +302,8 @@ related global configuration options for a calendar year (!). The tool does not permit changing global fees during a calendar year. Also, once the global fee structure has been set for a calendar year, it cannot be changed. .sp -The subcommand takes the year, history fee, kyc fee, account fee, purse fee, -purse timeout, kyc timeout, history expiration and the (free) purse (per) +The subcommand takes the year, history fee, account fee, purse fee, +purse timeout, history expiration and the (free) purse (per) account limit as arguments. Instead of a year, the string \fBnow\fP can be given for the current year (this is mostly useful for test cases). The fees must be given in the usual Taler format of \fBCURRENCY:NUMBER.FRACTION\fP\&. diff --git a/man/taler-exchange-router.1 b/man/taler-exchange-router.1 index f171b8d6..9bcb18b3 100644 --- a/man/taler-exchange-router.1 +++ b/man/taler-exchange-router.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-ROUTER" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-ROUTER" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-router \- route payments to partner exchanges . diff --git a/man/taler-exchange-secmod-cs.1 b/man/taler-exchange-secmod-cs.1 index bc000714..cdf80b0c 100644 --- a/man/taler-exchange-secmod-cs.1 +++ b/man/taler-exchange-secmod-cs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-SECMOD-CS" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-CS" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-cs \- handle private CS key operations for a Taler exchange . diff --git a/man/taler-exchange-secmod-eddsa.1 b/man/taler-exchange-secmod-eddsa.1 index 33d016d1..8fcdbadf 100644 --- a/man/taler-exchange-secmod-eddsa.1 +++ b/man/taler-exchange-secmod-eddsa.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-SECMOD-EDDSA" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-EDDSA" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-eddsa \- handle private EDDSA key operations for a Taler exchange . diff --git a/man/taler-exchange-secmod-rsa.1 b/man/taler-exchange-secmod-rsa.1 index 8bdb8c94..c1df0acb 100644 --- a/man/taler-exchange-secmod-rsa.1 +++ b/man/taler-exchange-secmod-rsa.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-SECMOD-RSA" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-RSA" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-rsa \- handle private RSA key operations for a Taler exchange . diff --git a/man/taler-exchange-transfer.1 b/man/taler-exchange-transfer.1 index 912ffef5..1e541ee6 100644 --- a/man/taler-exchange-transfer.1 +++ b/man/taler-exchange-transfer.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-TRANSFER" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-TRANSFER" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-transfer \- execute wire transfers . diff --git a/man/taler-exchange-wire-gateway-client.1 b/man/taler-exchange-wire-gateway-client.1 index 19fa7f71..da313c2d 100644 --- a/man/taler-exchange-wire-gateway-client.1 +++ b/man/taler-exchange-wire-gateway-client.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-WIRE-GATEWAY-CLIENT" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-WIRE-GATEWAY-CLIENT" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-wire-gateway-client \- trigger a transfer at the bank . diff --git a/man/taler-exchange-wirewatch.1 b/man/taler-exchange-wirewatch.1 index ae4c9b19..43c69983 100644 --- a/man/taler-exchange-wirewatch.1 +++ b/man/taler-exchange-wirewatch.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-WIREWATCH" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-WIREWATCH" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-wirewatch \- watch for incoming wire transfers . diff --git a/man/taler-helper-auditor-aggregation.1 b/man/taler-helper-auditor-aggregation.1 index bcbbda07..49d2ae0f 100644 --- a/man/taler-helper-auditor-aggregation.1 +++ b/man/taler-helper-auditor-aggregation.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-AGGREGATION" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-AGGREGATION" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-aggregation \- audit Taler exchange aggregation activity . diff --git a/man/taler-helper-auditor-coins.1 b/man/taler-helper-auditor-coins.1 index 72926925..518b57be 100644 --- a/man/taler-helper-auditor-coins.1 +++ b/man/taler-helper-auditor-coins.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-COINS" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-COINS" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-coins \- audit Taler coin processing . diff --git a/man/taler-helper-auditor-deposits.1 b/man/taler-helper-auditor-deposits.1 index 9eb5823b..d9ea1b52 100644 --- a/man/taler-helper-auditor-deposits.1 +++ b/man/taler-helper-auditor-deposits.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-DEPOSITS" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-DEPOSITS" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-deposits \- audit Taler exchange database for deposit confirmation consistency . diff --git a/man/taler-helper-auditor-purses.1 b/man/taler-helper-auditor-purses.1 new file mode 100644 index 00000000..130b1c56 --- /dev/null +++ b/man/taler-helper-auditor-purses.1 @@ -0,0 +1,94 @@ +.\" Man page generated from reStructuredText. +. +.TH "TALER-HELPER-AUDITOR-PURSES" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.SH NAME +taler-helper-auditor-purses \- audit Taler exchange purse handling +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBtaler\-helper\-auditor\-purses\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fBi\fP\ |\ \fB\-\-internal\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-m\fP\ \fIKEY\fP\ |\ \fB\-\-exchange\-key=\fP\fIKEY\fP] +[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBtaler\-helper\-auditor\-purses\fP is a command\-line tool to +audit Taler exchange purse handling. +.sp +FIXME: More detail. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the auditor to operate +from \fIFILENAME\fP\&. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-i\fP | \fB\-\-internal\fP +Perform checks only applicable for exchange\-internal audits. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, +\fBWARNING\fP, \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-m\fP \fIKEY\fP | \fB\-\-exchange\-key=\fP\fIKEY\fP +Use \fIKEY\fP (Crockford base32 encoded) as the public key of the exchange. +.TP +\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +Modify the system time by \fIUSEC\fP microseconds. +\fIUSEC\fP may be prefixed with \fB+\fP or \fB\-\fP (e.g. \fB\-T +300\fP). +This option is intended for debugging/testing only. +.TP +\fB\-v\fP | \fB\-\-version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +taler\-auditor(1), taler.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/taler-helper-auditor-reserves.1 b/man/taler-helper-auditor-reserves.1 index b7b99909..a25f3357 100644 --- a/man/taler-helper-auditor-reserves.1 +++ b/man/taler-helper-auditor-reserves.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-RESERVES" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-RESERVES" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-reserves \- audit Taler exchange reserve handling . diff --git a/man/taler-helper-auditor-wire.1 b/man/taler-helper-auditor-wire.1 index 15fe72c9..a1a667ce 100644 --- a/man/taler-helper-auditor-wire.1 +++ b/man/taler-helper-auditor-wire.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-WIRE" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-WIRE" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-wire \- audit exchange database for consistency with the bank's wire transfers . diff --git a/man/taler-merchant-benchmark.1 b/man/taler-merchant-benchmark.1 index 28edd726..88835ea8 100644 --- a/man/taler-merchant-benchmark.1 +++ b/man/taler-merchant-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-BENCHMARK" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-BENCHMARK" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-benchmark \- generate Taler-style benchmarking payments . diff --git a/man/taler-merchant-dbinit.1 b/man/taler-merchant-dbinit.1 index 1dee4e3d..7bf4fb46 100644 --- a/man/taler-merchant-dbinit.1 +++ b/man/taler-merchant-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-dbinit \- initialize Taler merchant database . diff --git a/man/taler-merchant-httpd.1 b/man/taler-merchant-httpd.1 index 54e91453..1215735c 100644 --- a/man/taler-merchant-httpd.1 +++ b/man/taler-merchant-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-httpd \- run Taler merchant backend (with RESTful API) . diff --git a/man/taler-merchant-setup-reserve.1 b/man/taler-merchant-setup-reserve.1 index e0437f59..88e9f0f3 100644 --- a/man/taler-merchant-setup-reserve.1 +++ b/man/taler-merchant-setup-reserve.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-SETUP-RESERVE" "1" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-SETUP-RESERVE" "1" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-setup-reserve \- setup reserve for tipping at a Taler merchant backend . diff --git a/man/taler.conf.5 b/man/taler.conf.5 index a5088433..9c393d4c 100644 --- a/man/taler.conf.5 +++ b/man/taler.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER.CONF" "5" "Jul 06, 2022" "0.9" "GNU Taler" +.TH "TALER.CONF" "5" "Nov 03, 2022" "0.9" "GNU Taler" .SH NAME taler.conf \- Taler configuration file . @@ -205,39 +205,39 @@ Works the same as \fBTERMS_DIR\fP, just for the privacy policy. .TP .B PRIVACY_ETAG Works the same as \fBTERMS_ETAG\fP, just for the privacy policy. +.UNINDENT +.SS EXCHANGE KYC PROVIDER OPTIONS +.sp +The following options must be in the section "[kyc\-provider\-XXX]" sections. +.INDENT 0.0 +.TP +.B COST +Relative cost of the KYC provider, non\-negative number. .TP -.B KYC_MODE -Set to "NONE" to disable KYC for this exchange (but check with your lawyer first). -Set to "OAUTH2" to use OAuth2 for KYC. -.TP -.B KYC_WITHDRAW_LIMIT -Maximum amount that can be withdrawn in -KYC_WITHDRAW_PERIOD without needing KYC. -Only used if KYC_MODE is not "NONE". -.TP -.B KYC_WITHDRAW_PERIOD -The time period over which transactions -are considered for the KYC_WITHDRAW_LIMIT. -Only used if KYC_MODE is not "NONE". -.TP -.B KYC_WALLET_BALANCE_LIMIT -Maximum amount that a wallet is allowed to hold without -having to undergo the KYC process of the issuing -exchange. Optional option, if not given there -is no limit. +.B LOGIC +API type of the KYC provider. +.TP +.B USER_TYPE +Type of user this provider is for, either INDIVIDUAL or BUSINESS. +.TP +.B PROVIDED_CHECKS +List of checks performed by this provider. Space\-separated names of checks, must match check names in legitimization rules. .UNINDENT .SS EXCHANGE KYC OAUTH2 OPTIONS .sp -The following options must be in the section "[exchange\-kyc\-oauth2]". +The following options must be in the section "[kyc\-provider\-XXX]" sections with "LOGIC = oauth2". .INDENT 0.0 .TP +.B KYC_OAUTH2_VALIDITY +Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever". +.TP .B KYC_OAUTH2_AUTH_URL URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/oauth/v2/login\fP" (or "/token") .TP .B KYC_OAUTH2_LOGIN_URL URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/oauth/v2/login\fP" .TP -.B KYC_INFO_URL +.B KYC_OAUTH2_INFO_URL URL of the endpoint where the OAuth 2.0 token can be used to download the user\(aqs details. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/api/user/me\fP" .TP .B KYC_OAUTH2_CLIENT_ID @@ -249,6 +249,23 @@ Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Re .B KYC_OAUTH2_POST_URL URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process. .UNINDENT +.SS EXCHANGE KYC KYCAID OPTIONS +.sp +The following options must be in the section "[kyc\-provider\-XXX]" sections with "LOGIC = kycaid". +.INDENT 0.0 +.TP +.B KYC_KYCAID_VALIDITY +Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever". +.TP +.B KYC_KYCAID_AUTH_TOKEN +Authentication token to access the KYC service. +.TP +.B KYC_KYCAID_FORM_ID +ID that specifies the form to use for the KYC process. +.TP +.B KYC_KYCAID_POST_URL +URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process. +.UNINDENT .SS EXCHANGE OFFLINE SIGNING OPTIONS .sp The following options must be in the section "[exchange\-offline]". |