diff options
43 files changed, 958 insertions, 939 deletions
diff --git a/man/libeufin-nexus.1 b/man/libeufin-nexus.1 index b3f25871..ae91147a 100644 --- a/man/libeufin-nexus.1 +++ b/man/libeufin-nexus.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "LIBEUFIN-NEXUS" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "LIBEUFIN-NEXUS" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME libeufin-nexus \- sevice to interface to various bank access APIs . @@ -33,9 +33,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBlibeufin\-nexus\fP -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-\-version\fP] -COMMAND [ARGS...] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB–version\fP] +COMMAND [ARGS…] .sp Commands: serve, superuser, parse\-camt, reset\-tables .SH DESCRIPTION @@ -53,7 +53,7 @@ useful for doing administrative tasks. Its options are as follows: .INDENT 0.0 .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP \fB–version\fP diff --git a/man/libeufin-sandbox.1 b/man/libeufin-sandbox.1 index ed149189..452739a6 100644 --- a/man/libeufin-sandbox.1 +++ b/man/libeufin-sandbox.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "LIBEUFIN-SANDBOX" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "LIBEUFIN-SANDBOX" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME libeufin-sandbox \- simulate core banking system with EBICS access to bank accounts . @@ -33,9 +33,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBlibeufin\-sandbox\fP -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-\-version\fP] -COMMAND [ARGS...] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB–version\fP] +COMMAND [ARGS…] .sp Commands: serve, reset\-tables, config, make\-transaction, camt053tick default\-exchange @@ -49,12 +49,12 @@ requests either over the network or via a Unix domain socket. Related program \fBlibeufin\-cli\fP is the preferred front end for that mode of operation. There is also a mode where \fBlibeufin\-sandbox\fP accepts commands directly, -useful for configuring one or more "demobank" (simulated bank) instances. +useful for configuring one or more “demobank” (simulated bank) instances. .sp Its options are as follows: .INDENT 0.0 .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP \fB–version\fP @@ -132,7 +132,7 @@ This sets the default exchange for demobank \fBbank01\fP\&. It is an error if the demobank does not exist. .SS make\-transaction .sp -This is a "legacy" command, useful in a previous iteration of LibEuFin +This is a “legacy” command, useful in a previous iteration of LibEuFin and for internal testing. It creates and records a wire transfer transaction in the database. .sp diff --git a/man/sync-config.1 b/man/sync-config.1 index d2788937..e3097a12 100644 --- a/man/sync-config.1 +++ b/man/sync-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-CONFIG" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "SYNC-CONFIG" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME sync-config \- manipulate Sync configuration files . @@ -33,69 +33,69 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBsync\-config\fP -[\fB\-b\fP\ \fIbackend\fP\ |\ \fB\-\-supported\-backend=\fP\fIbackend\fP] -[\fB\-c\fP\ \fIfilename\fP\ |\ \fB\-\-config=\fP\fIfilename\fP] -[\fB\-f\fP\ |\ \fB\-\-filename\fP] -[\fB\-F\fP\ |\ \fB\-\-full\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\-o\fP\ \fIoption\fP\ |\ \fB\-\-option=\fP\fIoption\fP] -[\fB\-r\fP\ |\ \fB\-\-rewrite\fP] -[\fB\-S\fP\ |\ \fB\-\-list\-sections\fP] -[\fB\-s\fP\ \fIsection\fP\ |\ \fB\-\-section=\fP\fIsection\fP] -[\fB\-V\fP\ \fIvalue\fP\ |\ \fB\-\-value=\fP\fIvalue\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-b\fP\ \fIbackend\fP\ |\ \fB–supported\-backend=\fP\fIbackend\fP] +[\fB\-c\fP\ \fIfilename\fP\ |\ \fB–config=\fP\fIfilename\fP] +[\fB\-f\fP\ |\ \fB–filename\fP] +[\fB\-F\fP\ |\ \fB–full\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\-o\fP\ \fIoption\fP\ |\ \fB–option=\fP\fIoption\fP] +[\fB\-r\fP\ |\ \fB–rewrite\fP] +[\fB\-S\fP\ |\ \fB–list\-sections\fP] +[\fB\-s\fP\ \fIsection\fP\ |\ \fB–section=\fP\fIsection\fP] +[\fB\-V\fP\ \fIvalue\fP\ |\ \fB–value=\fP\fIvalue\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBsync\-config\fP can be used to read or modify Sync configuration files. .INDENT 0.0 .TP -\fB\-b\fP \fIBACKEND\fP | \fB\-\-supported\-backend=\fP\fIBACKEND\fP +\fB\-b\fP \fIBACKEND\fP | \fB–supported\-backend=\fP\fIBACKEND\fP Tests whether the specified \fIBACKEND\fP is supported by the current installation. -The backend must match the name of a plugin, i.e. "namestore_postgres" for -the PostgreSQL database backend of the "NAMESTORE" service. If \fIBACKEND\fP is +The backend must match the name of a plugin, i.e. “namestore_postgres” for +the PostgreSQL database backend of the “NAMESTORE” service. If \fIBACKEND\fP is supported, sync\-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause sync\-config to return a status code of 1 (error). .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration file \fIFILENAME\fP\&. .TP -\fB\-f\fP | \fB\-\-filename\fP +\fB\-f\fP | \fB–filename\fP Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename). .TP -\fB\-F\fP | \fB\-\-full\fP +\fB\-F\fP | \fB–full\fP Write the full configuration file, not just the differences to the defaults. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\fB\-L\fP \fILOGLEVEL\fP | \fB–loglevel=\fP\fILOGLEVEL\fP Use \fILOGLEVEL\fP for logging. Valid values are \fBDEBUG\fP, \fBINFO\fP, \fBWARNING\fP, and \fBERROR\fP\&. .TP -\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-o\fP \fIOPTION\fP | \fB\-\-option=\fP\fIOPTION\fP +\fB\-o\fP \fIOPTION\fP | \fB–option=\fP\fIOPTION\fP Which configuration option should be accessed or edited. Required to set a value. If not given, all values of a given section will be printed in the -format "OPTION = VALUE". +format “OPTION = VALUE”. .TP -\fB\-r\fP | \fB\-\-rewrite\fP +\fB\-r\fP | \fB–rewrite\fP Write the configuration file even if nothing changed. Will remove all comments! .TP -\fB\-S\fP | \fB\-\-list\-sections\fP +\fB\-S\fP | \fB–list\-sections\fP List available configuration sections for use with \fB\-\-section\fP\&. .TP -\fB\-s\fP \fISECTION\fP | \fB\-\-section=\fP\fISECTION\fP +\fB\-s\fP \fISECTION\fP | \fB–section=\fP\fISECTION\fP Which configuration section should be accessed or edited. Required option. .TP -\fB\-V\fP \fIVALUE\fP | \fB\-\-value=\fP\fIVALUE\fP +\fB\-V\fP \fIVALUE\fP | \fB–value=\fP\fIVALUE\fP Configuration value to store in the given section under the given option. Must only be given together with \fB\-s\fP and \fB\-o\fP options. .INDENT 7.0 @@ -105,7 +105,7 @@ Changing the configuration file with \fB\-V\fP will remove comments and may reorder sections and remove \fB@INLINE@\fP directives. .UNINDENT .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print GNU Taler version number. .UNINDENT .SH SEE ALSO diff --git a/man/sync-dbinit.1 b/man/sync-dbinit.1 index 37394eb1..ab5f53ce 100644 --- a/man/sync-dbinit.1 +++ b/man/sync-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-DBINIT" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "SYNC-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME sync-dbinit \- initialize the Sync database . @@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBsync\-dbinit\fP -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-g\fP\ |\ \fB\-\-garbagecollect\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-r\fP\ |\ \fB\-\-reset\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-g\fP\ |\ \fB–garbagecollect\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–log=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-r\fP\ |\ \fB–reset\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBsync\-dbinit\fP is a command\-line tool to initialize the Sync database. @@ -47,23 +47,23 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the Sync commands to operate from \fIFILENAME\fP\&. .TP -\fB\-g\fP | \fB\-\-garbagecollect\fP +\fB\-g\fP | \fB–garbagecollect\fP Remove state data from database. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log=\fP\fILOGLEVEL\fP +\fB\-L\fP \fILOGLEVEL\fP | \fB–log=\fP\fILOGLEVEL\fP Configure logging to use \fILOGLEVEL\fP\&. .TP -\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Configure logging to write logs to \fIFILENAME\fP\&. .TP -\fB\-r\fP | \fB\-\-reset\fP +\fB\-r\fP | \fB–reset\fP Reset database. (\fBDANGEROUS\fP: All existing data is lost!) .TP \fB\-v\fP | \fB–version\fP diff --git a/man/sync-httpd.1 b/man/sync-httpd.1 index 68192db1..1ed1844f 100644 --- a/man/sync-httpd.1 +++ b/man/sync-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-HTTPD" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "SYNC-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME sync-httpd \- provide the Sync HTTP interface . @@ -33,16 +33,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBsync\-httpd\fP -[\fB\-A\fP\ \fIUSERNAME:PASSWORD\fP\ |\ \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP] -[\fB\-C\fP\ |\ \fB\-\-connection\-close\fP] -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-k\fP\ \fIKEYFILE\fP\ |\ \fB\-\-key=\fP\fIKEYFILE\fP] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-p\fP\ \fIKEYFILEPASSPHRASE\fP\ |\ \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP] -[\fB\-t\fP\ \fICERTTYPE\fP\ |\ \fB\-\-type=\fP\fICERTTYPE\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-A\fP\ \fIUSERNAME:PASSWORD\fP\ |\ \fB–auth=\fP\fIUSERNAME:PASSWORD\fP] +[\fB\-C\fP\ |\ \fB–connection\-close\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-k\fP\ \fIKEYFILE\fP\ |\ \fB–key=\fP\fIKEYFILE\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–log=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-p\fP\ \fIKEYFILEPASSPHRASE\fP\ |\ \fB–pass=\fP\fIKEYFILEPASSPHRASE\fP] +[\fB\-t\fP\ \fICERTTYPE\fP\ |\ \fB–type=\fP\fICERTTYPE\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBsync\-httpd\fP is a command\-line tool to provide the Sync HTTP interface. @@ -50,32 +50,32 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] Its options are as follows: .INDENT 0.0 .TP -\fB\-A\fP \fIUSERNAME:PASSWORD\fP | \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP +\fB\-A\fP \fIUSERNAME:PASSWORD\fP | \fB–auth=\fP\fIUSERNAME:PASSWORD\fP Use the given \fIUSERNAME\fP and \fIPASSWORD\fP for client authentication. .TP -\fB\-C\fP | \fB\-\-connection\-close\fP +\fB\-C\fP | \fB–connection\-close\fP Force HTTP connections to be closed after each request. .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the Sync commands to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-k\fP \fIKEYFILE\fP | \fB\-\-key=\fP\fIKEYFILE\fP +\fB\-k\fP \fIKEYFILE\fP | \fB–key=\fP\fIKEYFILE\fP Consult \fIKEYFILE\fP for the private TLS key for TLS client authentication. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log=\fP\fILOGLEVEL\fP +\fB\-L\fP \fILOGLEVEL\fP | \fB–log=\fP\fILOGLEVEL\fP Configure logging to use \fILOGLEVEL\fP\&. .TP -\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Configure logging to write logs to \fIFILENAME\fP\&. .TP -\fB\-p\fP \fIKEYFILEPASSPHRASE\fP | \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP +\fB\-p\fP \fIKEYFILEPASSPHRASE\fP | \fB–pass=\fP\fIKEYFILEPASSPHRASE\fP Use \fIKEYFILEPASSPHRASE\fP to decrypt the TLS client private key file. .TP -\fB\-t\fP \fICERTTYPE\fP | \fB\-\-type=\fP\fICERTTYPE\fP +\fB\-t\fP \fICERTTYPE\fP | \fB–type=\fP\fICERTTYPE\fP Use \fICERTTYPE\fP as the type of the TLS client certificate. If unspecified, defaults to PEM. .TP diff --git a/man/sync.conf.5 b/man/sync.conf.5 index ea9dd093..f7086469 100644 --- a/man/sync.conf.5 +++ b/man/sync.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC.CONF" "5" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "SYNC.CONF" "5" "Jul 06, 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 6a91ecfe..c9ca739a 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-dbinit \- setup auditor database . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-auditor\-dbinit\fP -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-g\fP\ |\ \fB\-\-gc\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\-R\fP\ |\ \fB\-\-reset\fP] -[\fB\-r\fP\ |\ \fB\-\-restart\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-g\fP\ |\ \fB–gc\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\-R\fP\ |\ \fB–reset\fP] +[\fB\-r\fP\ |\ \fB–restart\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-dbinit\fP is a command\-line tool to initialize the Taler @@ -50,32 +50,32 @@ Taler exchange to operate. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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\-g\fP | \fB\-\-gc\fP +\fB\-g\fP | \fB–gc\fP Garbage collect database. Deletes all unnecessary data in the database. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-R\fP | \fB\-\-reset\fP +\fB\-R\fP | \fB–reset\fP Drop tables. Dangerous, will delete all existing data in the database. .TP -\fB\-r\fP | \fB\-\-restart\fP +\fB\-r\fP | \fB–restart\fP Restart all auditors from the beginning. Useful for testing. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-auditor-exchange.1 b/man/taler-auditor-exchange.1 index 295158a3..44a84bdd 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-EXCHANGE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-exchange \- add or remove exchange from auditor’s list . @@ -33,12 +33,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-auditor\-exchange\fP -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-m\fP\ \fIMASTERKEY\fP\ |\ \fB\-\-exchange\-key=\fP\fIMASTERKEY\fP] -[\fB\-r\fP\ |\ \fB\-\-remove\fP] -[\fB\-u\fP\ \fIEXCHANGE_URL\fP\ |\ \fB\-\-auditor\-url=\fP\fIEXCHANGE_URL\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-m\fP\ \fIMASTERKEY\fP\ |\ \fB–exchange\-key=\fP\fIMASTERKEY\fP] +[\fB\-r\fP\ |\ \fB–remove\fP] +[\fB\-u\fP\ \fIEXCHANGE_URL\fP\ |\ \fB–auditor\-url=\fP\fIEXCHANGE_URL\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-auditor\-exchange\fP is a command\-line tool to be used by an @@ -49,27 +49,27 @@ taler\-auditor or taler\-wire\-auditor. Afterwards the exchange will be visible via the /exchanges API of the taler\-auditor\-httpd. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-m\fP \fIMASTERKEY\fP | \fB\-\-exchange\-key=\fP\fIMASTERKEY\fP +\fB\-m\fP \fIMASTERKEY\fP | \fB–exchange\-key=\fP\fIMASTERKEY\fP Public key of the exchange in Crockford base32 encoding, for example as generated by \fBtaler\-auditor\-offline setup\fP\&. .TP -\fB\-r\fP | \fB\-\-remove\fP +\fB\-r\fP | \fB–remove\fP Instead of adding the exchange, remove it. Note that this will drop ALL data associated with that exchange, including existing auditing information. So use with extreme care! .TP -\fB\-u\fP \fIEXCHANGE_URL\fP | \fB\-\-auditor\-url=\fP\fIEXCHANGE_URL\fP +\fB\-u\fP \fIEXCHANGE_URL\fP | \fB–auditor\-url=\fP\fIEXCHANGE_URL\fP URL of the exchange. The exchange’s HTTP API must be available at this address. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH DIAGNOSTICS diff --git a/man/taler-auditor-httpd.1 b/man/taler-auditor-httpd.1 index 3bcbdfaa..61cffcd0 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-httpd \- HTTP server providing a RESTful API to access a Taler auditor . @@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-auditor\-httpd\fP -[\fB\-C\fP\ |\ \fB\-\-connection\-close\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\-t\fP\ \fISECONDS\fP\ |\ \fB\-\-timeout\fP\fISECONDS\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-C\fP\ |\ \fB–connection\-close\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\-t\fP\ \fISECONDS\fP\ |\ \fB–timeout\fP\fISECONDS\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-auditor\-httpd\fP is a command\-line tool to run the Taler auditor @@ -48,30 +48,30 @@ before running this command. .SH OPTIONS .INDENT 0.0 .TP -\fB\-C\fP | \fB\-\-connection\-close\fP +\fB\-C\fP | \fB–connection\-close\fP Force each HTTP connection to be closed after each request (useful in combination with \-f to avoid having to wait for nc to time out). .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the auditor to operate from FILENAME. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-t\fP \fISECONDS\fP | \fB\-\-timeout=\fP\fISECONDS\fP +\fB\-t\fP \fISECONDS\fP | \fB–timeout=\fP\fISECONDS\fP Specifies the number of \fISECONDS\fP after which the HTTPD should close (idle) HTTP connections. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SIGNALS diff --git a/man/taler-auditor-offline.1 b/man/taler-auditor-offline.1 index ef1c81f3..7993f4f8 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-OFFLINE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-offline \- Taler auditor certifies that it audits a Taler exchange . @@ -33,12 +33,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-auditor\-offline\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] -[subcommand ...] +[\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] +[subcommand …] .SH DESCRIPTION .sp \fBtaler\-auditor\-offline\fP is a command\-line tool to be used by an auditor to @@ -47,7 +47,7 @@ signature, the auditor affirms that he will verify that the exchange is properly accounting for coins of those denominations. The tool takes a list of subcommands as arguments which are then processed sequentially. .sp -The tool includes two subcommands to interact \fIonline\fP with the exchange\(aqs +The tool includes two subcommands to interact \fIonline\fP with the exchange’s REST APIs. The \fBdownload\fP subcommand downloads current public keys from the running exchange. Note that this only includes keys that the exchange operator has previously validated using the \fBtaler\-exchange\-offline\fP tool. @@ -55,10 +55,10 @@ The resulting data serves as input to the \fBsign\fP and \fBshow\fP subcommands. .sp The \fBupload\fP subcommand uploads the signatures created with the private key to the exchange. It handles the output of all subcommands (except \fBdownload\fP). -The \fBdownload\fP and \fBupload\fP subcommands must naturally be run "online" and do not -require access to the auditor\(aqs private key, which should be kept offline. +The \fBdownload\fP and \fBupload\fP subcommands must naturally be run “online” and do not +require access to the auditor’s private key, which should be kept offline. .sp -All other subcommands are intended to be run "offline". However, especially +All other subcommands are intended to be run “offline”. However, especially when testing, it is of course possible to run the subcommands online as well. Generally, subcommands read inputs (beyond command\-line arguments) from \fBstdin\fP\&. However, they may also consume outputs of previous @@ -68,28 +68,28 @@ and if not consumed the final output is printed to \fBstdout\fP\&. The general options for \fBtaler\-auditor\-offline\fP are: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH CONFIGURATION .sp The exchange and the \fBtaler\-auditor\-httpd\fP must both be provided with -the auditor\(aqs public key, such that they can validate messages signed -by the auditor. To obtain the auditor\(aqs public key, use: +the auditor’s public key, such that they can validate messages signed +by the auditor. To obtain the auditor’s public key, use: .INDENT 0.0 .INDENT 3.5 .sp @@ -102,13 +102,13 @@ $ taler\-auditor\-offline setup .UNINDENT .sp Note that if the private key file already exists, the above will simply output -the existing key. Passing additional arguments after setup (including "\-") +the existing key. Passing additional arguments after setup (including “\-“) will cause the output to be encapsulated in JSON. .sp Relevant configuration options for \fBtaler\-auditor\-offline\fP are: .INDENT 0.0 .IP \(bu 2 -\fB[auditor/AUDITOR_PRIV_FILE]\fP \-\-\- where to store the private key +\fB[auditor/AUDITOR_PRIV_FILE]\fP — where to store the private key .UNINDENT .SH SUBCOMMANDS .SS setup diff --git a/man/taler-auditor-sync.1 b/man/taler-auditor-sync.1 index f8eb8928..6ba28d4f 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-SYNC" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor-sync \- tool to safely synchronize auditor database . @@ -33,17 +33,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-auditor\-sync\fP -[\fB\-s\fP\ \fIFILENAME\fP\ |\ \fB\-\-source\-configuration=\fP\fIFILENAME\fP] -[\fB\-d\fP\ \fIFILENAME\fP\ |\ \fB\-\-destination\-configuration=\fP\fIFILENAME\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-b\fP\ \fISIZE\fP\ |\ \fB\-\-batch=\fP\fISIZE\fP] -[\fB\-t\fP\ |\ \fB\-\-terminate\-when\-synchronized\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-s\fP\ \fIFILENAME\fP\ |\ \fB–source\-configuration=\fP\fIFILENAME\fP] +[\fB\-d\fP\ \fIFILENAME\fP\ |\ \fB–destination\-configuration=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-b\fP\ \fISIZE\fP\ |\ \fB–batch=\fP\fISIZE\fP] +[\fB\-t\fP\ |\ \fB–terminate\-when\-synchronized\fP] +[\fB\-v\fP\ |\ \fB–version\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP\fILOGLEVEL\fP] .SH DESCRIPTION .sp \fBtaler\-auditor\-sync\fP is a command\-line tool to synchronize the -Taler auditor\(aqs database in a safe way from a Taler exchange +Taler auditor’s database in a safe way from a Taler exchange database. If the exchange database violates the assumed database invariants (as expressed by database constraints) or attempts to DELETE or UPDATE tables (at least those that the auditor relies @@ -53,31 +53,31 @@ and instead halt with an error. Its options are as follows: .INDENT 0.0 .TP -\fB\-s\fP \fIFILENAME\fP | \fB\-\-source\-configuration=\fP\fIFILENAME\fP +\fB\-s\fP \fIFILENAME\fP | \fB–source\-configuration=\fP\fIFILENAME\fP Use the configuration in \fIFILENAME\fP to access the original (source) exchange database to copy records from. .TP -\fB\-d\fP \fIFILENAME\fP | \fB\-\-destination\-configuration=\fP\fIFILENAME\fP +\fB\-d\fP \fIFILENAME\fP | \fB–destination\-configuration=\fP\fIFILENAME\fP Use the configuration in \fIFILENAME\fP to access the target (destination) exchange database to copy records to. .TP -\fB\-t\fP | \fB\-\-terminate\-when\-synchronized\fP +\fB\-t\fP | \fB–terminate\-when\-synchronized\fP The program should exit once the two databases are in sync, instead of continuously copying more records when the source database is updated. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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\-b\fP \fISIZE\fP | \fB\-\-batch=\fP\fISIZE\fP +\fB\-b\fP \fISIZE\fP | \fB–batch=\fP\fISIZE\fP Target number of records to copy in one transaction. Once the databases are in sync, the batch size is used to determine how long the process sleeps before trying to again synchronize the two databases. Not useful if \fB\-t\fP is used. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-auditor.1 b/man/taler-auditor.1 index b76b818b..9c1b596e 100644 --- a/man/taler-auditor.1 +++ b/man/taler-auditor.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-auditor \- audit exchange . @@ -33,15 +33,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-auditor\fP -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-i**_|_\fP\-\-internal**] -[\fB\-I**_|_\fP\-\-ignore\-not\-found**] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-m\fP\ \fIMASTER_KEY\fP\ |\ \fB\-\-exchange\-key=\fP\fIMASTER_KEY\fP] -[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel\fP\fIUSEC\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-i**_|_\fP–internal**] +[\fB\-I**_|_\fP–ignore\-not\-found**] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-m\fP\ \fIMASTER_KEY\fP\ |\ \fB–exchange\-key=\fP\fIMASTER_KEY\fP] +[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel\fP\fIUSEC\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-auditor\fP is a command\-line tool to be used by an auditor to @@ -55,40 +55,40 @@ incoming and outgoing wire transfers that the bank claims to have matches the exchange’s database. Its options are as follows. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-internal\fP +\fB\-i\fP | \fB–internal\fP Run additional checks that can only performed on the exchange\-internal -database and not the "safe" replicated database at the auditor. +database and not the “safe” replicated database at the auditor. .TP -\fB\-I\fP | \fB\-\-ignore\-not\-found\fP +\fB\-I\fP | \fB–ignore\-not\-found\fP Do not fail if the bank says that the exchange bank account does not (yet) exist. Keep trying. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\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 +\fB\-m\fP \fIKEY\fP | \fB–exchange\-key=\fP\fIKEY\fP Public master key of the exchange in Crockford base32 encoding, for example as generated by \fBtaler\-auditor\-offline setup\fP\&. If this option is missing, taler\-auditor will use the MASTER_PUBLIC_KEY value from the “exchange” section of the configuration. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-config.1 b/man/taler-config.1 index 8026c363..20efb4f1 100644 --- a/man/taler-config.1 +++ b/man/taler-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-CONFIG" "1" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-CONFIG" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-config \- Taler configuration inspection and editing . @@ -33,69 +33,69 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-config\fP -[\fB\-b\fP\ \fIbackend\fP\ |\ \fB\-\-supported\-backend=\fP\fIbackend\fP] -[\fB\-c\fP\ \fIfilename\fP\ |\ \fB\-\-config=\fP\fIfilename\fP] -[\fB\-f\fP\ |\ \fB\-\-filename\fP] -[\fB\-F\fP\ |\ \fB\-\-full\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\-o\fP\ \fIoption\fP\ |\ \fB\-\-option=\fP\fIoption\fP] -[\fB\-r\fP\ |\ \fB\-\-rewrite\fP] -[\fB\-S\fP\ |\ \fB\-\-list\-sections\fP] -[\fB\-s\fP\ \fIsection\fP\ |\ \fB\-\-section=\fP\fIsection\fP] -[\fB\-V\fP\ \fIvalue\fP\ |\ \fB\-\-value=\fP\fIvalue\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-b\fP\ \fIbackend\fP\ |\ \fB–supported\-backend=\fP\fIbackend\fP] +[\fB\-c\fP\ \fIfilename\fP\ |\ \fB–config=\fP\fIfilename\fP] +[\fB\-f\fP\ |\ \fB–filename\fP] +[\fB\-F\fP\ |\ \fB–full\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\-o\fP\ \fIoption\fP\ |\ \fB–option=\fP\fIoption\fP] +[\fB\-r\fP\ |\ \fB–rewrite\fP] +[\fB\-S\fP\ |\ \fB–list\-sections\fP] +[\fB\-s\fP\ \fIsection\fP\ |\ \fB–section=\fP\fIsection\fP] +[\fB\-V\fP\ \fIvalue\fP\ |\ \fB–value=\fP\fIvalue\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-config\fP can be used to read or modify GNU Taler configuration files. .INDENT 0.0 .TP -\fB\-b\fP \fIBACKEND\fP | \fB\-\-supported\-backend=\fP\fIBACKEND\fP +\fB\-b\fP \fIBACKEND\fP | \fB–supported\-backend=\fP\fIBACKEND\fP Tests whether the specified \fIBACKEND\fP is supported by the current installation. -The backend must match the name of a plugin, i.e. "namestore_postgres" for -the PostgreSQL database backend of the "NAMESTORE" service. If \fIBACKEND\fP is +The backend must match the name of a plugin, i.e. “namestore_postgres” for +the PostgreSQL database backend of the “NAMESTORE” service. If \fIBACKEND\fP is supported, taler\-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause taler\-config to return a status code of 1 (error). .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration file \fIFILENAME\fP\&. .TP -\fB\-f\fP | \fB\-\-filename\fP +\fB\-f\fP | \fB–filename\fP Try to perform expansions as if the option values represent filenames (will also be applied even if the option is not really a filename). .TP -\fB\-F\fP | \fB\-\-full\fP +\fB\-F\fP | \fB–full\fP Write the full configuration file, not just the differences to the defaults. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\fB\-L\fP \fILOGLEVEL\fP | \fB–loglevel=\fP\fILOGLEVEL\fP Use \fILOGLEVEL\fP for logging. Valid values are \fBDEBUG\fP, \fBINFO\fP, \fBWARNING\fP, and \fBERROR\fP\&. .TP -\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-o\fP \fIOPTION\fP | \fB\-\-option=\fP\fIOPTION\fP +\fB\-o\fP \fIOPTION\fP | \fB–option=\fP\fIOPTION\fP Which configuration option should be accessed or edited. Required to set a value. If not given, all values of a given section will be printed in the -format "OPTION = VALUE". +format “OPTION = VALUE”. .TP -\fB\-r\fP | \fB\-\-rewrite\fP +\fB\-r\fP | \fB–rewrite\fP Write the configuration file even if nothing changed. Will remove all comments! .TP -\fB\-S\fP | \fB\-\-list\-sections\fP +\fB\-S\fP | \fB–list\-sections\fP List available configuration sections for use with \fB\-\-section\fP\&. .TP -\fB\-s\fP \fISECTION\fP | \fB\-\-section=\fP\fISECTION\fP +\fB\-s\fP \fISECTION\fP | \fB–section=\fP\fISECTION\fP Which configuration section should be accessed or edited. Required option. .TP -\fB\-V\fP \fIVALUE\fP | \fB\-\-value=\fP\fIVALUE\fP +\fB\-V\fP \fIVALUE\fP | \fB–value=\fP\fIVALUE\fP Configuration value to store in the given section under the given option. Must only be given together with \fB\-s\fP and \fB\-o\fP options. .INDENT 7.0 @@ -105,7 +105,7 @@ Changing the configuration file with \fB\-V\fP will remove comments and may reorder sections and remove \fB@INLINE@\fP directives. .UNINDENT .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print GNU Taler version number. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-aggregator.1 b/man/taler-exchange-aggregator.1 index 5d9900da..a60f55f4 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-AGGREGATOR" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-aggregator \- aggregate deposits into wire transfers . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-aggregator\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\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel\fP\fIUSEC\fP] -[\fB\-t\fP\ |\ \fB\-\-test\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] -[\fB\-y**_|_\fP\-\-kyc\-off**] +[\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\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel\fP\fIUSEC\fP] +[\fB\-t\fP\ |\ \fB–test\fP] +[\fB\-v\fP\ |\ \fB–version\fP] +[\fB\-y**_|_\fP–kyc\-off**] .SH DESCRIPTION .sp \fBtaler\-exchange\-aggregator\fP is a command\-line tool to run aggregate deposits @@ -49,35 +49,35 @@ done by \fBtaler\-exchange\-transfer\fP\&. .sp The AGGREGATOR_SHARD_SIZE option can be used to allow multiple aggregator processes to run in parallel and share the load. This is only recommended if a single aggregator is insufficient for the workload. .sp -The aggregator uses a special table to lock shards it is working on. If an aggregator process dies (say due to a power failure), these shard locks may prevent the aggregator from resuming normally. In this case, you must run "taler\-exchange\-dbinit \-s" to release the shard locks before restarting the aggregator. +The aggregator uses a special table to lock shards it is working on. If an aggregator process dies (say due to a power failure), these shard locks may prevent the aggregator from resuming normally. In this case, you must run “taler\-exchange\-dbinit \-s” to release the shard locks before restarting the aggregator. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP | \fB\-\-test\fP +\fB\-t\fP | \fB–test\fP Run in test mode and exit when idle. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .TP -\fB\-y\fP | \fB\-\-kyc\-off\fP +\fB\-y\fP | \fB–kyc\-off\fP Run without KYC checks. Talk with your regulator before using this option. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-benchmark.1 b/man/taler-exchange-benchmark.1 index aa3a2722..50ab5721 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-BENCHMARK" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-benchmark \- measure exchange performance . @@ -33,19 +33,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-benchmark\fP -[\fB\-c\fP\ \fICONFIG_FILENAME\fP\ |\ \fB\-\-config=\fP\fICONFIG_FILENAME\fP] -[\fB\-F\fP\ |\ \fB\-\-reserves\-first\fP] -[\fB\-f\fP\ |\ \fB\-\-fakebank\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-K\fP\ |\ \fB\-\-linger\fP] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log\-level=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-m\fP\ \fIMODE\fP\ |\ \fB\-\-mode=\fP\fIMODE\fP] -[\fB\-n\fP\ \fIHOWMANY_COINS\fP\ |\ \fB\-\-coins\-number=\fP\fIHOWMANY_COINS\fP] -[\fB\-p\fP\ \fINPROCS\fP\ |\ \fB\-\-parallelism=\fP\fINPROCS\fP] -[\fB\-R\fP\ \fIRATE\fP\ |\ \fB\-\-refresh\-rate=\fP\fIRATE\fP] -[\fB\-r\fP\ \fIN\fP\ |\ \fB\-\-reserves=\fP\fIN\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fICONFIG_FILENAME\fP\ |\ \fB–config=\fP\fICONFIG_FILENAME\fP] +[\fB\-F\fP\ |\ \fB–reserves\-first\fP] +[\fB\-f\fP\ |\ \fB–fakebank\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-K\fP\ |\ \fB–linger\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–log\-level=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-m\fP\ \fIMODE\fP\ |\ \fB–mode=\fP\fIMODE\fP] +[\fB\-n\fP\ \fIHOWMANY_COINS\fP\ |\ \fB–coins\-number=\fP\fIHOWMANY_COINS\fP] +[\fB\-p\fP\ \fINPROCS\fP\ |\ \fB–parallelism=\fP\fINPROCS\fP] +[\fB\-R\fP\ \fIRATE\fP\ |\ \fB–refresh\-rate=\fP\fIRATE\fP] +[\fB\-r\fP\ \fIN\fP\ |\ \fB–reserves=\fP\fIN\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-benchmark\fP is a command\-line tool to measure the time @@ -56,50 +56,50 @@ Nginx. Moreover, the benchmark runs on a “volatile” database, that means that table are always erased during a single benchmark run. .INDENT 0.0 .TP -\fB\-c\fP \fICONFIG_FILENAME\fP | \fB\-\-config=\fP\fICONFIG_FILENAME\fP +\fB\-c\fP \fICONFIG_FILENAME\fP | \fB–config=\fP\fICONFIG_FILENAME\fP (Mandatory) Use CONFIG_FILENAME. .TP -\fB\-F\fP | \fB\-\-reserves\-first\fP +\fB\-F\fP | \fB–reserves\-first\fP Create all reserves first, before starting normal operations. .TP -\fB\-f\fP | \fB\-\-fakebank\fP +\fB\-f\fP | \fB–fakebank\fP Launch a fakebank instead of the Python bank. Only meaningful if the mode is to launch more than just a client. Note that using the fakebank will cause the benchmark application to reset all databases as the fakebank is stateless and thus previous database state would inherently cause trouble. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Prints a compiled\-in help text. .TP -\fB\-K\fP | \fB\-\-linger\fP +\fB\-K\fP | \fB–linger\fP Linger around until keypress after the benchmark is done. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log\-level=\fP\fILOGLEVEL\fP +\fB\-L\fP \fILOGLEVEL\fP | \fB–log\-level=\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-m\fP \fIMODE\fP | \fB\-\-mode=\fP\fIMODE\fP +\fB\-m\fP \fIMODE\fP | \fB–mode=\fP\fIMODE\fP Mode of operation. Accepted values are: \fBexchange\fP, \fBclients\fP, \fBboth\fP\&. .TP -\fB\-n\fP \fIHOWMANY_COINS\fP | \fB\-\-coins\-number=\fP\fIHOWMANY_COINS\fP +\fB\-n\fP \fIHOWMANY_COINS\fP | \fB–coins\-number=\fP\fIHOWMANY_COINS\fP Defaults to 1. Specifies how many coins this benchmark should withdraw and spend. After being spent, each coin will be refreshed with a probability RATE (see option \fB\-\-refresh\-rate\fP). .TP -\fB\-p\fP \fINPROCS\fP | \fB\-\-parallelism=\fP\fINPROCS\fP +\fB\-p\fP \fINPROCS\fP | \fB–parallelism=\fP\fINPROCS\fP Run with \fINPROCS\fP client processes. .TP -\fB\-R\fP \fIRATE\fP | \fB\-\-refresh\-rate=\fP\fIRATE\fP +\fB\-R\fP \fIRATE\fP | \fB–refresh\-rate=\fP\fIRATE\fP Defaults to 10. Probability of refresh per coin (0\-100). .TP -\fB\-r\fP \fIN\fP | \fB\-\-reserves=\fP\fIN\fP +\fB\-r\fP \fIN\fP | \fB–reserves=\fP\fIN\fP Create \fIN\fP reserves per client. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-closer.1 b/man/taler-exchange-closer.1 index 677947f9..9eab2dd8 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-CLOSER" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-closer \- close idle reserves . @@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-closer\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\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ |\ \fB\-\-test\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ |\ \fB–test\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-closer\fP is a command\-line tool to run close @@ -47,29 +47,29 @@ reserves that have been idle for too long, causing transfers to the originating bank account to be scheduled. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP | \fB\-\-test\fP +\fB\-t\fP | \fB–test\fP Run in test mode and exit when idle. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-dbinit.1 b/man/taler-exchange-dbinit.1 index cf5b6da6..824a133c 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-dbinit \- initialize Taler exchange database . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-dbinit\fP -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-g\fP\ |\ \fB\-\-gc\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\-r\fP\ |\ \fB\-\-reset\fP] -[\fB\-s\fP\ |\ \fB\-\-shardunlock\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-g\fP\ |\ \fB–gc\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\-r\fP\ |\ \fB–reset\fP] +[\fB\-s\fP\ |\ \fB–shardunlock\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-dbinit\fP is a command\-line tool to initialize the Taler @@ -50,29 +50,29 @@ Taler exchange to operate. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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\-g\fP | \fB\-\-gc\fP +\fB\-g\fP | \fB–gc\fP Garbage collect database. Deletes all unnecessary data in the database. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-r\fP | \fB\-\-reset\fP +\fB\-r\fP | \fB–reset\fP Drop tables. Dangerous, will delete all existing data in the database before creating the tables. .TP -\fB\-s\fP | \fB\-\-shardunlock\fP +\fB\-s\fP | \fB–shardunlock\fP Clears the (revolving) shards table. Needed to clear locks that may be held after a crash (of taler\-exchange\-aggregator or the operating system, say due to power outage) or if the AGGREGATOR_SHARD_SIZE option is changed in the configuration file. .TP \fB\-v\fP | \fB–version\fP diff --git a/man/taler-exchange-expire.1 b/man/taler-exchange-expire.1 index 44460688..ced311f0 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-EXPIRE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-expire \- refund expired purses . @@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-expire\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\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ |\ \fB\-\-test\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ |\ \fB–test\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-expire\fP is a command\-line tool to run refund @@ -48,29 +48,29 @@ This allows the wallet to recover the funds deposited into the purse using a refresh operation. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP | \fB\-\-test\fP +\fB\-t\fP | \fB–test\fP Run in test mode and exit when idle. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-httpd.1 b/man/taler-exchange-httpd.1 index dafab016..90c04e71 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-httpd \- run Taler exchange (with RESTful API) . @@ -33,18 +33,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-httpd\fP -[\fB\-a\fP\ |\ \fB\-\-allow\-timetravel\fP] -[\fB\-C\fP\ |\ \fB\-\-connection\-close\fP] -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-f\fP\ \fIFILENAME\fP\ |\ \fB\-\-file\-input=\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\-n\fP\ \fIN\fP\ |\ \fB\-\-num\-threads=\fP\fIN\fP] -[\fB\-r**|\fP\-\-allow\-reuse\-address**] -[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ \fISECONDS\fP\ |\ \fB\-\-timeout=\fP\fISECONDS\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-a\fP\ |\ \fB–allow\-timetravel\fP] +[\fB\-C\fP\ |\ \fB–connection\-close\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-f\fP\ \fIFILENAME\fP\ |\ \fB–file\-input=\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\-n\fP\ \fIN\fP\ |\ \fB–num\-threads=\fP\fIN\fP] +[\fB\-r**|\fP–allow\-reuse\-address**] +[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ \fISECONDS\fP\ |\ \fB–timeout=\fP\fISECONDS\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-httpd\fP is a command\-line tool to run the Taler @@ -54,24 +54,24 @@ must exist before running this command. Its options are as follows: .INDENT 0.0 .TP -\fB\-a\fP | \fB\-\-allow\-timetravel\fP +\fB\-a\fP | \fB–allow\-timetravel\fP Allow clients to request /keys for arbitrary timestamps. This should only be enabled for testing and development, as clients could abuse this in denial of service attacks, as it makes the /keys response generation much more expensive. .TP -\fB\-C\fP | \fB\-\-connection\-close\fP +\fB\-C\fP | \fB–connection\-close\fP Force each HTTP connection to be closed after each request (useful in combination with \fB\-f\fP to avoid having to wait for netcat (nc) to time out). .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from FILENAME. .TP -\fB\-f\fP \fIFILENAME\fP | \fB\-\-file\-input=\fP\fIFILENAME\fP +\fB\-f\fP \fIFILENAME\fP | \fB–file\-input=\fP\fIFILENAME\fP This option is only available if the exchange was compiled with the -configure option \-\-enable\-developer\-mode. It is used for generating +configure option –enable\-developer\-mode. It is used for generating test cases against the exchange using AFL. When this option is present, the HTTP server will .INDENT 7.0 @@ -89,31 +89,31 @@ input from an HTTP client and then immediately exit. This is useful to test taler\-exchange\-httpd against many different possible inputs in a controlled way. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-r\fP | \fB\-\-allow\-reuse\-address\fP +\fB\-r\fP | \fB–allow\-reuse\-address\fP Allow the exchange to re\-use the listen port even if another service is already using it. Useful if multiple processes are used to increase processing capacity. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP \fISECONDS\fP | \fB\-\-timeout=\fP\fISECONDS\fP +\fB\-t\fP \fISECONDS\fP | \fB–timeout=\fP\fISECONDS\fP Specifies the number of SECONDS after which the HTTPD should close (idle) HTTP connections. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SIGNALS diff --git a/man/taler-exchange-offline.1 b/man/taler-exchange-offline.1 index 104e54ee..da91e9d8 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-OFFLINE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-offline \- operations using the offline key of a Taler exchange . @@ -33,21 +33,21 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-offline\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] -[subcommand ...] +[\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] +[subcommand …] .SH DESCRIPTION .sp \fBtaler\-exchange\-offline\fP is a command\-line tool to interact with the Taler -exchange\(aqs master private key. Most operations of this tool require access to +exchange’s master private key. Most operations of this tool require access to the exchange’s long\-term offline signing key and should be run in a secure (offline) environment under strict controls. The tool takes a list of subcommands as arguments which are then processed sequentially. .sp -The tool includes two subcommands to interact \fIonline\fP with the exchange\(aqs +The tool includes two subcommands to interact \fIonline\fP with the exchange’s REST APIs. To determine how to talk to the exchange, these two subcommands rely on the \fBBASE_URL\fP configuration option from the \fB[exchange]\fP section of the configuration file. The \fBdownload\fP subcommand downloads the future @@ -55,10 +55,10 @@ public keys from the running exchange. The resulting data serves as input to the \fBsign\fP and \fBshow\fP subcommands. The \fBupload\fP subcommand uploads the signatures created with the private master key to the exchange. It handles the output of all subcommands (except \fBdownload\fP). The \fBdownload\fP and -\fBupload\fP subcommands must naturally be run "online" and do not require +\fBupload\fP subcommands must naturally be run “online” and do not require access to the offline key. .sp -All other subcommands are intended to be run "offline". However, especially +All other subcommands are intended to be run “offline”. However, especially when testing, it is of course possible to run the subcommands online as well. Generally, subcommands read inputs (beyond command\-line arguments) from \fBstdin\fP\&. However, they may also consume outputs of previous @@ -68,21 +68,21 @@ and if not consumed the final output is printed to \fBstdout\fP\&. The general options for \fBtaler\-exchange\-offline\fP are: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH CONFIGURATION @@ -102,17 +102,17 @@ $ taler\-exchange\-offline setup .UNINDENT .sp Note that if the private key file already exists, the above will simply output -the existing key. Passing additional arguments after setup (including "\-") +the existing key. Passing additional arguments after setup (including “\-“) will cause the output to be encapsulated in JSON. .sp Relevant configuration options for \fBtaler\-exchange\-offline\fP are: .INDENT 0.0 .IP \(bu 2 -\fB[exchange/BASE_URL]\fP \-\-\- how to reach the exchange (for download/upload) +\fB[exchange/BASE_URL]\fP — how to reach the exchange (for download/upload) .IP \(bu 2 -\fB[exchange\-offline/MASTER_PRIV_FILE]\fP \-\-\- where to store the private keys +\fB[exchange\-offline/MASTER_PRIV_FILE]\fP — where to store the private keys .IP \(bu 2 -\fB[exchange\-offline/SECM_TOFU_FILE]\fP \-\-\- where to store TOFU data +\fB[exchange\-offline/SECM_TOFU_FILE]\fP — where to store TOFU data .UNINDENT .SH SUBCOMMANDS .SS setup @@ -150,6 +150,22 @@ directly. .sp It outputs the signatures over \fIall\fP denomination and signing keys present in the input, in a format suitable for the \fBupload\fP subcommand. +.SS extensions +.sp +This subcommand is responsible for the management of available extensions in +the exchange. +.sp +It consumes the output of the \fBdownload\fP subcommand, either from \fBstdin\fP or +directly. +.sp +It provides the sub\-subcommand \fBextensions show\fP to show the configuration +for extensions and the \fBextensions sign\fP command to sign the current +configuration of extensions, in a format suitable for the \fBupload\fP +subcommand. +.sp +Note that an extension on the exchange will only become activated at runtime +\fIafter\fP the extension’s configurations has been signed by the offline tool with +the signing key and the signed configuration been uploaded to the exchange. .SS revoke\-denomination .sp This subcommand signs a revocation message for a denomination key. @@ -172,23 +188,23 @@ in a format suitable for the \fBupload\fP subcommand. .sp This subcommand informs an exchange that an auditor is to be activated. Afterwards, the -exchange will accept inputs from that auditor\(aqs \fBtaler\-auditor\-offline\fP +exchange will accept inputs from that auditor’s \fBtaler\-auditor\-offline\fP tool. Note that the auditor also must add the exchange to the list of exchanges that it audits via \fBtaler\-auditor\-exchange\fP\&. Furthermore, the -exchange\(aqs database will need to be provided to the auditor. This subcommand +exchange’s database will need to be provided to the auditor. This subcommand only informs the exchange about the auditor, but does not perform those additional mandatory steps for a working auditor. .sp -The auditor\(aqs public key must be given in the usual base32\-encoding as the +The auditor’s public key must be given in the usual base32\-encoding as the first argument. .sp -The auditor\(aqs REST API base URL must be given as the second argument. The tool -performs a minimal sanity check, namely that the URL begins with "http" -(this also allows "https"), but as it runs offline does not perform any further +The auditor’s REST API base URL must be given as the second argument. The tool +performs a minimal sanity check, namely that the URL begins with “http” +(this also allows “https”), but as it runs offline does not perform any further validation! .sp The third argument must be a human\-readable name for the auditor. This may -be shown to users and should identify the auditor\(aqs business entity. If +be shown to users and should identify the auditor’s business entity. If the name includes spaces, the argument should be quoted. .sp The subcommand takes no inputs from \fBstdin\fP or other subcommands. @@ -199,10 +215,10 @@ in a format suitable for the \fBupload\fP subcommand. .sp This subcommand informs an exchange that an auditor is to be deactivated. Afterwards, the -exchange will refuse inputs from that auditor\(aqs \fBtaler\-auditor\-offline\fP +exchange will refuse inputs from that auditor’s \fBtaler\-auditor\-offline\fP tool. .sp -The auditor\(aqs public key must be given in the usual base32\-encoding as the +The auditor’s public key must be given in the usual base32\-encoding as the first argument. .sp The subcommand takes no inputs from \fBstdin\fP or other subcommands. @@ -221,7 +237,7 @@ account information advertized 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 -The \fBpayto://\fP URI (RFC 8905) of the exchange\(aqs bank account must be given +The \fBpayto://\fP URI (RFC 8905) of the exchange’s bank account must be given as the first argument to the subcommand. .sp The subcommand takes no inputs from \fBstdin\fP or other subcommands. @@ -234,7 +250,7 @@ This subcommand informs an exchange that it should stop advertising a bank account as belonging to the exchange on its \fB/wire\fP endpoint. .sp -The \fBpayto://\fP URI (RFC 8905) of the exchange\(aqs (former) bank account must be +The \fBpayto://\fP URI (RFC 8905) of the exchange’s (former) bank account must be given as the first argument to the subcommand. .sp The subcommand takes no inputs from \fBstdin\fP or other subcommands. @@ -288,11 +304,11 @@ Partner exchange base URL. .IP 2. 3 Partner exchange master public key. .IP 3. 3 -Calendar year for which the fee applies, \(aqnow\(aq for the current year. +Calendar year for which the fee applies, ‘now’ for the current year. .IP 4. 3 -Wad frequency, in minutes (for example, \(aq30\(aq). +Wad frequency, in minutes (for example, ‘30’). .IP 5. 3 -Wad fee (for example, \(aqKUDOS:0.1\(aq). +Wad fee (for example, ‘KUDOS:0.1’). .UNINDENT .UNINDENT .UNINDENT @@ -305,7 +321,7 @@ The arguments provided must include: .INDENT 3.5 .INDENT 0.0 .IP 1. 3 -Calendar year for which the fee applies, \(aqnow\(aq for the current year. +Calendar year for which the fee applies, ‘now’ for the current year. .IP 2. 3 KYC timeout. How long does the exchange keep a reserve open that is waiting for the KYC. .IP 3. 3 @@ -465,7 +481,7 @@ $ taler\-exchange\-offline revoke\-signkey $SK revoke\-denomkey $DKH > mix.json .UNINDENT .UNINDENT .sp -The outputs ("revoke.json", "mix.json") must be uploaded using the \fBupload\fP +The outputs (“revoke.json”, “mix.json”) must be uploaded using the \fBupload\fP subcommand to the exchange to actually revoke the keys. .SH SECURITY CONSIDERATIONS .sp @@ -474,8 +490,8 @@ system with \fImonotonic time\fP\&. The time does not have to precisely match th of the exchange, but it must be monotonic across tool invocations. The clock of the offline system is used in the enable/disable signatures to communicate an order of the events to the exchange. This prevents someone from replaying -an older "enable" (or "disable") message after a more recent "disable" (or -"enable") message has been provided to the exchange. Thus, there is no need +an older “enable” (or “disable”) message after a more recent “disable” (or +“enable”) message has been provided to the exchange. Thus, there is no need to keep the actual files exchanged with the offline tool secret. .sp The \fBtaler\-exchange\-offline\fP tool tries to make sure that the online signing @@ -485,7 +501,7 @@ but \fInot\fP the security modules from providing attacker\-controlled keys to t offline signing process. .sp For this, the \fBtaler\-exchange\-offline\fP signing subcommand always -automatically learns the security module\(aqs public signing key and \fItrusts it +automatically learns the security module’s public signing key and \fItrusts it on first use\fP (TOFU), but stores it to disk (see the \fBSECM_TOFU_FILE\fP option in the \fB[exchange\-offline]\fP section of the configuration). If the keys change subsequently, the tool will refuse to sign. diff --git a/man/taler-exchange-router.1 b/man/taler-exchange-router.1 index b6bed7d2..e12c4e1d 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-ROUTER" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-router \- route payments to partner exchanges . @@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-router\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\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ |\ \fB\-\-test\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ |\ \fB–test\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-router\fP is a NOT YET IMPLEMENTED command\-line @@ -49,29 +49,29 @@ wallets where the recipient has performed the KYC at a different exchange than the sender. This is currently not supported. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP | \fB\-\-test\fP +\fB\-t\fP | \fB–test\fP Run in test mode and exit when idle. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-secmod-cs.1 b/man/taler-exchange-secmod-cs.1 index 64a75638..9a0d61e5 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-CS" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-cs \- handle private CS key operations for a Taler exchange . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-secmod\-cs\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\-p\fP\ \fIN\fP\ |\ ,**\-\-parallelism=**\fIN\fP] -[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ \fITIMESTAMP\fP\ |\ \fB\-\-time=\fP\fITIMESTAMP\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-p\fP\ \fIN\fP\ |\ ,**–parallelism=**\fIN\fP] +[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ \fITIMESTAMP\fP\ |\ \fB–time=\fP\fITIMESTAMP\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-secmod\-cs\fP is a command\-line tool to @@ -51,33 +51,33 @@ FIXME: More details. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fBp\fP \fIN\fP | \fB\-\-parallelism=\fP\fIN\fP +\fBp\fP \fIN\fP | \fB–parallelism=\fP\fIN\fP Run with \fIN\fP worker threads. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP \fITIMESTAMP\fP | \fB\-\-time=\fP\fITIMESTAMP\fP +\fB\-t\fP \fITIMESTAMP\fP | \fB–time=\fP\fITIMESTAMP\fP Pretend it is \fITIMESTAMP\fP for the update. \fITIMESTAMP\fP is a human\-readable string (e.g., \fBYYYY\-MM\-DD HH:MM:SS\fP). .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-secmod-eddsa.1 b/man/taler-exchange-secmod-eddsa.1 index 641012c3..555ee99a 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-EDDSA" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-eddsa \- handle private EDDSA key operations for a Taler exchange . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-secmod\-eddsa\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\-p\fP\ \fIN\fP\ |\ ,**\-\-parallelism=**\fIN\fP] -[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ \fITIMESTAMP\fP\ |\ \fB\-\-time=\fP\fITIMESTAMP\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-p\fP\ \fIN\fP\ |\ ,**–parallelism=**\fIN\fP] +[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ \fITIMESTAMP\fP\ |\ \fB–time=\fP\fITIMESTAMP\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-secmod\-eddsa\fP is a command\-line tool to @@ -51,33 +51,33 @@ FIXME: More details. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fBp\fP \fIN\fP | \fB\-\-parallelism=\fP\fIN\fP +\fBp\fP \fIN\fP | \fB–parallelism=\fP\fIN\fP Run with \fIN\fP worker threads. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP \fITIMESTAMP\fP | \fB\-\-time=\fP\fITIMESTAMP\fP +\fB\-t\fP \fITIMESTAMP\fP | \fB–time=\fP\fITIMESTAMP\fP Pretend it is \fITIMESTAMP\fP for the update. \fITIMESTAMP\fP is a human\-readable string (e.g., \fBYYYY\-MM\-DD HH:MM:SS\fP). .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-secmod-rsa.1 b/man/taler-exchange-secmod-rsa.1 index 4f8e34ee..9ce7c1ca 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-RSA" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-rsa \- handle private RSA key operations for a Taler exchange . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-secmod\-rsa\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\-p\fP\ \fIN\fP\ |\ ,**\-\-parallelism=**\fIN\fP] -[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel=\fP\fIUSEC\fP] -[\fB\-t\fP\ \fITIMESTAMP\fP\ |\ \fB\-\-time=\fP\fITIMESTAMP\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-p\fP\ \fIN\fP\ |\ ,**–parallelism=**\fIN\fP] +[\fB\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel=\fP\fIUSEC\fP] +[\fB\-t\fP\ \fITIMESTAMP\fP\ |\ \fB–time=\fP\fITIMESTAMP\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-secmod\-rsa\fP is a command\-line tool to @@ -51,33 +51,33 @@ FIXME: More details. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fBp\fP \fIN\fP | \fB\-\-parallelism=\fP\fIN\fP +\fBp\fP \fIN\fP | \fB–parallelism=\fP\fIN\fP Run with \fIN\fP worker threads. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP \fITIMESTAMP\fP | \fB\-\-time=\fP\fITIMESTAMP\fP +\fB\-t\fP \fITIMESTAMP\fP | \fB–time=\fP\fITIMESTAMP\fP Pretend it is \fITIMESTAMP\fP for the update. \fITIMESTAMP\fP is a human\-readable string (e.g., \fBYYYY\-MM\-DD HH:MM:SS\fP). .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-transfer.1 b/man/taler-exchange-transfer.1 index 84fb5348..b023dace 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-TRANSFER" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-transfer \- execute wire transfers . @@ -33,42 +33,42 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-transfer\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\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel\fP\fIUSEC\fP] -[\fB\-t\fP\ |\ \fB\-\-test\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel\fP\fIUSEC\fP] +[\fB\-t\fP\ |\ \fB–test\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-transfer\fP is a command\-line tool to actually execute scheduled wire transfers (using the bank/wire gateway). The transfers are prepared by the \fBtaler\-exchange\-aggregator\fP and \fBtaler\-exchange\-closer\fP tools. .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP | \fB\-\-test\fP +\fB\-t\fP | \fB–test\fP Run in test mode and exit when idle. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-wire-gateway-client.1 b/man/taler-exchange-wire-gateway-client.1 index c8f3f2c6..948978ab 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-WIRE-GATEWAY-CLIENT" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-wire-gateway-client \- trigger a transfer at the bank . @@ -33,22 +33,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-wire\-gateway\-client\fP -[\fB\-a\fP\ \fIVALUE\fP\ |\ \fB\-\-amount=\fP\fIVALUE\fP] -[\fB\-b\fP\ \fIURL\fP\ |\ \fB\-\-bank=\fP\fIURL\fP] -[\fB\-C\fP\ \fIACCOUNT\fP\ |\ \fB\-\-credit=\fP\fIACCOUNT\fP] -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-D\fP\ \fIACCOUNT\fP\ |\ \fB\-\-debit=\fP\fIACCOUNT\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-i\fP\ |\ \fB\-\-credit\-history\fP] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-o\fP\ |\ \fB\-\-debit\-history\fP] -[\fB\-p\fP\ \fIPASSPHRASE\fP\ |\ \fB\-\-pass=\fP\fIPASSPHRASE\fP] -[\fB\-S\fP\ \fISTRING\fP\ |\ \fB\-\-subject=\fP\fISTRING\fP] -[\fB\-s\fP\ \fIACCOUNT\-SECTION\fP\ |\ \fB\-\-section=\fP\fIACCOUNT\-SECTION\fP] -[\fB\-u\fP\ \fIUSERNAME\fP\ |\ \fB\-\-user=\fP\fIUSERNAME\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] -[\fB\-w\fP\ \fIROW\fP\ |\ \fB\-\-since\-when=\fP\fIROW\fP] +[\fB\-a\fP\ \fIVALUE\fP\ |\ \fB–amount=\fP\fIVALUE\fP] +[\fB\-b\fP\ \fIURL\fP\ |\ \fB–bank=\fP\fIURL\fP] +[\fB\-C\fP\ \fIACCOUNT\fP\ |\ \fB–credit=\fP\fIACCOUNT\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-D\fP\ \fIACCOUNT\fP\ |\ \fB–debit=\fP\fIACCOUNT\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-i\fP\ |\ \fB–credit\-history\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-o\fP\ |\ \fB–debit\-history\fP] +[\fB\-p\fP\ \fIPASSPHRASE\fP\ |\ \fB–pass=\fP\fIPASSPHRASE\fP] +[\fB\-S\fP\ \fISTRING\fP\ |\ \fB–subject=\fP\fISTRING\fP] +[\fB\-s\fP\ \fIACCOUNT\-SECTION\fP\ |\ \fB–section=\fP\fIACCOUNT\-SECTION\fP] +[\fB\-u\fP\ \fIUSERNAME\fP\ |\ \fB–user=\fP\fIUSERNAME\fP] +[\fB\-v\fP\ |\ \fB–version\fP] +[\fB\-w\fP\ \fIROW\fP\ |\ \fB–since\-when=\fP\fIROW\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-wire\-gateway\-client\fP is a command\-line tool to trigger bank transfers or @@ -77,58 +77,58 @@ on transaction history operations. .SH OPTIONS .INDENT 0.0 .TP -\fB\-a\fP \fIVALUE\fP | \fB\-\-amount=\fP\fIVALUE\fP +\fB\-a\fP \fIVALUE\fP | \fB–amount=\fP\fIVALUE\fP Amount to transfer. Given in the Taler\-typical format of CURRENCY:VALUE.FRACTION. .TP -\fB\-b\fP \fIURL\fP | \fB\-\-bank=\fP\fIURL\fP +\fB\-b\fP \fIURL\fP | \fB–bank=\fP\fIURL\fP URL at which the bank is operation. Conflicts with \fB\-s\fP\&. .TP -\fB\-C\fP \fIACCOUNT\fP | \fB\-\-credit=\fP\fIACCOUNT\fP +\fB\-C\fP \fIACCOUNT\fP | \fB–credit=\fP\fIACCOUNT\fP When doing a wire transfer from the exchange, the money should be credited to \fIACCOUNT\fP\&. Specifies the payto:// URI of the account. Can also be used as a filter by credit account when looking at transaction histories. .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the given configuration file. .TP -\fB\-D\fP \fIACCOUNT\fP | \fB\-\-debit=\fP\fIACCOUNT\fP +\fB\-D\fP \fIACCOUNT\fP | \fB–debit=\fP\fIACCOUNT\fP When doing a wire transfer to the exchange, the \fIACCOUNT\fP is to be debited. Specifies the payto:// URI of the account. Can also be used as a filter by debit account when looking at transaction histories. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-credit\-history\fP +\fB\-i\fP | \fB–credit\-history\fP Obtain credit history of the exchange. Conflicts with \fB\-o\fP\&. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-o\fP | \fB\-\-debit\-history\fP +\fB\-o\fP | \fB–debit\-history\fP Obtain debit history of the exchange. Conflicts with \fB\-i\fP\&. .TP -\fB\-p\fP \fIPASSPHRASE\fP | \fB\-\-pass=\fP\fIPASSPHRASE\fP +\fB\-p\fP \fIPASSPHRASE\fP | \fB–pass=\fP\fIPASSPHRASE\fP Specifies the pass phrase for authentication. Conflicts with \fB\-s\fP\&. .TP -\fB\-S\fP \fISUBJECT\fP | \fB\-\-subject=\fP\fISUBJECT\fP +\fB\-S\fP \fISUBJECT\fP | \fB–subject=\fP\fISUBJECT\fP Use \fISUBJECT\fP for the wire transfer subject. Must be a reserve public key for credit operations and a wire transfer identifier for debit operations. If not specified, a random value will be generated instead. .TP -\fB\-s\fP \fIACCOUNT_SECTION\fP | \fB\-\-section=\fP\fIACCOUNT\-SECTION\fP +\fB\-s\fP \fIACCOUNT_SECTION\fP | \fB–section=\fP\fIACCOUNT\-SECTION\fP Obtain exchange account information from the \fIACCOUNT\-SECTION\fP of the configuration. The argument must be a \fB[exchange\-accountcredentials\-$NAME]\fP section name and thus start with the \fBexchange\-accountcredentials\-\fP prefix. Conflicts with \fB\-u\fP, \fB\-p\fP and \fB\-b\fP\&. Note that either \fB\-b\fP or \fB\-s\fP must be specified. .TP -\fB\-u\fP \fIUSERNAME\fP | \fB\-\-user=\fP\fIUSERNAME\fP +\fB\-u\fP \fIUSERNAME\fP | \fB–user=\fP\fIUSERNAME\fP Specifies the username for authentication. Optional and conflicts with \fB\-s\fP\&. If neither \fB\-u\fP nor \fB\-s\fP are used, we will attempt to talk to the bank without authentication. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .TP -\fB\-w\fP \fIROW\fP | \fB\-\-since\-when=\fP\fIROW\fP +\fB\-w\fP \fIROW\fP | \fB–since\-when=\fP\fIROW\fP Specifies a \fIROW\fP from which the history should be obtained. If not given, the 10 youngest transactions are returned. .UNINDENT .SH SEE ALSO diff --git a/man/taler-exchange-wirewatch.1 b/man/taler-exchange-wirewatch.1 index d812f1de..8d3d9ca0 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-WIREWATCH" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-exchange-wirewatch \- watch for incoming wire transfers . @@ -33,15 +33,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-exchange\-wirewatch\fP -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-I**_|_\fP\-\-ignore\-not\-found**] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-r\fP\ |\ \fB\-\-reset\fP] -[\fB\-T\fP\ |\ \fB\-\-test\fP] -[\fB\-t\fP\ \fIPLUGINNAME\fP\ |\ \fB\-\-type=\fP\fIPLUGINNAME\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-I**_|_\fP–ignore\-not\-found**] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-r\fP\ |\ \fB–reset\fP] +[\fB\-T\fP\ |\ \fB–test\fP] +[\fB\-t\fP\ \fIPLUGINNAME\fP\ |\ \fB–type=\fP\fIPLUGINNAME\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-exchange\-wirewatch\fP is a command\-line tool to import wire @@ -50,37 +50,37 @@ transactions into the Taler exchange database. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-I\fP | \fB\-\-ignore\-not\-found\fP +\fB\-I\fP | \fB–ignore\-not\-found\fP Do not fail if the bank says that the exchange bank account does not (yet) exist. Keep trying. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-r\fP | \fB\-\-reset\fP +\fB\-r\fP | \fB–reset\fP Ignore our own database and start with transactions from the beginning of time. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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\-t\fP | \fB\-\-test\fP +\fB\-t\fP | \fB–test\fP Run in test mode and exit when idle. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-helper-auditor-aggregation.1 b/man/taler-helper-auditor-aggregation.1 index c6245404..d6298652 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-AGGREGATION" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-aggregation \- audit Taler exchange aggregation activity . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-helper\-auditor\-aggregation\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] +[\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\-aggregation\fP is a command\-line tool to @@ -51,32 +51,32 @@ FIXME: More detail. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-internal\fP +\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 +\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 +\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 +\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 +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-helper-auditor-coins.1 b/man/taler-helper-auditor-coins.1 index 0bc27d65..57cdadcf 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-COINS" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-coins \- audit Taler coin processing . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-helper\-auditor\-coins\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] +[\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\-coins\fP is a command\-line tool to @@ -51,32 +51,32 @@ FIXME: More detail. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-internal\fP +\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 +\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 +\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 +\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 +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-helper-auditor-deposits.1 b/man/taler-helper-auditor-deposits.1 index 3fa704e8..0e0a1484 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-DEPOSITS" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-deposits \- audit Taler exchange database for deposit confirmation consistency . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-helper\-auditor\-deposits\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] +[\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\-deposits\fP is a command\-line tool to @@ -51,32 +51,32 @@ FIXME: More detail. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-internal\fP +\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 +\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 +\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 +\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 +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-helper-auditor-reserves.1 b/man/taler-helper-auditor-reserves.1 index f843680b..bfa70525 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-RESERVES" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-reserves \- audit Taler exchange reserve handling . @@ -33,14 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-helper\-auditor\-reserves\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] +[\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\-reserves\fP is a command\-line tool to @@ -51,32 +51,32 @@ FIXME: More detail. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-internal\fP +\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 +\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 +\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 +\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 +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-helper-auditor-wire.1 b/man/taler-helper-auditor-wire.1 index 8ad9fd02..675947c9 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-WIRE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-wire \- audit exchange database for consistency with the bank's wire transfers . @@ -33,50 +33,50 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-helper\-auditor\-wire\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] +[\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\-wire\fP is a command\-line tool to -audit exchange database for consistency with the bank\(aqs wire transfers. +audit exchange database for consistency with the bank’s wire transfers. .sp FIXME: More detail. .sp Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\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 +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-i\fP | \fB\-\-internal\fP +\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 +\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 +\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 +\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 +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-merchant-benchmark.1 b/man/taler-merchant-benchmark.1 index 5c1d30df..81479950 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-BENCHMARK" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-benchmark \- generate Taler-style benchmarking payments . @@ -46,10 +46,10 @@ default instance) and aggregated by the exchange. Takes the following options. .INDENT 7.0 .TP -\fB\-p\fP \fIPN\fP | \fB\-\-payments\-number=\fP\fIPN\fP +\fB\-p\fP \fIPN\fP | \fB–payments\-number=\fP\fIPN\fP Perform PN many payments, defaults to 1. .TP -\fB\-t\fP \fITN\fP | \fB\-\-tracks\-number=\fP\fITN\fP +\fB\-t\fP \fITN\fP | \fB–tracks\-number=\fP\fITN\fP Perform TN many tracking operations, defaults to 1. .UNINDENT .TP @@ -59,11 +59,11 @@ leaving payments unaggregated, or using a non\-default merchant instance. Takes the following options. .INDENT 7.0 .TP -\fB\-t\fP \fITC\fP | \fB\-\-two\-coins=\fP\fITC\fP +\fB\-t\fP \fITC\fP | \fB–two\-coins=\fP\fITC\fP Perform TC many payments that use two coins (normally, all the payments use only one coin). TC defaults to 1. .TP -\fB\-u\fP \fIUN\fP | \fB\-\-unaggregated\-number=\fP\fIUN\fP +\fB\-u\fP \fIUN\fP | \fB–unaggregated\-number=\fP\fIUN\fP Generate UN payments that will be left unaggregated. Note that subsequent invocations of the generator may pick those unaggregated payments and actually aggregated them. @@ -72,28 +72,28 @@ unaggregated payments and actually aggregated them. .SH COMMON OPTIONS .INDENT 0.0 .TP -\fB\-a\fP \fIAPIKEY\fP | \fB\-\-apikey=\fP\fIAPIKEY\fP -HTTP \(aqAuthorization\(aq header to send to the merchant. +\fB\-a\fP \fIAPIKEY\fP | \fB–apikey=\fP\fIAPIKEY\fP +HTTP ‘Authorization’ header to send to the merchant. .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from FILENAME. .TP -\fB\-e\fP \fISECTION\fP | \fB\-\-exchange\-account=\fP\fISECTION\fP +\fB\-e\fP \fISECTION\fP | \fB–exchange\-account=\fP\fISECTION\fP Mandatory. Configuration \fISECTION\fP specifying the exchange account to use. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler-merchant-dbinit.1 b/man/taler-merchant-dbinit.1 index be9a2ffd..283fc536 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-DBINIT" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-dbinit \- initialize Taler merchant database . @@ -33,12 +33,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-merchant\-dbinit\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\-r\fP\ |\ \fB\-\-reset\fP] -[\fB\-v\fP\ |\ \fB\-\-version\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\-r\fP\ |\ \fB–reset\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-merchant\-dbinit\fP is a command\-line tool to initialize the Taler @@ -48,21 +48,21 @@ Taler merchant to operate. Its options are as follows: .INDENT 0.0 .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fIFILENAME\fP\&. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-r\fP | \fB\-\-reset\fP +\fB\-r\fP | \fB–reset\fP Drop tables. Dangerous, will delete all existing data in the database before creating the tables. .TP diff --git a/man/taler-merchant-httpd.1 b/man/taler-merchant-httpd.1 index 9dc08432..92854b5c 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-HTTPD" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-httpd \- run Taler merchant backend (with RESTful API) . @@ -33,13 +33,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-merchant\-httpd\fP -[\fB\-C\fP\ |\ \fB\-\-connection\-close\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\-T\fP\ \fIUSEC\fP\ |\ \fB\-\-timetravel\fP\fIUSEC\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-C\fP\ |\ \fB–connection\-close\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\-T\fP\ \fIUSEC\fP\ |\ \fB–timetravel\fP\fIUSEC\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-merchant\-httpd\fP is a command\-line tool to run the Taler merchant @@ -48,44 +48,44 @@ before running this command. .SH OPTIONS .INDENT 0.0 .TP -\fB\-a\fP \fITOKEN\fP | \fB\-\-auth=\fP\fITOKEN\fP +\fB\-a\fP \fITOKEN\fP | \fB–auth=\fP\fITOKEN\fP Use TOKEN for initial access control to the merchant backend. The value given in TOKEN must appear in backoffice requests to the default instance -of the merchant, i.e. "Authorization: Bearer secret\-token:TOKEN" to obtain +of the merchant, i.e. “Authorization: Bearer secret\-token:TOKEN” to obtain access to the merchant backend. Note that setting a passphrase for the default instance by any means will block future access via TOKEN. This is basically a way to reset the passphrase protecting access. TOKEN -should be a "pchar" as per RFC 8959, but this is NOT checked. Note that -TOKEN will only grant access to the \(aqdefault\(aq instance, not other instances. +should be a “pchar” as per RFC 8959, but this is NOT checked. Note that +TOKEN will only grant access to the ‘default’ instance, not other instances. Instead of using the command\-line, which exposes TOKEN to users on the system, you may want to consider setting the TALER_MERCHANT_TOKEN environment variable instead. .TP -\fB\-C\fP | \fB\-\-connection\-close\fP +\fB\-C\fP | \fB–connection\-close\fP Force each HTTP connection to be closed after each request (useful in combination with \-f to avoid having to wait for nc to time out). .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from FILENAME. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-T\fP \fIUSEC\fP | \fB\-\-timetravel=\fP\fIUSEC\fP +\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 +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SIGNALS @@ -99,7 +99,7 @@ cleanly. .INDENT 0.0 .TP .B TALER_MERCHANT_TOKEN -Like the "\-a" option, resets the access token for the default +Like the “\-a” option, resets the access token for the default instance to the given value. .UNINDENT .SH SEE ALSO diff --git a/man/taler-merchant-setup-reserve.1 b/man/taler-merchant-setup-reserve.1 index 0624e567..f80b117c 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" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-SETUP-RESERVE" "1" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler-merchant-setup-reserve \- setup reserve for tipping at a Taler merchant backend . @@ -33,20 +33,20 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-merchant\-setup\-reserve\fP -[\fB\-A\fP\ \fIUSERNAME:PASSWORD\fP\ |\ \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP] -[\fB\-a\fP\ \fIVALUE\fP\ |\ \fB\-\-amount=\fP\fIVALUE\fP] -[\fB\-C\fP\ \fICERTFILE\fP\ |\ \fB\-\-cert=\fP\fICERTFILE\fP] -[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] -[\fB\-e\fP\ \fIURL\fP\ |\ \fB\-\-exchange\-url=\fP\fIURL\fP] -[\fB\-h\fP\ |\ \fB\-\-help\fP] -[\fB\-k\fP\ \fIKEYFILE\fP\ |\ \fB\-\-key=\fP\fIKEYFILE\fP] -[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] -[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] -[\fB\-m\fP\ \fIURL\fP\ |\ \fB\-\-merchant\-url=\fP\fIURL\fP] -[\fB\-p\fP\ \fIKEYFILEPASSPHRASE\fP\ |\ \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP] -[\fB\-t\fP\ \fICERTTYPE\fP\ |\ \fB\-\-type=\fP\fICERTTYPE\fP] -[\fB\-w\fP\ \fIMETHOD\fP\ |\ \fB\-\-wire\-method=\fP\fIMETHOD\fP] -[\fB\-v\fP\ |\ \fB\-\-version\fP] +[\fB\-A\fP\ \fIUSERNAME:PASSWORD\fP\ |\ \fB–auth=\fP\fIUSERNAME:PASSWORD\fP] +[\fB\-a\fP\ \fIVALUE\fP\ |\ \fB–amount=\fP\fIVALUE\fP] +[\fB\-C\fP\ \fICERTFILE\fP\ |\ \fB–cert=\fP\fICERTFILE\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB–config=\fP\fIFILENAME\fP] +[\fB\-e\fP\ \fIURL\fP\ |\ \fB–exchange\-url=\fP\fIURL\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +[\fB\-k\fP\ \fIKEYFILE\fP\ |\ \fB–key=\fP\fIKEYFILE\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP\fIFILENAME\fP] +[\fB\-m\fP\ \fIURL\fP\ |\ \fB–merchant\-url=\fP\fIURL\fP] +[\fB\-p\fP\ \fIKEYFILEPASSPHRASE\fP\ |\ \fB–pass=\fP\fIKEYFILEPASSPHRASE\fP] +[\fB\-t\fP\ \fICERTTYPE\fP\ |\ \fB–type=\fP\fICERTTYPE\fP] +[\fB\-w\fP\ \fIMETHOD\fP\ |\ \fB–wire\-method=\fP\fIMETHOD\fP] +[\fB\-v\fP\ |\ \fB–version\fP] .SH DESCRIPTION .sp \fBtaler\-merchant\-setup\-reserve\fP is a command\-line tool to setup a reserve @@ -55,68 +55,68 @@ from the exchange needed to fill the reserve. .SH OPTIONS .INDENT 0.0 .TP -\fB\-A\fP \fIUSERNAME:PASSWORD\fP | \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP +\fB\-A\fP \fIUSERNAME:PASSWORD\fP | \fB–auth=\fP\fIUSERNAME:PASSWORD\fP Use \fBUSERNAME\fP and \fBPASSWORD\fP for HTTP client authentication. -The ":" must be present as a separator. +The “:” must be present as a separator. Note that this form of authentication has nothing to do with the TLS client certificate authentication supported with the \fB\-C\fP, \fB\-k\fP and \fB\-p\fP options. The \fBPASSWORD\fP given to this option is given to the server! .TP -\fB\-a\fP \fIVALUE\fP | \fB\-\-amount=\fP\fIVALUE\fP +\fB\-a\fP \fIVALUE\fP | \fB–amount=\fP\fIVALUE\fP Mandatory. Amount to be transferred to the reserve. .TP -\fB\-C\fP \fICERTFILE\fP | \fB\-\-cert=\fP\fICERTFILE\fP +\fB\-C\fP \fICERTFILE\fP | \fB–cert=\fP\fICERTFILE\fP The specified \fBCERTFILE\fP contains a TLS client certificate to be used to authenticate the client. See also \fB\-t\fP\&. .TP -\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +\fB\-c\fP \fIFILENAME\fP | \fB–config=\fP\fIFILENAME\fP Use the configuration and other resources for the merchant to operate from \fBFILENAME\fP\&. .TP -\fB\-e\fP \fIURL\fP | \fB\-\-exchange\-url=\fP\fIURL\fP +\fB\-e\fP \fIURL\fP | \fB–exchange\-url=\fP\fIURL\fP Mandatory. Use \fBURL\fP for the exchange base URL. This is the exchange where the reserve will be created. The currency used in the amount specification must be offered by this exchange. .TP -\fB\-h\fP | \fB\-\-help\fP +\fB\-h\fP | \fB–help\fP Print short help on options. .TP -\fB\-k\fP \fIKEYFILE\fP | \fB\-\-key=\fP\fIKEYFILE\fP +\fB\-k\fP \fIKEYFILE\fP | \fB–key=\fP\fIKEYFILE\fP The specified \fBKEYFILE\fP contains a TLS client private key to be used to authenticate the client. See also \fB\-p\fP and \fB\-C\fP\&. .TP -\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +\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 +\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-m\fP \fIURL\fP | \fB\-\-merchant\-url=\fP\fIURL\fP +\fB\-m\fP \fIURL\fP | \fB–merchant\-url=\fP\fIURL\fP Mandatory. Use \fBURL\fP as the merchant base URL. Should include the path to the instance if the reserve is to be created for a non\-default instance. .TP -\fB\-p\fP \fIKEYFILEPASSPHRASE\fP | \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP +\fB\-p\fP \fIKEYFILEPASSPHRASE\fP | \fB–pass=\fP\fIKEYFILEPASSPHRASE\fP The specified \fBKEYFILEPASSPHRASE\fP is to be used to decrypt the KEYFILE. See also \fB\-k\fP\&. Not to be confused with \fB\-A\fP\&. The \fBKEYFILEPASSPHRASE\fP given here is only used locally to decrypt the KEYFILE. .TP -\fB\-t\fP \fICERTTYPE\fP | \fB\-\-type=\fP\fICERTTYPE\fP +\fB\-t\fP \fICERTTYPE\fP | \fB–type=\fP\fICERTTYPE\fP The specified CERTFILE contains a TLS client certificate of \fBCERTTYPE\fP\&. Default is \fBPEM\fP\&. See also \fB\-C\fP\&. .TP -\fB\-w\fP \fIMETHOD\fP | \fB\-\-wire\-method=\fP\fIMETHOD\fP +\fB\-w\fP \fIMETHOD\fP | \fB–wire\-method=\fP\fIMETHOD\fP Mandatory. Which wire method should be used. Needed to select the wire transfer method of the exchange. The method must be supported by the exchange. Typical values would be \fBiban\fP or \fBx\-taler\-bank\fP\&. .TP -\fB\-v\fP | \fB\-\-version\fP +\fB\-v\fP | \fB–version\fP Print version information. .UNINDENT .SH SEE ALSO diff --git a/man/taler.conf.5 b/man/taler.conf.5 index 7fa821a2..f26239ba 100644 --- a/man/taler.conf.5 +++ b/man/taler.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER.CONF" "5" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER.CONF" "5" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler.conf \- Taler configuration file . @@ -126,7 +126,7 @@ Port on which the HTTP server listens, e.g.\ 8080. .TP .B MASTER_PUBLIC_KEY Crockford Base32\-encoded master public key, public version of the -exchange\(aqs long\-time offline signing key. +exchange’s long\-time offline signing key. .TP .B MASTER_PRIV_FILE Location of the master private key on disk. Only used by tools that @@ -154,7 +154,7 @@ For how long should the taler\-exchange\-wirewatch sleep when it is idle before trying to look for more work? Default is 60 seconds. .TP .B AGGREGATOR_SHARD_SIZE -Which share of the range from [0,..2147483648] should be processed by one of the shards of the aggregator. Useful only for Taler exchanges with ultra high\-performance needs. When changing this value, you must stop all aggregators and run "taler\-exchange\-dbinit \-s" before resuming. Default is 2147483648 (no sharding). +Which share of the range from [0,..2147483648] should be processed by one of the shards of the aggregator. Useful only for Taler exchanges with ultra high\-performance needs. When changing this value, you must stop all aggregators and run “taler\-exchange\-dbinit \-s” before resuming. Default is 2147483648 (no sharding). .TP .B SIGNKEY_LEGAL_DURATION For how long are signatures with signing keys legally valid? @@ -168,12 +168,12 @@ How many requests should the HTTP server process at most before committing suici .B TERMS_DIR Directory where the terms of service of the exchange operator can be fund. The directory must contain sub\-directories for every supported language, -using the two\-character language code in lower case, e.g. "en/" or "fr/". +using the two\-character language code in lower case, e.g. “en/” or “fr/”. Each subdirectory must then contain files with the terms of service in various formats. The basename of the file of the current policy must be specified under \fBTERMS_ETAG\fP\&. The extension defines the mime type. -Supported extensions include "html", "htm", "txt", "pdf", "jpg", "jpeg", -"png" and "gif". For example, using a \fBTERMS_ETAG\fP of "0", the structure +Supported extensions include “html”, “htm”, “txt”, “pdf”, “jpg”, “jpeg”, +“png” and “gif”. For example, using a \fBTERMS_ETAG\fP of “0”, the structure could be the following: .INDENT 7.0 .IP \(bu 2 @@ -192,7 +192,7 @@ $TERMS_DIR/de/0.txt .TP .B TERMS_ETAG Basename of the file(s) in the \fBTERMS_DIR\fP with the current terms of service. -The value is also used for the "Etag" in the HTTP request to control +The value is also used for the “Etag” in the HTTP request to control caching. Whenever the terms of service change, the \fBTERMS_ETAG\fP MUST also change, and old values MUST NOT be repeated. For example, the date or version number of the terms of service SHOULD be used for the Etag. If @@ -207,18 +207,18 @@ Works the same as \fBTERMS_DIR\fP, just for the privacy policy. Works the same as \fBTERMS_ETAG\fP, just for the privacy policy. .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. +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". +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". +Only used if KYC_MODE is not “NONE”. .TP .B KYC_WALLET_BALANCE_LIMIT Maximum amount that a wallet is allowed to hold without @@ -228,30 +228,30 @@ is no limit. .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 “[exchange\-kyc\-oauth2]”. .INDENT 0.0 .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") +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" +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 -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" +URL of the endpoint where the OAuth 2.0 token can be used to download the user’s details. Requires KYC_ENABLED to be “OAUTH2”. Example: “\fI\%http://localhost:8888/api/user/me\fP” .TP .B KYC_OAUTH2_CLIENT_ID -Client ID of the exchange when it talks to the KYC OAuth2 endpoint. Requires KYC_ENABLED to be "OAUTH2". +Client ID of the exchange when it talks to the KYC OAuth2 endpoint. Requires KYC_ENABLED to be “OAUTH2”. .TP .B KYC_OAUTH2_CLIENT_SECRET -Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Requires KYC_ENABLED to be "OAUTH2". +Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Requires KYC_ENABLED to be “OAUTH2”. .TP .B KYC_OAUTH2_POST_URL -URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process. +URL to which the exchange will redirect the client’s 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]". +The following options must be in the section “[exchange\-offline]”. .INDENT 0.0 .TP .B MASTER_PRIV_FILE @@ -277,7 +277,7 @@ this option will also be ignored. .UNINDENT .SS EXCHANGE RSA CRYPTO HELPER OPTIONS .sp -The following options must be in the section "[taler\-exchange\-secmod\-rsa]". +The following options must be in the section “[taler\-exchange\-secmod\-rsa]”. .INDENT 0.0 .TP .B LOOKAHEAD_SIGN @@ -304,7 +304,7 @@ Note that the \fBtaler\-exchange\-secmod\-rsa\fP also evaluates the \fB[coin_*]\ configuration sections described below. .SS EXCHANGE CS CRYPTO HELPER OPTIONS .sp -The following options must be in the section "[taler\-exchange\-secmod\-cs]". +The following options must be in the section “[taler\-exchange\-secmod\-cs]”. .INDENT 0.0 .TP .B LOOKAHEAD_SIGN @@ -331,7 +331,7 @@ Note that the \fBtaler\-exchange\-secmod\-cs\fP also evaluates the \fB[coin_*]\f configuration sections described below. .SS EXCHANGE EDDSA CRYPTO HELPER OPTIONS .sp -The following options must be in the section "[taler\-exchange\-secmod\-eddsa]". +The following options must be in the section “[taler\-exchange\-secmod\-eddsa]”. .INDENT 0.0 .TP .B LOOKAHEAD_SIGN @@ -358,7 +358,7 @@ On which path should the security module listen for signing requests? .UNINDENT .SS EXCHANGE DATABASE OPTIONS .sp -The following options must be in the section "[exchangedb]". +The following options must be in the section “[exchangedb]”. .INDENT 0.0 .TP .B IDLE_RESERVE_EXPIRATION_TIME @@ -415,7 +415,7 @@ URL of the wire gateway. Typically of the form \fBhttps://$HOSTNAME[:$PORT]/taler\-wire\-gateway/$USERNAME/\fP where $HOSTNAME is the hostname of the system running the bank (such as the Taler Python bank or the Nexus) and \fB$USERNAME\fP is -the username of the exchange\(aqs bank account (usually matching +the username of the exchange’s bank account (usually matching the \fBUSERNAME\fP option used for authentication). Example: \fBhttps://bank.demo.taler.net/taler\-wire\-gateway/Exchange/\fP\&. .TP @@ -470,12 +470,12 @@ What fee is charged for refunds? When a coin is refunded, the deposit fee is returned. Instead, the refund fee is charged to the customer. .TP .B CIPHER -What cryptosystem should be used? Must be set to either "CS" or "RSA". +What cryptosystem should be used? Must be set to either “CS” or “RSA”. The respective crypto\-helper will then generate the keys for this denomination. .TP .B RSA_KEYSIZE -What is the RSA keysize modulos (in bits)? Only used if "CIPHER=RSA". +What is the RSA keysize modulos (in bits)? Only used if “CIPHER=RSA”. .UNINDENT .SS MERCHANT OPTIONS .sp @@ -522,7 +522,7 @@ Base URL of the exchange, e.g.\ “\fI\%https://exchange.demo.taler.net/\fP” .TP .B MASTER_KEY Crockford Base32 encoded master public key, public version of the -exchange\(aqs long\-time offline signing key. Can be omitted, in that +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 \fBMASTER_KEY\fP can be useful if we do not trust the exchange @@ -581,12 +581,12 @@ The following options must be in section “[auditordb\-postgres]” if the .INDENT 0.0 .TP .B CONFIG -How to access the database, e.g.\ "postgres:///taler" to use the -"taler" database. Testcases use “talercheck”. +How to access the database, e.g.\ “postgres:///taler” to use the +“taler” database. Testcases use “talercheck”. .UNINDENT .SS Bank Options .sp -The following options must be in section "[bank]" for the taler\-fakebank\-run(1) command. They are not used by the exchange or LibEuFin! +The following options must be in section “[bank]” for the taler\-fakebank\-run(1) command. They are not used by the exchange or LibEuFin! .INDENT 0.0 .TP .B HTTP_PORT diff --git a/texinfo/taler-auditor.texi b/texinfo/taler-auditor.texi index 570256fe..9a50ce32 100644 --- a/texinfo/taler-auditor.texi +++ b/texinfo/taler-auditor.texi @@ -21,7 +21,7 @@ @copying @quotation -GNU Taler 0.9.0, Jun 20, 2022 +GNU Taler 0.9.0, Jul 06, 2022 GNU Taler team @@ -102,7 +102,7 @@ Configuration * Using taler-config:: * Initial configuration:: * Keys:: -* Configuring the auditor's REST endpoint:: +* Configuring the auditor’s REST endpoint:: * Bank account:: * Database:: @@ -129,7 +129,7 @@ Operation Auditor implementation guide -* The auditor's database:: +* The auditor’s database:: * Invariants checked by the auditor:: * Testing the auditor:: @@ -197,7 +197,7 @@ to other parties. To perform this duty, you will need at least (read-only) access to the bank transactions of the exchange, as well as a continuously synchronized replica -of the exchange's database. The general assumption for running the auditor +of the exchange’s database. The general assumption for running the auditor is that this is done on a separate system controlled by the auditor. After all, the goal is to detect nerfarious activity of the exchange operator, which cannot be effectively done on a machine controlled by the exchange @@ -209,9 +209,9 @@ withdrawals made by consumers and income received by merchants. As a result, the auditor is expected to provide high confidentiality for the database. In general, the auditor does not have to offer high-availability: the exchange operator can continue operations without the auditor, and the auditor can -catch up with it later when the auditor's systems are restored. However, of +catch up with it later when the auditor’s systems are restored. However, of course any downtime would provide a window of opportunity for fraud and should -thus be minimized. Finally, the auditor's copy of the exchange's database can +thus be minimized. Finally, the auditor’s copy of the exchange’s database can be useful as a backup to the exchange in case the exchange experiences a loss of its own copies. Thus, business agreements between auditor and exchanges may include availability requirements as well. @@ -219,7 +219,7 @@ include availability requirements as well. Then, with the software provided, auditors can verify the cryptographic proofs collected by the exchange and detect if any improper bank transactions have been made. There are additional tasks which an auditor should perform. While this -manual only focuses on the audit of the exchange's database and wire transfers +manual only focuses on the audit of the exchange’s database and wire transfers with the existing tools, a proper auditor should also perform the following tasks: @@ -245,7 +245,7 @@ verification that the exchange properly implements the @code{/link} protocol @item verification that the exchange properly reports coins issued during the refresh protocol (by irregularly refreshing coins withdrawn by -the auditor and comparing against the exchange's database --- the +the auditor and comparing against the exchange’s database — the code required to support this is not yet implemented) @end itemize @@ -266,8 +266,8 @@ oversight function. Auditors should generally be independent third parties that verify that the exchange operates correctly. However, an exchange is likely to also run the auditing logic, as it is also used to calculate the exchange’s profits, risk -and liabilities. Furthermore, it's usually a good idea to not only rely on -third parties to verify one's own work. +and liabilities. Furthermore, it’s usually a good idea to not only rely on +third parties to verify one’s own work. The Taler software stack for an auditor consists of the following components: @@ -299,7 +299,7 @@ the auditor to detect if an exchange is underreporting deposits. In the future, the Web service should be extended to allow customers and merchants to automatically upload cryptographic proof of other violations of the specification by the exchange. However, for now it is assumed that -the respective cryptographic proofs are reported and verified manually --- +the respective cryptographic proofs are reported and verified manually — as with a well-behaved exchange this should obviously be a rare event. The main binary of this component is the @code{taler-auditor-httpd}. @@ -319,7 +319,7 @@ needs access to the wire gateway). The @code{taler-helper-auditor-wire} auditor verifies that the bank transactions performed by the exchange were done properly. This component must have access to the bank account -of the exchange, as well as to a copy of the exchange's database. +of the exchange, as well as to a copy of the exchange’s database. The @code{taler-auditor} script invokes the various helpers, each generating a JSON report. It then invokes the @code{taler-helper-auditor-render.py} @@ -512,13 +512,13 @@ Sample configuration files for the HTTP reverse proxy can be found in To install the GNU Taler Ubuntu packages, first ensure that you have the right Ubuntu distribution. At this time, the packages are built for -Ubuntu 20.04 LTS (Focal Fossa). +Ubuntu 22.04 LTS (Jammy Jellyfish). A typical @code{/etc/apt/sources.list.d/taler.list} file for this setup would look like this: @example -deb https://deb.taler.net/apt/ubuntu/ focal-fossa main +deb https://deb.taler.net/apt/ubuntu/ jammy main @end example The last line is crucial, as it adds the GNU Taler packages. @@ -527,7 +527,8 @@ Next, you must import the Taler Systems SA public package signing key into your keyring and update the package lists: @example -# wget -O - https://taler.net/taler-systems.gpg.key | apt-key add - +# wget -O /etc/apt/trusted.gpg.d/taler-systems.asc \ + https://taler.net/taler-systems.gpg.key # apt update @end example @@ -579,22 +580,22 @@ is not recommended for security. The recommended set of users includes: @itemize * @item -auditor --- runs the main auditing process and HTTP backend +auditor — runs the main auditing process and HTTP backend @item -sync --- synchronizes the ingres database with the production database +sync — synchronizes the ingres database with the production database @item -helper --- runs taler-auditor-offline download and upload commands +helper — runs taler-auditor-offline download and upload commands @item -auditor-ingres --- imports database from exchange production system +auditor-ingres — imports database from exchange production system @item -auditor-wire --- imports wire transfer data from bank production system +auditor-wire — imports wire transfer data from bank production system @item -offline --- manages the offline key, on a separate @emph{offline} machine +offline — manages the offline key, on a separate @emph{offline} machine @end itemize @end quotation @@ -614,10 +615,10 @@ distribution would typically create for you): @itemize * @item -www-data --- runs the HTTPS frontend (usually nginx or Apache) +www-data — runs the HTTPS frontend (usually nginx or Apache) @item -postgres --- runs the PostgreSQL database +postgres — runs the PostgreSQL database @end itemize @end quotation @@ -634,16 +635,16 @@ We recommend using the following databases for the auditor: @itemize * @item -exchange-ingres --- synchronized exchange database over the network +exchange-ingres — synchronized exchange database over the network @item -exchange-production --- local copy of exchange database with trusted schema +exchange-production — local copy of exchange database with trusted schema @item -auditor --- auditor production database with current state of the audit +auditor — auditor production database with current state of the audit @item -libeufin --- local state of the auditor-wire tool for the bank transfer data import +libeufin — local state of the auditor-wire tool for the bank transfer data import @end itemize @end quotation @@ -675,7 +676,7 @@ $ echo 'GRANT SELECT ON ALL TABLES IN SCHEMA public TO auditor;' | psql libeufin @chapter Configuration -The auditor's configuration works the same way as the configuration of other +The auditor’s configuration works the same way as the configuration of other Taler components. This section discusses configuration options related to the auditor. @@ -684,7 +685,7 @@ This section discusses configuration options related to the auditor. * Using taler-config:: * Initial configuration:: * Keys:: -* Configuring the auditor's REST endpoint:: +* Configuring the auditor’s REST endpoint:: * Bank account:: * Database:: @@ -833,7 +834,7 @@ $ taler-config -s auditor -o BASE_URL -V https://auditor.example.com/ The @code{helper} user that is used to download information from the exchange needs to know details about the exchange. Similarly, the @code{offline} user -needs to check signatures signed with the exchange's offline key. Hence, you +needs to check signatures signed with the exchange’s offline key. Hence, you need to obtain the @code{MASTER_PUBLIC_KEY} from the exchange operator (they need to run @code{taler-exchange-offline setup}) and the REST endpoint of the exchange and configure these: @@ -844,14 +845,14 @@ $ taler-config -s exchange -o BASE_URL -V https://exchange.example.com/ $ taler-config -s exchange -o MASTER_PUBLIC_KEY -V $SOMELONGBASE32VALUEHERE @end example -@node Keys,Configuring the auditor's REST endpoint,Initial configuration,Configuration +@node Keys,Configuring the auditor’s REST endpoint,Initial configuration,Configuration @anchor{taler-auditor-manual auditorkeys}@anchor{13}@anchor{taler-auditor-manual keys}@anchor{14} @section Keys The auditor works with one signing key to certify that it is auditing -a particular exchange's denomination keys. This key can and should -be kept @emph{offline} (and backed up adequately). As with the exchange's +a particular exchange’s denomination keys. This key can and should +be kept @emph{offline} (and backed up adequately). As with the exchange’s offline key, it is only used for a few cryptographic signatures and thus the respective code can be run on modest hardware, like a Raspberry Pi. @@ -892,9 +893,9 @@ You can set this configuration value using: $ taler-config -s auditor -o PUBLIC_KEY -V $SOMELONGBASE32VALUEHERE @end example -@node Configuring the auditor's REST endpoint,Bank account,Keys,Configuration +@node Configuring the auditor’s REST endpoint,Bank account,Keys,Configuration @anchor{taler-auditor-manual auditorserving}@anchor{15}@anchor{taler-auditor-manual configuring-the-auditor-s-rest-endpoint}@anchor{16} -@section Configuring the auditor's REST endpoint +@section Configuring the auditor’s REST endpoint The auditor can serve HTTP over both TCP and UNIX domain socket. @@ -920,7 +921,7 @@ HTTP over a UNIX domain socket for @code{unixpath} (i.e. 660 = @code{rw-rw----}). @end itemize -@node Bank account,Database,Configuring the auditor's REST endpoint,Configuration +@node Bank account,Database,Configuring the auditor’s REST endpoint,Configuration @anchor{taler-auditor-manual auditorbank-account}@anchor{17}@anchor{taler-auditor-manual bank-account}@anchor{18} @section Bank account @@ -963,14 +964,14 @@ CONFIG = postgres:///auditordemo If an exchange runs its own auditor, it may use the same database for the auditor and the exchange itself. -The @code{taler-auditor-dbinit} tool is used to initialize the auditor's +The @code{taler-auditor-dbinit} tool is used to initialize the auditor’s tables. After running this tool, the rights to CREATE or DROP tables are no longer required and should be removed. Both the @code{taler-auditor-httpd} and the @code{taler-auditor} (and its helpers) also need (read-only) access to a (recent, current, synchronized) copy of the -exchange's database. The configuration options are the same that are also -used when configuring the exchange' database: +exchange’s database. The configuration options are the same that are also +used when configuring the exchange’ database: @quotation @@ -991,7 +992,7 @@ CONFIG = postgres:///exchangedemo @anchor{taler-auditor-manual wallets}@anchor{1d} Before GNU Taler wallets will happily interact with an exchange, the -respective auditor's public key (as obtained via @code{taler-auditor-offline +respective auditor’s public key (as obtained via @code{taler-auditor-offline setup} from the @code{offline} user) must be added under the respective currency to the wallet. This is usually expected to be hard-coded into the Taler wallet. @@ -999,7 +1000,7 @@ wallet. Users can also manually add auditors for a particular currency via a Web page offering the respective pairing. -FIXME-DOLD: explain how that Web page works, once it works... +FIXME-DOLD: explain how that Web page works, once it works… @menu * Exchange:: @@ -1013,13 +1014,13 @@ FIXME-DOLD: explain how that Web page works, once it works... @section Exchange -The next step is to add the exchange's master public key and the base URL of +The next step is to add the exchange’s master public key and the base URL of the exchange to the list of exchanges audited by the auditor. This is done using the @code{taler-auditor-exchange} tool. The tool basically creates the -respective record in the auditor's database. +respective record in the auditor’s database. If this step is skipped, the auditor will malfunction at all future stages -with a foreign key violation, as it does not know the exchange's master public +with a foreign key violation, as it does not know the exchange’s master public key. @example @@ -1029,7 +1030,7 @@ $ taler-auditor-exchange -m $MASTER_PUB -u $EXCHANGE_BASE_URL An equivalent step must be performed by the exchange operator. Here, the exchange operator must use the @code{taler-exchange-offline} tool to add the -auditor's public key, base URL and (business) name to the list of approved +auditor’s public key, base URL and (business) name to the list of approved auditors of the exchange. For details, see Auditor-configuration in the exchange operator manual. @@ -1067,7 +1068,7 @@ process that is outside of the scope of this document. Note that the @code{input.json} does not contain any confidential data. However, signing the wrong keys would be fatal in that it may allow an illegitimate exchange to convince users that it is a trustworthy operator and subsequently -betray the user's trust that is anchored in the existence of a trustworthy +betray the user’s trust that is anchored in the existence of a trustworthy auditor. Given the verified JSON input, the auditor can then sign it (typically @@ -1102,21 +1103,21 @@ command-line option, send logging output to standard error by default. The next key step for the auditor is to configure replication of the -@emph{exchange}'s database in-house. This should be performed in two steps +@emph{exchange}’s database in-house. This should be performed in two steps as illustrated in the following figure: @image{taler-auditor-figures/replication,,,,png} First, the exchange should use standard PostgreSQL replication features to -enable the auditor to obtain a full copy of the exchange's database. -Second, the auditor should make a "trusted" local copy, ensuring that it +enable the auditor to obtain a full copy of the exchange’s database. +Second, the auditor should make a “trusted” local copy, ensuring that it never replicates malicious changes using @code{taler-auditor-sync}. Both of these steps are described in more detail below. We note that as a result of these steps, the auditor will have three databases: its own production primary database (as configured in -@code{auditordb-postgres}), its on production copy of the exchange's database -(@code{exchangedb-postgress}), and a third, untrusted "ingres" copy of the +@code{auditordb-postgres}), its on production copy of the exchange’s database +(@code{exchangedb-postgress}), and a third, untrusted “ingres” copy of the exchange database. The untrusted database should run as a separate PostgreSQL instance and is only accessed via @code{taler-auditor-sync} and the replication mechanism driven by the exchange operator. @@ -1132,7 +1133,7 @@ mechanism driven by the exchange operator. @subsection Ingres replication of the exchange production database -Ingres operation should be done using the @code{auditor-ingres} user --- or +Ingres operation should be done using the @code{auditor-ingres} user — or depending on the setup parts of the operation may be done by the @code{postgres} user directly. @@ -1145,10 +1146,10 @@ that asynchronous replication should suffice. The resulting auditor database should be treated as read-only on the auditor side. The @code{taler-exchange-dbinit} tool can be used to setup the schema, or -the schema can be replicated using PostgreSQL's standard mechanisms. The same +the schema can be replicated using PostgreSQL’s standard mechanisms. The same applies for schema upgrades: if logical replication is used (which does not replicate schema changes), @code{taler-exchange-dbinit} can be used to migrate -the schema(s) in both the ingres and production copies of the exchange's +the schema(s) in both the ingres and production copies of the exchange’s database as well. On the exchange side, a database user must be created that has the right @@ -1162,7 +1163,7 @@ $ echo "CREATE PUBLICATION $NAME FOR ALL TABLES;" | psql taler-exchange @end example The exchange must share the password of the publication with the auditor. A -good @code{$NAME} relates to the auditor's business unit name. A secure tunnel +good @code{$NAME} relates to the auditor’s business unit name. A secure tunnel must be setup between the exchange and the auditor, for example using SSH or Wireguard. @@ -1185,7 +1186,7 @@ PostgreSQL configuration: wal_level= logical @end example -Next, the @code{postgres} user of the auditor's system must first initialize the +Next, the @code{postgres} user of the auditor’s system must first initialize the local tables: @example @@ -1195,7 +1196,7 @@ $ taler-config -s exchangedb-postgres -o CONFIG -V "postgres:///taler-ingress" $ taler-exchange-dbinit @end example -To complete the replication, the @code{postgres} user of the auditor's +To complete the replication, the @code{postgres} user of the auditor’s system must subscribe: @example @@ -1212,7 +1213,7 @@ For details, we refer to the PostgreSQL manual. Depending on the replication method used, the exchange may perform unexpected changes to the schema or perform @code{UPDATE}, @code{DELETE} or @code{DROP} operations on the tables. Hence, the auditor cannot rely upon the -exchange's primary copy to respect schema constraints, especially as we +exchange’s primary copy to respect schema constraints, especially as we have to presume that the exchange could act maliciously. Furthermore, it is unclear to what degree PostgreSQL database replication mechanisms are robust against a malicious master database. Thus, the auditor should @@ -1227,20 +1228,20 @@ process, from its actual operational data. Using @code{taler-auditor-sync} as the @code{sync} user, the auditor should -make a second "safe" copy of the exchange's ingres database. +make a second “safe” copy of the exchange’s ingres database. @code{taler-auditor-sync} basically reads from one exchange database and inserts all records found into a second exchange database. If the source database violates invariants, the tool halts with an error. This way, records violating invariants are never even copied, and in particular schema changes and -deletions or updates are not propagated into the auditor's production +deletions or updates are not propagated into the auditor’s production database. While @code{taler-auditor-sync} could in theory be run directly against the -exchange's production system, this is likely a bad idea due to the high +exchange’s production system, this is likely a bad idea due to the high latency from the network between auditor and exchange operator. Thus, we -recommend first making an "untrusted" ingress copy of the exchange's +recommend first making an “untrusted” ingress copy of the exchange’s production database using standard PostgreSQL tooling, and then using -@code{taler-auditor-sync} to create a second "safe" copy. The "safe" copy used +@code{taler-auditor-sync} to create a second “safe” copy. The “safe” copy used by the production system should also run under a different UID. Before @code{taler-auditor-sync} can be used, the target database must be @@ -1272,11 +1273,11 @@ $ taler-auditor-sync -s src.conf -d dst.cfg -t When the exchange performs garbage collection to @code{DELETE} obsolete records, this change should be automatically replicated to the auditors untrusted -ingress database. However, as @code{taler-auditor-sync} tries to be "safe", -it will not replicate those deletions to the auditor's production database. +ingress database. However, as @code{taler-auditor-sync} tries to be “safe”, +it will not replicate those deletions to the auditor’s production database. Thus, it is necessary to (occasonally) run @code{taler-exchange-dbinit -g} on -the auditor's production database to garbage collect old data in the -auditor's production copy. We note that this does not have to be done +the auditor’s production database to garbage collect old data in the +auditor’s production copy. We note that this does not have to be done at the same time when the exchange runs its garbage collection. @node Operation,Auditor implementation guide,Deployment,Top @@ -1302,7 +1303,7 @@ at the same time when the exchange runs its garbage collection. The @code{taler-auditor-httpd} runs the required REST API for the auditor. The service must have @code{INSERT} (and @code{SELECT}) rights on the -@code{deposit_confirmations} table in the auditor's database. We expect that in +@code{deposit_confirmations} table in the auditor’s database. We expect that in future versions additional rights may be required. For now, we recommend simply running the @code{taler-auditor-httpd} under the @@ -1352,7 +1353,7 @@ anymore), this is not recommended in a production setup. @section Reading the report -The auditor's report needs to be read carefully, as it includes +The auditor’s report needs to be read carefully, as it includes several categories of failures of different severity: @@ -1418,14 +1419,14 @@ completing a @code{taler-audit} run against the old schema @item migrating the exchange schema (@code{taler-exchange-dbinit}) of the master database, possibly the ingres database and the -auditor's production copy +auditor’s production copy @item migrating the auditor database (@code{taler-auditor-dbinit}) @item -resuming database replication between the exchange's master -database and the auditor's ingres copy +resuming database replication between the exchange’s master +database and the auditor’s ingres copy @item resuming @code{taler-auditor-sync} @@ -1470,7 +1471,7 @@ For more information, see Revocations in the exchange operator manual. If all denominations of an exchange are revoked, the exchange includes logic to wire back all returned funds to the bank accounts from which they originate. If some denominations remain operational, wallets will generally -exchange old coins of revoked denominations for new coins -- while providing +exchange old coins of revoked denominations for new coins – while providing additional information to demonstrate that these coins were not forged from the compromised private key but obtained via a legitimate withdraw operation. @@ -1479,12 +1480,12 @@ the compromised private key but obtained via a legitimate withdraw operation. @section Failures -Most audit failures are handled by the auditor's regular reporting functionality, +Most audit failures are handled by the auditor’s regular reporting functionality, creating a (hopefully descriptive) PDF report detailing the problems found. However, there is one category of errors where this is not possible, which -concerns arithmetic overflows for amounts. Taler's specification limits amount -values to at most 2^52. If, during the auditor's calculations, amounts are +concerns arithmetic overflows for amounts. Taler’s specification limits amount +values to at most 2^52. If, during the auditor’s calculations, amounts are encountered that exceed this threshold, the auditor will not generate a regular report, but instead write a log statement explaining where the problem happened and exit with a status code of @emph{42}. @@ -1516,15 +1517,15 @@ The auditor implementation is split into five main processes, called @code{taler-helper-auditor-XXX}. The split was done to realize the principle of least privilege and to enable independent logic to be possibly run in parallel. Only the taler-wire-auditor must have (read-only) access to the -exchange's bank account, the other components only need access to the +exchange’s bank account, the other components only need access to the database. All auditor subsystems basically start their audit from a certain transaction index (@code{BIG SERIAL}) in the auditor database which identifies where the last audit concluded. They then check that the transactions claimed in the -exchange's database match up internally, including the cryptographic +exchange’s database match up internally, including the cryptographic signatures and also with respect to amounts adding up. The auditor also -calculates the exchange's profits and expected bank balances. Once all +calculates the exchange’s profits and expected bank balances. Once all existing transactions are processed, the auditor processes store the current checkpoint in its database and generate a JSON report. @@ -1533,22 +1534,22 @@ uses Jinja2 with a TeX template to convert the five individual JSON reports into LaTeX and then into PDF. @menu -* The auditor's database:: +* The auditor’s database:: * Invariants checked by the auditor:: * Testing the auditor:: @end menu -@node The auditor's database,Invariants checked by the auditor,,Auditor implementation guide +@node The auditor’s database,Invariants checked by the auditor,,Auditor implementation guide @anchor{taler-auditor-manual the-auditor-s-database}@anchor{34} -@section The auditor's database +@section The auditor’s database The database scheme used by the exchange looks as follows: @image{taler-auditor-figures/auditor-db,,,,png} -@node Invariants checked by the auditor,Testing the auditor,The auditor's database,Auditor implementation guide +@node Invariants checked by the auditor,Testing the auditor,The auditor’s database,Auditor implementation guide @anchor{taler-auditor-manual invariants-checked-by-the-auditor}@anchor{35} @section Invariants checked by the auditor @@ -1573,7 +1574,7 @@ pass where it might seem applicable. @subsection Invariants checked by the taler-helper-auditor-aggregation -This is from CodeBlau's analysis. A proper write-up is pending. +This is from CodeBlau’s analysis. A proper write-up is pending. CodeBlau reports the following checks: @@ -1685,7 +1686,7 @@ wire fee unavailable for given time @subsection Invariants checked by the taler-helper-auditor-coins -This is from CodeBlau's analysis. A proper write-up is pending. +This is from CodeBlau’s analysis. A proper write-up is pending. CodeBlau reports the following checks: @@ -1693,9 +1694,9 @@ CodeBlau reports the following checks: @item check that all denominations used by the exchange have been signed using -this auditor's key. All denominations encountered in the database that +this auditor’s key. All denominations encountered in the database that this auditor did not officially sign for are reported (but still included -in the audit as they obviously may impact the exchange's bank balance). +in the audit as they obviously may impact the exchange’s bank balance). Depending on the business situation, this may be normal (say if an exchange is changing auditors and newer denominations are no longer supported until their end-of-life by the current auditor). @@ -1791,7 +1792,7 @@ merchants by simply not reporting deposits to the auditor. @subsection Invariants checked by the taler-helper-auditor-reserves -This is from CodeBlau's analysis. A proper write-up is pending. +This is from CodeBlau’s analysis. A proper write-up is pending. CodeBlau reports the following checks: @@ -1853,11 +1854,11 @@ target account does not match origin account This auditor is special in that it is the only pass that is required to have -@emph{read-only} access to the exchange's bank account (privilege separation). Its -main role is to verify that the wire transfers in the exchange's database and +@emph{read-only} access to the exchange’s bank account (privilege separation). Its +main role is to verify that the wire transfers in the exchange’s database and those reported by the bank are identical. -This is from CodeBlau's analysis. A proper write-up is pending. +This is from CodeBlau’s analysis. A proper write-up is pending. CodeBlau reports the following checks: @@ -1919,7 +1920,7 @@ closing fee above total amount The main objective of the auditor is to detect inconsistencies. Thus, the @code{test-auditor.sh} script deliberately introduces various inconsistencies into -a synthetic exchange database. For this, an "normal" exchange database is +a synthetic exchange database. For this, an “normal” exchange database is first generated using the @code{taler-wallet-cli}. Then, various fields or rows of that database are manipulated, and the auditor is let loose on the modified database. Afterwards, the test verifies that the JSON contains values @@ -1932,13 +1933,13 @@ cover as many code paths as possible in both the exchange and the auditor. It should also ideally create all interesting possible variations of the exchange database fields (within the constraints of the database schema). -In general, @code{test-auditor.sh} runs the tests against an "old" database where +In general, @code{test-auditor.sh} runs the tests against an “old” database where some transactions are past the due-date (and hence the aggregator would trigger wire transfers), as well as a freshly generated exchange database where the auditor would not perform any transfers. Auditor interactions can be made before or after the aggregator, depending on what is being tested. -The current script also rudimentarily tests the auditor's resume logic, +The current script also rudimentarily tests the auditor’s resume logic, by re-starting the auditor once against a database that the auditor has already seen. diff --git a/texinfo/taler-bank.texi b/texinfo/taler-bank.texi index f49cdd4f..11f7595f 100644 --- a/texinfo/taler-bank.texi +++ b/texinfo/taler-bank.texi @@ -21,7 +21,7 @@ @copying @quotation -GNU Taler 0.9.0, Jun 20, 2022 +GNU Taler 0.9.0, Jul 06, 2022 GNU Taler team diff --git a/texinfo/taler-developer-manual.texi b/texinfo/taler-developer-manual.texi index 3c323a06..66d96eed 100644 --- a/texinfo/taler-developer-manual.texi +++ b/texinfo/taler-developer-manual.texi @@ -21,7 +21,7 @@ @copying @quotation -GNU Taler 0.9.0, Jun 20, 2022 +GNU Taler 0.9.0, Jul 06, 2022 GNU Taler team @@ -104,13 +104,13 @@ Wallet: [ ] build wallet @item -[ ] verify wallet works against 'test.taler.net' +[ ] verify wallet works against ‘test.taler.net’ @item [ ] tag repo. @item -[ ] upgrade 'demo.taler.net' to 'test.taler.net' +[ ] upgrade ‘demo.taler.net’ to ‘test.taler.net’ @item [ ] upload new wallet release to app store @@ -134,7 +134,7 @@ For exchange: @itemize - @item -[ ] check no compiler warnings at "-Wall" +[ ] check no compiler warnings at “-Wall” @item [ ] ensure Coverity static analysis passes @@ -143,10 +143,10 @@ For exchange: [ ] make check. @item -[ ] upgrade 'demo.taler.net' to 'test.taler.net' +[ ] upgrade ‘demo.taler.net’ to ‘test.taler.net’ @item -[ ] make dist, make check on result of 'make dist'. +[ ] make dist, make check on result of ‘make dist’. @item [ ] Change version number in configure.ac. @@ -179,7 +179,7 @@ For merchant (C backend): @itemize - @item -[ ] check no compiler warnings at "-Wall" +[ ] check no compiler warnings at “-Wall” @item [ ] ensure Coverity static analysis passes @@ -188,10 +188,10 @@ For merchant (C backend): [ ] make check. @item -[ ] upgrade 'demo.taler.net' to 'test.taler.net' +[ ] upgrade ‘demo.taler.net’ to ‘test.taler.net’ @item -[ ] make dist, make check on result of 'make dist'. +[ ] make dist, make check on result of ‘make dist’. @item [ ] Change version number in configure.ac. @@ -413,7 +413,7 @@ A complete list of all the existing repositories is currently found at Before you can obtain Git write access, you must sign the copyright agreement. As we collaborate closely with GNUnet, we use their -copyright agreement -- with the understanding that your contributions +copyright agreement – with the understanding that your contributions to GNU Taler are included in the assignment. You can find the agreement on the GNUnet site@footnote{https://gnunet.org/en/copyright.html}. Please sign and mail it to Christian Grothoff as he currently collects @@ -549,7 +549,7 @@ Bootstrap, configure, do @code{make install}, @code{make check}, etc. Commit the submodule change, and push it to the Taler exchange Git repo. @end itemize -A similiar procedure is required for other databases in GANA. +A similar procedure is required for other databases in GANA. See file @code{README} in the various directories for specific instructions. @node Debian and Ubuntu Repositories,Language-Specific Guidelines,Fundamentals,Top @@ -668,7 +668,7 @@ user can be switched to become active (see next section), and vice versa. Upgrading the @code{demo} environment should be done with care, and ideally be coordinated on the mailing list before. It is our goal for @code{demo} to always -run a "working version" that is compatible with various published wallets. +run a “working version” that is compatible with various published wallets. Before deploying on @code{demo}, the same version of all components @strong{must} be deployed @emph{and} tested on @code{int}. @@ -838,7 +838,7 @@ The WORKER is the config that that lives on a shell account on a localhost (tale The WORKER running buildbot-worker receives these commands by authenticating and communicating with the buildbot server using parameters that were specified when the worker was created in that shell account with the @code{buildbot-worker} command. @item -The buildbot server's master.cfg file contains FACTORY declarations which specify the commands that the WORKER will run on localhost. +The buildbot server’s master.cfg file contains FACTORY declarations which specify the commands that the WORKER will run on localhost. @item The FACTORY is tied to the WORKER in master.cfg by a BUILDER. @@ -856,7 +856,7 @@ Best Practices: @itemize - @item -When creating a new WORKER in the @code{master.cfg} file, leave a comment specifying the server and user account that this WORKER is called from. (At this time, taler.net is the only server used by this implementation, but it's still good practice.) +When creating a new WORKER in the @code{master.cfg} file, leave a comment specifying the server and user account that this WORKER is called from. (At this time, taler.net is the only server used by this implementation, but it’s still good practice.) @item Create a worker from a shell account with this command: @code{buildbot-worker create-worker <workername> localhost <username> <password>} @@ -958,7 +958,7 @@ $ buildbot-worker start worker/ @section Tipping reserve top-up -Both 'test' and 'demo' setups get their tip reserve topped up +Both ‘test’ and ‘demo’ setups get their tip reserve topped up by a Buildbot worker. The following steps get the reserve topper prepared. @@ -979,7 +979,7 @@ $ buildbot-worker start worker/ @section Producing auditor reports -Both 'test' and 'demo' setups get their auditor reports compiled +Both ‘test’ and ‘demo’ setups get their auditor reports compiled by a Buildbot worker. The following steps get the reports compiler prepared. @@ -1139,7 +1139,7 @@ For bootstrap, you will need to install GNU Recutils@footnote{https://www.gnu.org/software/recutils/}. For the exchange test cases to pass, @code{make install} must be run first. -Without it, test cases will fail because plugins can't be located. +Without it, test cases will fail because plugins can’t be located. @example $ ./bootstrap @@ -1227,21 +1227,21 @@ CI is done with Buildbot (@indicateurl{https://buildbot.net/}), and builds are triggered by the means of Git hooks. The results are published at @indicateurl{https://buildbot.taler.net/} . -In order to avoid downtimes, CI uses a "blue/green" deployment +In order to avoid downtimes, CI uses a “blue/green” deployment technique. In detail, there are two users building code on the system, -the "green" and the "blue" user; and at any given time, one is running +the “green” and the “blue” user; and at any given time, one is running Taler services and the other one is either building the code or waiting for that. There is also the possibility to trigger builds manually, but this is -only reserved to "admin" users. +only reserved to “admin” users. @node Internationalization,Android Apps,Continuous integration,Top @anchor{taler-developer-manual internationalization}@anchor{2c} @chapter Internationalization -Internationalization (a.k.a "Translation") is handled with Weblate (@indicateurl{https://weblate.org}) via our instance at @indicateurl{https://weblate.taler.net/} . +Internationalization (a.k.a “Translation”) is handled with Weblate (@indicateurl{https://weblate.org}) via our instance at @indicateurl{https://weblate.taler.net/} . At this time, this system is still very new for Taler.net and this documentation may be incorrect and is certainly incomplete. @@ -1329,7 +1329,7 @@ Under @emph{https://weblate.taler.net/create/component/vcs/}: @strong{Repository push URL} - This is generally @code{git+ssh://git@@git.taler.net/<reponame>`} Check with @code{git remote -v}. @item -@strong{Repository browser} - This is the www URL of the Git repo's file browser. Example @code{https://git.taler.net/<repositoryname>.git/tree/@{@{filename@}@}?h=@{@{branch@}@}#n@{@{line@}@}} where @code{<repositoryname>} gets replaced but @code{@{@{filename@}@}} and other items in braces are actual variables in the string. +@strong{Repository browser} - This is the www URL of the Git repo’s file browser. Example @code{https://git.taler.net/<repositoryname>.git/tree/@{@{filename@}@}?h=@{@{branch@}@}#n@{@{line@}@}} where @code{<repositoryname>} gets replaced but @code{@{@{filename@}@}} and other items in braces are actual variables in the string. @item @strong{Merge style} - @emph{Rebase}, in line with GNU Taler development procedures @@ -1354,7 +1354,7 @@ Under @emph{https://weblate.taler.net/create/component/vcs/}: 4 - Choose the @emph{Component} you wish to contribute to. -5 - Find the language you want to translate into. Click "Translate" on that line. +5 - Find the language you want to translate into. Click “Translate” on that line. 6 - Find a phrase and translate it. @@ -1365,7 +1365,7 @@ You may also wish to refer to @indicateurl{https://docs.weblate.org/} . @section Translation Standards and Practices -By default, our Weblate instance is set to accept translations in English, French, German, Italian, Russian, Spanish, and Portuguese. If you want to contribute a translation in a different language, navigate to the @emph{Component} you want to translate for, and click "Start new translation" to begin. If you require a privilege upgrade, please contact a superuser with your request. +By default, our Weblate instance is set to accept translations in English, French, German, Italian, Russian, Spanish, and Portuguese. If you want to contribute a translation in a different language, navigate to the @emph{Component} you want to translate for, and click “Start new translation” to begin. If you require a privilege upgrade, please contact a superuser with your request. When asked, set the license to GPLv3 or later. @@ -1378,7 +1378,7 @@ Set commit/push to manual only. weblate.taler.net signs GPG commits with the GPG key CD33CE35801462FA5EB0B695F2664BF474BFE502, and the corresponding public key can be found at @indicateurl{https://weblate.taler.net/keys/}. -This means that contributions made through weblate will not be signed with the individual contributor's key when they are checked into the Git repository, but with the weblate key. +This means that contributions made through weblate will not be signed with the individual contributor’s key when they are checked into the Git repository, but with the weblate key. @node Android Apps,Code Coverage,Internationalization,Top @anchor{taler-developer-manual android-apps}@anchor{35} @@ -1419,7 +1419,7 @@ Cashier Their git repositories are mirrored at Gitlab@footnote{https://gitlab.com/gnu-taler/taler-android} to utilize their CI -and F-Droid@footnote{https://f-droid.org}'s Gitlab integration +and F-Droid@footnote{https://f-droid.org}’s Gitlab integration to publish automatic nightly builds@footnote{https://f-droid.org/docs/Publishing_Nightly_Builds/} for each change on the @code{master} branch. @@ -1469,7 +1469,7 @@ git unzip @end itemize -Then you can get the app's source code using git: +Then you can get the app’s source code using git: @example # Start by cloning the Android git repository @@ -1486,12 +1486,12 @@ The last command will return something like @code{compileSdkVersion 29}. So visit the Android Rebuilds@footnote{http://android-rebuilds.beuc.net/} project and look for that version of the Android SDK there. If the SDK version is not yet available as a free rebuild, -you can try to lower the @code{compileSdkVersion} in the app's @code{merchant-terminal/build.gradle} file. +you can try to lower the @code{compileSdkVersion} in the app’s @code{merchant-terminal/build.gradle} file. Note that this might break things or require you to also lower other versions such as @code{targetSdkVersion}. In our example, the version is @code{29} which is available, -so download the "SDK Platform" package of "Android 10.0.0 (API 29)" +so download the “SDK Platform” package of “Android 10.0.0 (API 29)” and unpack it: @example @@ -1524,8 +1524,8 @@ build-tools;29.0.3 Android SDK Build-Tools 29.0.3 @end table @end quotation -you can try changing the @code{buildToolsVersion} in the app's @code{merchant-terminal/build.gradle} file -to the latest "Android SDK build tools" version supported by the Android Rebuilds project. +you can try changing the @code{buildToolsVersion} in the app’s @code{merchant-terminal/build.gradle} file +to the latest “Android SDK build tools” version supported by the Android Rebuilds project. After the build finished successfully, you will find your APK in @code{merchant-terminal/build/outputs/apk/release/}. @@ -1535,7 +1535,7 @@ you will find your APK in @code{merchant-terminal/build/outputs/apk/release/}. @section Update translations -Translations are managed with Taler's weblate instance: +Translations are managed with Taler’s weblate instance: @indicateurl{https://weblate.taler.net/projects/gnu-taler/} To update translations, enter the taler-android git repository @@ -1601,7 +1601,7 @@ $ git tag -s $APP-$VERSION Nightly builds get published automatically (see above) after pushing code to the official repo. -Actual releases get picked up by F-Droid's official repository via git tags. +Actual releases get picked up by F-Droid’s official repository via git tags. So ensure that all releases get tagged properly. Some information for F-Droid official repository debugging: @@ -1701,22 +1701,22 @@ include files (very similar to GNUnet): @itemize * @item -if installed, must start with "@code{taler_}" (exception: platform.h), +if installed, must start with “@code{taler_}” (exception: platform.h), and MUST live in src/include/ @item -if NOT installed, must NOT start with "@code{taler_}" and +if NOT installed, must NOT start with “@code{taler_}” and MUST NOT live in src/include/ and SHOULD NOT be included from outside of their own directory @item -end in "_lib" for "simple" libraries +end in “_lib” for “simple” libraries @item -end in "_plugin" for plugins +end in “_plugin” for plugins @item -end in "_service" for libraries accessing a service, i.e. the exchange +end in “_service” for libraries accessing a service, i.e. the exchange @end itemize @item @@ -1749,22 +1749,22 @@ logging @item tools use their full name in GNUNET_log_setup -(i.e. 'taler-exchange-offline') and log using plain 'GNUNET_log'. +(i.e. ‘taler-exchange-offline’) and log using plain ‘GNUNET_log’. @item -pure libraries (without associated service) use 'GNUNET_log_from' -with the component set to their library name (without lib or '.so'), -which should also be their directory name (i.e. 'util') +pure libraries (without associated service) use ‘GNUNET_log_from’ +with the component set to their library name (without lib or ‘.so’), +which should also be their directory name (i.e. ‘util’) @item -plugin libraries (without associated service) use 'GNUNET_log_from' -with the component set to their type and plugin name (without lib or '.so'), -which should also be their directory name (i.e. 'exchangedb-postgres') +plugin libraries (without associated service) use ‘GNUNET_log_from’ +with the component set to their type and plugin name (without lib or ‘.so’), +which should also be their directory name (i.e. ‘exchangedb-postgres’) @item -libraries with associated service) use 'GNUNET_log_from' +libraries with associated service) use ‘GNUNET_log_from’ with the name of the service, which should also be their -directory name (i.e. 'exchange') +directory name (i.e. ‘exchange’) @item for tools with @code{-l LOGFILE}, its absence means write logs to stderr @@ -1806,14 +1806,14 @@ structs: @itemize * @item -structs that are 'packed' and do not contain pointers and are +structs that are ‘packed’ and do not contain pointers and are thus suitable for hashing or similar operations are distinguished -by adding a "P" at the end of the name. (NEW) Note that this +by adding a “P” at the end of the name. (NEW) Note that this convention does not hold for the GNUnet-structs (yet). @item structs that are used with a purpose for signatures, additionally -get an "S" at the end of the name. +get an “S” at the end of the name. @end itemize @item @@ -1833,7 +1833,7 @@ testcases @itemize * @item -must be called "test_module-under-test_case-description.c" +must be called “test_module-under-test_case-description.c” @end itemize @item @@ -1843,7 +1843,7 @@ performance tests @itemize * @item -must be called "perf_module-under-test_case-description.c" +must be called “perf_module-under-test_case-description.c” @end itemize @end itemize @@ -1929,7 +1929,7 @@ are useful: @code{pathlib} for path manipulation (part of the standard library) @item -@code{subprocess} for "shelling out" to other programs. Prefer @code{subprocess.run} +@code{subprocess} for “shelling out” to other programs. Prefer @code{subprocess.run} over the older APIs. @end itemize @@ -2033,14 +2033,14 @@ used in the user interface and help materials. Refreshing is the internal technical terminology for the protocol to give change for partially spent coins -@strong{Use instead}: "Obtaining change" +@strong{Use instead}: “Obtaining change” @item Coin Coins are an internal construct, the user should never be aware that their balance is represented by coins if different denominations. -@strong{Use instead}: "(Digital) Cash" or "(Wallet) Balance" +@strong{Use instead}: “(Digital) Cash” or “(Wallet) Balance” @item Consumer @@ -2055,7 +2055,7 @@ of the signed contract terms for an order. @strong{Avoid}. Generally events that relate to proposal downloads should not be shown to normal users, only developers. Instead, use -"communication with mechant failed" if a proposed order can't be downloaded. +“communication with mechant failed” if a proposed order can’t be downloaded. @item Anonymous E-Cash @@ -2063,14 +2063,14 @@ Should be generally avoided, since Taler is only anonymous for the customer. Also some people are scared of anonymity (which as a term is also way too absolute, as anonymity is hardly ever perfect). -@strong{Use instead}: "Privacy-preserving", "Privacy-friendly" +@strong{Use instead}: “Privacy-preserving”, “Privacy-friendly” @item Payment Replay The process of proving to the merchant that the customer is entitled to view a digital product again, as they already paid for it. -@strong{Use instead}: In the event history, "re-activated digital content purchase" +@strong{Use instead}: In the event history, “re-activated digital content purchase” could be used. (FIXME: this is still not nice.) @item Session ID @@ -2106,16 +2106,16 @@ Regulatory entity that certifies exchanges and oversees their operation. The entity/service that gives out digital cash in exchange for some other means of payment. -In some contexts, using "Issuer" could also be appropriate. +In some contexts, using “Issuer” could also be appropriate. When showing a balance breakdown, -we can say "100 Eur (issued by exchange.euro.taler.net)". -Sometimes we may also use the more generic term "Payment Service Provider" -when the concept of an "Exchange" is still unclear to the reader. +we can say “100 Eur (issued by exchange.euro.taler.net)”. +Sometimes we may also use the more generic term “Payment Service Provider” +when the concept of an “Exchange” is still unclear to the reader. @item Refund -A refund is given by a merchant to the customer (rather the customer's wallet) -and "undoes" a previous payment operation. +A refund is given by a merchant to the customer (rather the customer’s wallet) +and “undoes” a previous payment operation. @item Payment @@ -2123,12 +2123,12 @@ The act of sending digital cash to a merchant to pay for an order. @item Purchase -Used to refer to the "result" of a payment, as in "view purchase". -Use sparsingly, as the word doesn't fit for all payments, such as donations. +Used to refer to the “result” of a payment, as in “view purchase”. +Use sparsingly, as the word doesn’t fit for all payments, such as donations. @item Contract Terms -Partially machine-readable representation of the merchant's obligation after the +Partially machine-readable representation of the merchant’s obligation after the customer makes a payment. @item Merchant @@ -2137,7 +2137,7 @@ Party that receives a payment. @item Wallet -Also "Taler Wallet". Software component that manages the user's digital cash +Also “Taler Wallet”. Software component that manages the user’s digital cash and payments. @end table @@ -2166,7 +2166,7 @@ absolute time in contrast to @ref{4f,,relative time}. the @ref{51,,exchange} combines multiple payments received by the same @ref{52,,merchant} into one larger @ref{53,,wire transfer} to -the respective merchant's @ref{54,,bank} account +the respective merchant’s @ref{54,,bank} account @anchor{taler-developer-manual term-auditor}@anchor{55} @geindex auditor @@ -2288,7 +2288,7 @@ exchange to credit his bank account in the future using an a coin is dirty if its public key may be known to an entity other than the customer, thereby creating the danger of some entity being able to -link multiple transactions of coin's owner if the coin is not refreshed +link multiple transactions of coin’s owner if the coin is not refreshed @anchor{taler-developer-manual term-drain}@anchor{76} @geindex drain @@ -2298,7 +2298,7 @@ link multiple transactions of coin's owner if the coin is not refreshed @itemx drained a @ref{61,,reserve} is being drained when a @ref{58,,wallet} is using the -reserve's private key to @ref{63,,withdraw} coins from it. This reduces +reserve’s private key to @ref{63,,withdraw} coins from it. This reduces the balance of the reserve. Once the balance reaches zero, we say that the reserve has been (fully) drained. Reserves that are not drained (which is the normal process) are @ref{5f,,closed} by the exchange. @@ -2307,7 +2307,7 @@ the reserve has been (fully) drained. Reserves that are not drained @item exchange -Taler's payment service operator. Issues electronic coins during +Taler’s payment service operator. Issues electronic coins during withdrawal and redeems them when they are deposited by merchants @anchor{taler-developer-manual term-expired}@anchor{77} @geindex expired @@ -2321,7 +2321,7 @@ Various operations come with time limits. In particular, denomination keys come with strict time limits for the various operations involving the coin issued under the denomination. The most important limit is the deposit expiration, which specifies until when wallets are allowed to -use the coin in deposit or refreshing operations. There is also a "legal" +use the coin in deposit or refreshing operations. There is also a “legal” expiration, which specifies how long the exchange keeps records beyond the deposit expiration time. This latter expiration matters for legal disputes in courts and also creates an upper limit for refreshing operations on @@ -2449,7 +2449,7 @@ a coin is owned by the entity that knows the private key of the coin @item planchet -precursor data for a @ref{65,,coin}. A planchet includes the coin's internal +precursor data for a @ref{65,,coin}. A planchet includes the coin’s internal secrets (coin private key, blinding factor), but lacks the RSA signature of the @ref{51,,exchange}. When @ref{7a,,withdrawing}, a @ref{58,,wallet} creates and persists a planchet before asking the exchange to sign it to @@ -2535,7 +2535,7 @@ contrast to @ref{4d,,absolute time}. accounting mechanism used by the exchange to track customer funds from incoming @ref{7d,,wire transfers}. A reserve is created whenever a customer wires money to the exchange using a well-formed public key -in the subject. The exchange then allows the customer's @ref{58,,wallet} +in the subject. The exchange then allows the customer’s @ref{58,,wallet} to @ref{63,,withdraw} up to the amount received in @ref{6b,,fresh} @ref{5a,,coins} from the reserve, thereby draining the reserve. If a reserve is not drained, the exchange eventually @ref{5e,,closes} it. @@ -2571,7 +2571,7 @@ denomination are subjected to recoup. @item sharing -users can share ownership of a @ref{65,,coin} by sharing access to the coin's +users can share ownership of a @ref{65,,coin} by sharing access to the coin's private key, thereby allowing all co-owners to spend the coin at any time. @anchor{taler-developer-manual term-spend}@anchor{59} @@ -2651,7 +2651,7 @@ the respective code base. @item wallet -software running on a customer's computer; withdraws, stores and +software running on a customer’s computer; withdraws, stores and spends coins @anchor{taler-developer-manual term-WebExtension}@anchor{9f} @geindex WebExtension @@ -2724,21 +2724,21 @@ developer. @strong{taler-config-generate} - tool to simplify Taler configuration generation @strong{taler-config-generate} -[@strong{-C} @emph{CURRENCY} | @strong{--currency=}@emph{CURRENCY}] -[@strong{-c} @emph{FILENAME} | @strong{--config=}@emph{FILENAME}] -[@strong{-e} | @strong{--exchange}] -[@strong{-f} @emph{AMOUNT} | @emph{--wirefee=}@emph{AMOUNT}] -[@strong{-h} | @strong{--help}] -[@strong{-J} @emph{JSON} | @strong{--wire-json-exchange=}@emph{JSON}] -[@strong{-j} @emph{JSON} | @strong{--wire-json-merchant=}@emph{JSON}] -[@strong{-L} @emph{LOGLEVEL} | @strong{--loglevel=}@emph{LOGLEVEL}] -[@strong{-m} | @strong{--merchant}] -[@strong{-t} | @strong{--trusted}] -[@strong{-v} | @strong{--version}] -[@strong{-w} @emph{WIREFORMAT} | @strong{--wire} @emph{WIREFORMAT}] -[@strong{--bank-uri}] -[@strong{--exchange-bank-account}] -[@strong{--merchant-bank-account}] +[@strong{-C} @emph{CURRENCY} | @strong{–currency=}@emph{CURRENCY}] +[@strong{-c} @emph{FILENAME} | @strong{–config=}@emph{FILENAME}] +[@strong{-e} | @strong{–exchange}] +[@strong{-f} @emph{AMOUNT} | @emph{–wirefee=}@emph{AMOUNT}] +[@strong{-h} | @strong{–help}] +[@strong{-J} @emph{JSON} | @strong{–wire-json-exchange=}@emph{JSON}] +[@strong{-j} @emph{JSON} | @strong{–wire-json-merchant=}@emph{JSON}] +[@strong{-L} @emph{LOGLEVEL} | @strong{–loglevel=}@emph{LOGLEVEL}] +[@strong{-m} | @strong{–merchant}] +[@strong{-t} | @strong{–trusted}] +[@strong{-v} | @strong{–version}] +[@strong{-w} @emph{WIREFORMAT} | @strong{–wire} @emph{WIREFORMAT}] +[@strong{–bank-uri}] +[@strong{–exchange-bank-account}] +[@strong{–merchant-bank-account}] @strong{taler-config-generate} can be used to generate configuration files for the Taler exchange or Taler merchants. @@ -2746,16 +2746,16 @@ for the Taler exchange or Taler merchants. @table @asis -@item @strong{-C} @emph{CURRENCY} | @strong{--currency=}@emph{CURRENCY} +@item @strong{-C} @emph{CURRENCY} | @strong{–currency=}@emph{CURRENCY} Which currency should we use in the configuration. -@item @strong{-c} @emph{FILENAME} | @strong{--config=}@emph{FILENAME} +@item @strong{-c} @emph{FILENAME} | @strong{–config=}@emph{FILENAME} Location where to write the generated configuration. Existing file will be updated, not overwritten. -@item @strong{-e} | @strong{--exchange} +@item @strong{-e} | @strong{–exchange} Generate configuration for a Taler exchange. @@ -2764,53 +2764,53 @@ Generate configuration for a Taler exchange. Setup wire transfer fees for the next 5 years for the exchange (for all wire methods). -@item @strong{-h} | @strong{--help} +@item @strong{-h} | @strong{–help} Shows this man page. -@item @strong{-J} @emph{JSON} | @strong{--wire-json-exchange=}@emph{JSON} +@item @strong{-J} @emph{JSON} | @strong{–wire-json-exchange=}@emph{JSON} Wire configuration to use for the exchange. -@item @strong{-j} @emph{JSON} | @strong{--wire-json-merchant=}@emph{JSON} +@item @strong{-j} @emph{JSON} | @strong{–wire-json-merchant=}@emph{JSON} Wire configuration to use for the merchant. -@item @strong{-L} @emph{LOGLEVEL} | @strong{--loglevel=}@emph{LOGLEVEL} +@item @strong{-L} @emph{LOGLEVEL} | @strong{–loglevel=}@emph{LOGLEVEL} Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. -@item @strong{-m} | @strong{--merchant} +@item @strong{-m} | @strong{–merchant} Generate configuration for a Taler merchant. -@item @strong{-t} | @strong{--trusted} +@item @strong{-t} | @strong{–trusted} Setup current exchange as trusted with current merchant. Generally only useful when configuring for testcases. -@item @strong{-v} | @strong{--version} +@item @strong{-v} | @strong{–version} Print version information. -@item @strong{-w} @emph{WIREFORMAT} | @strong{--wire} @emph{WIREFORMAT} +@item @strong{-w} @emph{WIREFORMAT} | @strong{–wire} @emph{WIREFORMAT} Specifies which wire format to use (i.e. “x-talerbank” or “iban”) -@item @strong{--bank-uri} +@item @strong{–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. -@item @strong{--exchange-bank-account} +@item @strong{–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. -@item @strong{--merchant-bank-account} +@item @strong{–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”. diff --git a/texinfo/taler-exchange.texi b/texinfo/taler-exchange.texi index 98c9e89a..8a1fb072 100644 --- a/texinfo/taler-exchange.texi +++ b/texinfo/taler-exchange.texi @@ -21,7 +21,7 @@ @copying @quotation -GNU Taler 0.9.0, Jun 20, 2022 +GNU Taler 0.9.0, Jul 06, 2022 GNU Taler team @@ -275,7 +275,7 @@ binary is the @code{taler-exchange-httpd}. @item Crypto-Helpers The @code{taler-exchange-secmod-rsa} and @code{taler-exchange-secmod-eddsa} -are two programs that are responsible for managing the exchange's +are two programs that are responsible for managing the exchange’s online signing keys. They must run on the same machine as the @code{taler-exchange-httpd} as the HTTP frontend communicates with the crypto helpers using UNIX Domain Sockets. @@ -294,7 +294,7 @@ Closer The @code{taler-exchange-closer} tool check that reserves are properly closed. If a customer wires funds to an exchange and then fails to withdraw them, the closer will (eventually) trigger a wire -transfer that sends the customer's funds back to the originating +transfer that sends the customer’s funds back to the originating wire account. @item @@ -335,7 +335,7 @@ the Python bank provides a bank that directly provides the wire adapter API. @item -For production, libeufin's Nexus component implements a wire +For production, libeufin’s Nexus component implements a wire adapter towards the traditional SEPA banking system with IBAN accounts. @end enumerate @@ -372,7 +372,7 @@ copy of the database. The exchange (and ideally also auditors) uses a long-term offline master siging key that identifies the operator and is used to authenticate critical -information, such as the exchange's bank account and the actual keys the +information, such as the exchange’s bank account and the actual keys the exchange uses online. Interactions with the offline system are performed using the @@ -431,7 +431,7 @@ expires or if they are informed about a key having been revoked. From a security point of view, the helpers are designed to @emph{only} make it -harder for an attacker who took control of the HTTP daemon's account to +harder for an attacker who took control of the HTTP daemon’s account to extract the private keys, limiting the attackers ability to creating signatures to the duration of their control of that account. @@ -451,8 +451,8 @@ The helper processes should be run under a user ID that is separate from that of the user running the main @code{taler-exchange-httpd} service. For security, it is important that helpers run under a different user ID than the main HTTP frontend, in fact ideally each helper should run under its own user ID. The -@code{taler-exchange-httpd} service's will securely communicate with the helpers -using UNIX domain sockets. To enable access to the keys, the service's user +@code{taler-exchange-httpd} service’s will securely communicate with the helpers +using UNIX domain sockets. To enable access to the keys, the service’s user must be in the group of the helper processes (and no other users should be in that group). @@ -663,13 +663,13 @@ for Ubuntu 20.04 LTS (Focal Fossa). To install the GNU Taler Ubuntu packages, first ensure that you have the right Ubuntu distribution. At this time, the packages are built for -Ubuntu 20.04 LTS (Focal Fossa). +Ubuntu 22.04 LTS (Jammy Jellyfish). A typical @code{/etc/apt/sources.list.d/taler.list} file for this setup would look like this: @example -deb https://deb.taler.net/apt/ubuntu/ focal-fossa main +deb https://deb.taler.net/apt/ubuntu/ jammy main @end example The last line is crucial, as it adds the GNU Taler packages. @@ -678,7 +678,8 @@ Next, you must import the Taler Systems SA public package signing key into your keyring and update the package lists: @example -# wget -O - https://taler.net/taler-systems.gpg.key | apt-key add - +# wget -O /etc/apt/trusted.gpg.d/taler-systems.asc \ + https://taler.net/taler-systems.gpg.key # apt update @end example @@ -887,9 +888,9 @@ denomination keys (signs electronic coins, see section Coins) security module keys (signs sign keys and denomination keys) @end itemize -Additionally, the exchange is sometimes concerned with the auditor's public +Additionally, the exchange is sometimes concerned with the auditor’s public key (to verify messages signed by auditors approved by the exchange operator) -and the merchant's public key (to verify refunds are authorized by the +and the merchant’s public key (to verify refunds are authorized by the merchant). Key options include: @@ -1006,7 +1007,7 @@ must then have the following options: @item @code{VALUE}: How much is the coin worth, the format is -CURRENCY:VALUE.FRACTION. For example, a 10 cent piece is "EUR:0.10". +CURRENCY:VALUE.FRACTION. For example, a 10 cent piece is “EUR:0.10”. @item @code{DURATION_WITHDRAW}: How long can a coin of this type be withdrawn? @@ -1125,7 +1126,7 @@ delayed. @section Terms of Service -The exchange has an endpoint "/terms" to return the terms of service +The exchange has an endpoint “/terms” to return the terms of service (in legal language) of the exchange operator. The wallet will show those terms of service to the user when the user is first withdrawing coins. Terms of service are optional for experimental deployments, @@ -1139,7 +1140,7 @@ in the @code{[exchange]} section: @itemize - @item -@code{TERMS_ETAG}: The current "Etag" to return for the terms of service. +@code{TERMS_ETAG}: The current “Etag” to return for the terms of service. This value must be changed whenever the terms of service are updated. A common value to use would be a version number. Note that if you change the @code{TERMS_ETAG}, you MUST also provide @@ -1153,7 +1154,7 @@ process. The @code{TERMS_DIR} directory structure must follow a particular layout. First, inside of @code{TERMS_DIR}, there should be sub-directories using -two-letter language codes like "en", "de", or "jp". Each of these +two-letter language codes like “en”, “de”, or “jp”. Each of these directories would then hold translations of the current terms of service into the respective language. Empty directories are permitted in case translations are not available. @@ -1175,7 +1176,7 @@ present, the exchange may show a warning on startup. @subsection Example -A sample file structure for a @code{TERMS_ETAG} of "v1" would be: +A sample file structure for a @code{TERMS_ETAG} of “v1” would be: @itemize - @@ -1202,7 +1203,7 @@ TERMS_DIR/de/v1.pdf TERMS_DIR/fr/v1.pdf @end itemize -If the user requests an HTML format with language preferences "fr" followed by "en", +If the user requests an HTML format with language preferences “fr” followed by “en”, the exchange would return @code{TERMS_DIR/en/v1.html} lacking an HTML version in French. @@ -1328,7 +1329,7 @@ The exchange must be informed about any auditor that is expected to provision it with auditor signatures. This is also done using the @code{taler-exchange-offline} tool on the offline system. First, the auditor must be configured and provide the exchange operator with its public key and -the URL of it's REST API. The exchange operator also needs a human-readable +the URL of it’s REST API. The exchange operator also needs a human-readable name that may be shown to users to identify the auditor. Given this information, the exchange operator can enable the auditor: @@ -1585,7 +1586,7 @@ helpful for diagnostics. While an exchange should use an external auditor to attest to regulators that -it is operating correctly, an exchange operator can also use the auditor's +it is operating correctly, an exchange operator can also use the auditor’s logic to perform internal checks. For this, an exchange operator can generally follow the auditor guide. However, instead of using @code{taler-auditor-sync}, an internal audit can and likely should be performed either directly against @@ -1631,14 +1632,14 @@ The database scheme used by the exchange looks as follows: This chapter describes how to run the Taler exchange benchmark. The benchmark can be used to measure the performance of the exchange by running a (possibly large) number of simulated clients against one Taler deployment with a bank, -exchange and auditor. For the bank, both a "fakebank" (@code{-f}) and a -"Pythonbank" deployment are currently supported. The +exchange and auditor. For the bank, both a “fakebank” (@code{-f}) and a +“Pythonbank” deployment are currently supported. The @code{taler-exchange-benchmark} program can launch all required services and clients, or only launch the parallel clients (@code{-m}), for example for distributed testing over a network. For each @emph{parallel} (@code{-p}) client, a number of @emph{reserves} (@code{-r}) is first established by -@strong{transferring} money from a "user" account (42) to the Exchange's account +@strong{transferring} money from a “user” account (42) to the Exchange’s account with the respective reserve public key as wire subject. Next, the client will @strong{withdraw} a @emph{number of coins} (@code{-n}) from the reserve and @strong{deposit} them. Additionally, a @emph{fraction} (@code{-R}) of the dirty coins will then be @@ -1658,7 +1659,7 @@ You can run a first simple benchmark using: @cartouche @quotation Note FIXME-TTN/CG: these instructions are incomplete and untested for the -current iteration of the code... +current iteration of the code… @end quotation @end cartouche diff --git a/texinfo/taler-merchant-api-tutorial.texi b/texinfo/taler-merchant-api-tutorial.texi index 005fbb72..c4ce9ffb 100644 --- a/texinfo/taler-merchant-api-tutorial.texi +++ b/texinfo/taler-merchant-api-tutorial.texi @@ -21,7 +21,7 @@ @copying @quotation -GNU Taler 0.9.0, Jun 20, 2022 +GNU Taler 0.9.0, Jul 06, 2022 GNU Taler team @@ -453,7 +453,7 @@ the merchant’s obligations under the contract. @cartouche @quotation Note You do not need to keep querying to notice changes -to the order's transaction status. The endpoints +to the order’s transaction status. The endpoints support long polling, simply specify a @code{timeout_ms} query parameter with how long you want to wait at most for the order status to change to @code{paid}. @@ -551,8 +551,8 @@ from the QR code). The merchant backend then updates the session ID of the existing order to the current session ID of the browser. When the payment status for the -"new" unpaid order is checked (or already in long-polling), the backend -detects that for the browser's @emph{session ID} and @emph{fulfillment URL} there is an +“new” unpaid order is checked (or already in long-polling), the backend +detects that for the browser’s @emph{session ID} and @emph{fulfillment URL} there is an existing paid contract. It then tells the browser to immediately redirect to the fulfillment URL where the already paid article is available. diff --git a/texinfo/taler-merchant.texi b/texinfo/taler-merchant.texi index 8b2af1d1..a0429339 100644 --- a/texinfo/taler-merchant.texi +++ b/texinfo/taler-merchant.texi @@ -21,7 +21,7 @@ @copying @quotation -GNU Taler 0.9.0, Jun 20, 2022 +GNU Taler 0.9.0, Jul 06, 2022 GNU Taler team @@ -354,7 +354,7 @@ the main Taler configuration (accepted currency, exchanges and auditors). To receive payments, an instance must have configured one or more bank @emph{accounts}. The backend does not have accounts for users, and instances are -also not really 'accounts'. So whenever we use the term @emph{account}, it is about +also not really ‘accounts’. So whenever we use the term @emph{account}, it is about a bank account of a merchant. @node Inventory,Orders and Contracts,Accounts,Terminology @@ -460,7 +460,7 @@ decade), contract information is deleted. The Taler backend can be used to verify that the exchange correctly wired all of the funds to the merchant. However, the backend does not have access to the -incoming wire transfers of the merchant's bank account. Thus, merchants must +incoming wire transfers of the merchant’s bank account. Thus, merchants must manually provide the backend with wire @emph{transfer} data that specifies the wire transfer subject and the amount that was received. Given this information, the backend can detect and report any irregularities that might arise. @@ -635,7 +635,7 @@ shared object libraries (@code{.so} files) visible to the various installed programs. There is no need to actually run a GNUnet peer to use the Taler merchant -backend -- all the merchant needs from GNUnet is a number of headers and +backend – all the merchant needs from GNUnet is a number of headers and libraries! @node Installing the GNU Taler exchange,Installing the GNU Taler merchant backend,Installing GNUnet,Generic instructions for installation from source @@ -663,7 +663,7 @@ which requires you to run the last step as @code{root}. You have to specify previous step. There is no need to actually run a Taler exchange to use the Taler merchant -backend -- all the merchant needs from the Taler exchange is a few headers and +backend – all the merchant needs from the Taler exchange is a few headers and libraries! @node Installing the GNU Taler merchant backend,,Installing the GNU Taler exchange,Generic instructions for installation from source @@ -788,13 +788,13 @@ for Ubuntu 20.04 LTS (Focal Fossa). To install the GNU Taler Ubuntu packages, first ensure that you have the right Ubuntu distribution. At this time, the packages are built for -Ubuntu 20.04 LTS (Focal Fossa). +Ubuntu 22.04 LTS (Jammy Jellyfish). A typical @code{/etc/apt/sources.list.d/taler.list} file for this setup would look like this: @example -deb https://deb.taler.net/apt/ubuntu/ focal-fossa main +deb https://deb.taler.net/apt/ubuntu/ jammy main @end example The last line is crucial, as it adds the GNU Taler packages. @@ -803,7 +803,8 @@ Next, you must import the Taler Systems SA public package signing key into your keyring and update the package lists: @example -# wget -O - https://taler.net/taler-systems.gpg.key | apt-key add - +# wget -O /etc/apt/trusted.gpg.d/taler-systems.asc \ + https://taler.net/taler-systems.gpg.key # apt update @end example @@ -1350,7 +1351,7 @@ you create a section with a name that starts with “MERCHANT-AUDITOR-”. In @item The @code{AUDITOR_BASE_URL} option specifies the auditor’s base URL. -For example, to use the Taler demonstrator's auditor, specify: +For example, to use the Taler demonstrator’s auditor, specify: @example $ taler-config -s MERCHANT-AUDITOR-demo \ @@ -1359,7 +1360,7 @@ $ taler-config -s MERCHANT-AUDITOR-demo \ @end example @item -The @code{AUDITOR_KEY} option specifies the auditor's public key +The @code{AUDITOR_KEY} option specifies the auditor’s public key in base32 encoding. For the Taler demonstrator, use: @example @@ -1610,7 +1611,7 @@ create a file @code{instance.json} with an InstanceConfigurationMessage In the text above, you must replace @code{$PAYTO_URI} with your actual @code{payto://}-URI. Also, be sure to replace @code{KUDOS} with the fiat currency if the setup is for an actual bank. The @code{name} field will be shown as the name of -your shop. The @code{address} field is expected to contain your shop's physical +your shop. The @code{address} field is expected to contain your shop’s physical address. The various defaults specify defaults for transaction fees your shop is willing to cover, how long offers made to the customer are valid, and how long the exchange has before it must wire the funds to your bank @@ -1667,9 +1668,9 @@ $ taler-config -s MERCHANT -o SERVE -V UNIX $ taler-config -s MERCHANT -o UNIXPATH -V /some/path/here.sock @end example -Do not use a UNIX domain socket path in "/tmp": systemd (or other init -systems) may give Web servers a private "/tmp" thereby hiding UNIX domain -sockets created by other users/processes in "/tmp". +Do not use a UNIX domain socket path in “/tmp”: systemd (or other init +systems) may give Web servers a private “/tmp” thereby hiding UNIX domain +sockets created by other users/processes in “/tmp”. If UNIX domain sockets are for some reason not possible, you @emph{may} use a host-based firewall to block access to the TCP port of the merchant backend, @@ -1996,7 +1997,7 @@ process to hold open file handles for all of these files. You may want to increase the @code{ulimit} of the @code{taler-merchant-httpd} process if you have templates for many languages. -The backend determines the MIME type based on the file's extension. The list +The backend determines the MIME type based on the file’s extension. The list of supported extensions is hard-coded and includes common text and image formats. @@ -2096,7 +2097,7 @@ You now need to make a wire transfer to the exchange’s bank account using the given wire transfer subject. Make your wire transfer and (optionally) check at -“@indicateurl{https://exchange/reserves/QPE24X}...” whether your transfer has arrived at the +“@indicateurl{https://exchange/reserves/QPE24X}…” whether your transfer has arrived at the exchange. Once the funds have arrived, you can start to use the reserve for @@ -2366,13 +2367,13 @@ start. The @code{taler-merchant-benchmark} tool will automatically launch and configure the exchange, (Python) bank and other tools required for the benchmark. However, the configuration file must be provided and have consistent options set. The -options that require special care include the exchange's public key (which +options that require special care include the exchange’s public key (which must match the private key in the file specified by the configuration), the currency (which must be consistent across the file), the denomination structure (which must enable payments in the range of 100ths of the unit currency (often called cents)). Furthermore, the benchmark will set the -Exchange bank account password to be "x", so the configuration must also -specify "x" for the passphrase. Finally, the bank must be configured to allow +Exchange bank account password to be “x”, so the configuration must also +specify “x” for the passphrase. Finally, the bank must be configured to allow for substantial debt least the transactions by the benchmark run out of digital cash. @@ -2504,10 +2505,10 @@ rsa_keysize = 1024 @end example -Note that the public key must match the exchange's +Note that the public key must match the exchange’s private key and that the PostgreSQL database must exist before launching the benchmark. You also -will need to ensure that the Exchange's +will need to ensure that the Exchange’s details are set up. For details, see the Exchange Operator Manual. @@ -2576,7 +2577,7 @@ options: @item @code{--tracks-number=TN} Instructs the tool to perform @emph{TN} tracking operations. Note that the @strong{total} amount of operations will be two -times @emph{TN}, since "one" tracking operation accounts for +times @emph{TN}, since “one” tracking operation accounts for @code{/track/transaction} and @code{/track/transfer}. This command should only be used to see if the operation ends without problems, as no actual measurement of performance is provided (despite of the |