diff options
Diffstat (limited to 'manpages')
| -rw-r--r-- | manpages/taler-auditor-dbinit.1.rst | 20 | ||||
| -rw-r--r-- | manpages/taler-auditor-exchange.1.rst | 24 | ||||
| -rw-r--r-- | manpages/taler-auditor-offline.1.rst | 7 | ||||
| -rw-r--r-- | manpages/taler-auditor.1.rst | 2 | ||||
| -rw-r--r-- | manpages/taler-bank-transfer.1.rst | 2 | ||||
| -rw-r--r-- | manpages/taler-config.1.rst | 4 | ||||
| -rw-r--r-- | manpages/taler-exchange-aggregator.1.rst | 18 | ||||
| -rw-r--r-- | manpages/taler-exchange-benchmark.1.rst | 50 | ||||
| -rw-r--r-- | manpages/taler-exchange-closer.1.rst | 18 | ||||
| -rw-r--r-- | manpages/taler-exchange-dbinit.1.rst | 20 | ||||
| -rw-r--r-- | manpages/taler-exchange-httpd.1.rst | 35 | ||||
| -rw-r--r-- | manpages/taler-exchange-offline.1.rst | 7 | ||||
| -rw-r--r-- | manpages/taler-exchange-transfer.1.rst | 18 | ||||
| -rw-r--r-- | manpages/taler-exchange-wirewatch.1.rst | 31 | ||||
| -rw-r--r-- | manpages/taler-merchant-benchmark.1.rst | 2 | ||||
| -rw-r--r-- | manpages/taler-merchant-httpd.1.rst | 38 | ||||
| -rw-r--r-- | manpages/taler-merchant-setup-reserve.1.rst | 96 | ||||
| -rw-r--r-- | manpages/taler-wallet-cli.1.rst | 2 |
18 files changed, 285 insertions, 109 deletions
diff --git a/manpages/taler-auditor-dbinit.1.rst b/manpages/taler-auditor-dbinit.1.rst index 34159dcb..44d7aeb0 100644 --- a/manpages/taler-auditor-dbinit.1.rst +++ b/manpages/taler-auditor-dbinit.1.rst @@ -13,8 +13,11 @@ Synopsis ======== **taler-auditor-dbinit** -[**-h** | **––help**] +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-g** | **––gc**] +[**-h** | **––help**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] [**-R** | **––reset**] [**-r** | **––restart**] [**-v** | **––version**] @@ -22,7 +25,7 @@ Synopsis Description =========== -**taler-exchange-dbinit** is a command line tool to initialize the Taler +**taler-exchange-dbinit** is a command-line tool to initialize the Taler exchange database. It creates the necessary tables and indices for the Taler exchange to operate. @@ -32,13 +35,20 @@ Its options are as follows: Use the configuration and other resources for the exchange to operate from *FILENAME*. -**-h** \| **––help** - Print short help on options. - **-g** \| **––gc** Garbage collect database. Deletes all unnecessary data in the database. +**-h** \| **––help** + Print short help on options. + +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + **-R** \| **––reset** Drop tables. Dangerous, will delete all existing data in the database. diff --git a/manpages/taler-auditor-exchange.1.rst b/manpages/taler-auditor-exchange.1.rst index 51549ec9..6a13c802 100644 --- a/manpages/taler-auditor-exchange.1.rst +++ b/manpages/taler-auditor-exchange.1.rst @@ -12,37 +12,45 @@ Synopsis ======== **taler-auditor-exchange** +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] -[**-r** | **––remove**] [**-m** *MASTERKEY* | **––exchange-key=**\ \ *MASTERKEY*] +[**-r** | **––remove**] [**-u** *EXCHANGE_URL* | **––auditor-url=**\ \ *EXCHANGE_URL*] +[**-v** | **––version**] Description =========== -**taler-auditor-exchange** is a command line tool to be used by an +**taler-auditor-exchange** is a command-line tool to be used by an auditor to add or remove an exchange from the list of exchange’s audited by the auditor. You must add an exchange to that list before signing denomination keys with taler-auditor-sign or trying to audit it with taler-auditor or taler-wire-auditor. Afterwards the exchange will be visible via the /exchanges API of the taler-auditor-httpd. -**-m** *MASTERKEY* \| **––exchange-key=**\ \ *MASTERKEY* - Public key of the exchange in Crockford base32 encoding, for example - as generated by gnunet-ecc -p. +**-c** *FILENAME* \| **––config=**\ \ *FILENAME* + Use the configuration and other resources for the exchange to operate + from *FILENAME*. **-h** \| **––help** Print short help on options. -**-u** *EXCHANGE_URL* \| **––auditor-url=**\ \ *EXCHANGE_URL* - URL of the exchange. The exchange’s HTTP API must be available at - this address. +**-m** *MASTERKEY* \| **––exchange-key=**\ \ *MASTERKEY* + Public key of the exchange in Crockford base32 encoding, for example + as generated by gnunet-ecc -p. **-r** \| **––remove** 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! +**-u** *EXCHANGE_URL* \| **––auditor-url=**\ \ *EXCHANGE_URL* + URL of the exchange. The exchange’s HTTP API must be available at + this address. + +**-v** \| **––version** + Print version information. Diagnostics =========== diff --git a/manpages/taler-auditor-offline.1.rst b/manpages/taler-auditor-offline.1.rst index 75f4f731..7c10f35a 100644 --- a/manpages/taler-auditor-offline.1.rst +++ b/manpages/taler-auditor-offline.1.rst @@ -15,7 +15,7 @@ Synopsis [**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] [**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] -[**-o** *FILE* | **––output=**\ \ *FILE*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] [**-v** | **––version**] [subcommand ...] @@ -61,9 +61,8 @@ The general options for **taler-auditor-offline** are: Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, ``WARNING``, ``ERROR``. -**-o** *FILE* \| **––output=**\ \ *FILE* - Where to write a denomination key signing request file to be given to - the auditor. +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. **-v** \| **––version** Print version information. diff --git a/manpages/taler-auditor.1.rst b/manpages/taler-auditor.1.rst index 576a304e..c4b82376 100644 --- a/manpages/taler-auditor.1.rst +++ b/manpages/taler-auditor.1.rst @@ -20,7 +20,7 @@ Synopsis Description =========== -**taler-auditor** is a command line tool to be used by an auditor to +**taler-auditor** is a command-line tool to be used by an auditor to audit an exchange’s database and calculate the current financial state of the exchange (including revenue, amount expected in escrow and risk exposure). The audit is incremental. The first audit must be performed diff --git a/manpages/taler-bank-transfer.1.rst b/manpages/taler-bank-transfer.1.rst index a734abba..e37d596a 100644 --- a/manpages/taler-bank-transfer.1.rst +++ b/manpages/taler-bank-transfer.1.rst @@ -30,7 +30,7 @@ Synopsis Description =========== -**taler-bank-transfer** is a command line tool to trigger bank transfers or +**taler-bank-transfer** is a command-line tool to trigger bank transfers or inspect wire transfers for exchange accounts using the wire API. The tool is expected to be used during testing or for diagnostics. diff --git a/manpages/taler-config.1.rst b/manpages/taler-config.1.rst index de4a589d..b5eedd79 100644 --- a/manpages/taler-config.1.rst +++ b/manpages/taler-config.1.rst @@ -17,6 +17,7 @@ Synopsis [**-f** | **––filename**] [**-h** | **––help**] [**-L** *loglevel* | **––loglevel=**\ \ *loglevel*] +[**-l** *filename* | **––logfile=**\ \ *filename*] [**-o** *option* | **––option=**\ \ *option*] [**-S** | **––list-sections**] [**-s** *section* | **––section=**\ \ *section*] @@ -52,6 +53,9 @@ Description Use *LOGLEVEL* for logging. Valid values are ``DEBUG``, ``INFO``, ``WARNING``, and ``ERROR``. +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + **-o** *OPTION* \| **––option=**\ \ *OPTION* 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 diff --git a/manpages/taler-exchange-aggregator.1.rst b/manpages/taler-exchange-aggregator.1.rst index b547cbab..710a833b 100644 --- a/manpages/taler-exchange-aggregator.1.rst +++ b/manpages/taler-exchange-aggregator.1.rst @@ -12,14 +12,18 @@ Synopsis ======== **taler-exchange-aggregator** +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-T** *USEC* | **––timetravel**\ \ *USEC*] [**-t** | **––test**] [**-v** | **––version**] Description =========== -**taler-exchange-aggregator** is a command line tool to run aggregate deposits +**taler-exchange-aggregator** is a command-line tool to run aggregate deposits to the same merchant into larger wire transfers. The actual transfers are then done by **taler-exchange-transfer**. @@ -30,6 +34,18 @@ done by **taler-exchange-transfer**. **-h** \| **––help** Print short help on options. +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + +**-T** *USEC* \| **––timetravel=**\ \ *USEC* + Modify the system time by *USEC* microseconds. + *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``). + This option is intended for debugging/testing only. + **-t** \| **––test** Run in test mode and exit when idle. diff --git a/manpages/taler-exchange-benchmark.1.rst b/manpages/taler-exchange-benchmark.1.rst index 1694c353..81b8e614 100644 --- a/manpages/taler-exchange-benchmark.1.rst +++ b/manpages/taler-exchange-benchmark.1.rst @@ -15,17 +15,23 @@ Synopsis **taler-exchange-benchmark** [**-c** *CONFIG_FILENAME* | **––config=**\ \ *CONFIG_FILENAME*] -[**-b** *BANK_URL* | **––bank-url=**\ \ *BANK_URL*] +[**-F** | **––reserves-first**] [**-f** | **––fakebank**] +[**-h** | **––help**] [**-K** | **––linger**] +[**-L** *LOGLEVEL* | **––log-level=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-m** *MODE* | **––mode=**\ \ *MODE*] [**-n** *HOWMANY_COINS* | **––coins-number=**\ \ *HOWMANY_COINS*] -[**-l** *LOGLEVEL* | **––log-level=**\ \ *LOGLEVEL*] -[**-h** | **––help**] +[**-p** *NPROCS* | **––parallelism=**\ \ *NPROCS*] +[**-R** *RATE* | **––refresh-rate=**\ \ *RATE*] +[**-r** *N* | **––reserves=**\ \ *N*] +[**-v** | **––version**] Description =========== -**taler-exchange-benchmark** is a command line tool to measure the time +**taler-exchange-benchmark** is a command-line tool to measure the time spent to serve withdrawals/deposits/refreshes. It usually needs a dedicate configuration file where all the services - the exchange and the (fake)bank - listen to URLs not subject to any reverse proxy, as say @@ -35,9 +41,8 @@ that table are always erased during a single benchmark run. **-c** *CONFIG_FILENAME* \| **––config=**\ \ *CONFIG_FILENAME* (Mandatory) Use CONFIG_FILENAME. -**-b** *BANK_URL* \| **––bank-url=**\ \ *BANK_URL* - (Mandatory) The URL where the fakebank listens at. Must match the - host component in the exchange’s escrow account “payto” URL. +**-F** \| **––reserves-first** + Create all reserves first, before starting normal operations. **-f** \| **––fakebank** Launch a fakebank instead of the Python bank. Only meaningful if the @@ -46,21 +51,38 @@ that table are always erased during a single benchmark run. as the fakebank is stateless and thus previous database state would inherently cause trouble. +**-h** \| **––help** + Prints a compiled-in help text. + **-K** \| **––linger** Linger around until keypress after the benchmark is done. +**-L** *LOGLEVEL* \| **––log-level=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + +**-m** *MODE* \| **––mode=**\ \ *MODE* + Mode of operation. Accepted values are: ``exchange``, ``clients``, ``both``. + **-n** *HOWMANY_COINS* \| **––coins-number=**\ \ *HOWMANY_COINS* Defaults to 1. Specifies how many coins this benchmark should withdraw and spend. After being spent, each coin will be refreshed - with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1; - future versions of this tool should offer this parameter as a CLI - option. + with a probability RATE (see option ``--refresh-rate``). -**-l** *LOGLEVEL* \| **––log-level=**\ \ *LOGLEVEL* - GNUnet-compatible log level, takes values “ERROR/WARNING/INFO/DEBUG” +**-p** *NPROCS* \| **––parallelism=**\ \ *NPROCS* + Run with *NPROCS* client processes. -**-h** \| **––help** - Prints a compiled-in help text. +**-R** *RATE* \| **––refresh-rate=**\ \ *RATE* + Defaults to 10. Probability of refresh per coin (0-100). + +**-r** *N* \| **––reserves=**\ \ *N* + Create *N* reserves per client. + +**-v** \| **––version** + Print version information. See Also ======== diff --git a/manpages/taler-exchange-closer.1.rst b/manpages/taler-exchange-closer.1.rst index 22f5aec3..82fc41d1 100644 --- a/manpages/taler-exchange-closer.1.rst +++ b/manpages/taler-exchange-closer.1.rst @@ -12,14 +12,18 @@ Synopsis ======== **taler-exchange-closer** +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-T** *USEC* | **––timetravel=**\ \ *USEC*] [**-t** | **––test**] [**-v** | **––version**] Description =========== -**taler-exchange-closer** is a command line tool to run close +**taler-exchange-closer** is a command-line tool to run close reserves that have been idle for too long, causing transfers to the originating bank account to be scheduled. @@ -31,6 +35,18 @@ to the originating bank account to be scheduled. **-h** \| **––help** Print short help on options. +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + +**-T** *USEC* \| **––timetravel=**\ \ *USEC* + Modify the system time by *USEC* microseconds. + *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``). + This option is intended for debugging/testing only. + **-t** \| **––test** Run in test mode and exit when idle. diff --git a/manpages/taler-exchange-dbinit.1.rst b/manpages/taler-exchange-dbinit.1.rst index dfbbfe4f..8221b8e8 100644 --- a/manpages/taler-exchange-dbinit.1.rst +++ b/manpages/taler-exchange-dbinit.1.rst @@ -13,15 +13,18 @@ Synopsis ======== **taler-exchange-dbinit** -[**-h** | **––help**] +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-g** | **––gc**] +[**-h** | **––help**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] [**-r** | **––reset**] [**-v** | **––version**] Description =========== -**taler-exchange-dbinit** is a command line tool to initialize the Taler +**taler-exchange-dbinit** is a command-line tool to initialize the Taler exchange database. It creates the necessary tables and indices for the Taler exchange to operate. @@ -31,13 +34,20 @@ Its options are as follows: Use the configuration and other resources for the exchange to operate from *FILENAME*. -**-h** \| **––help** - Print short help on options. - **-g** \| **––gc** Garbage collect database. Deletes all unnecessary data in the database. +**-h** \| **––help** + Print short help on options. + +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + **-r** \| **––reset** Drop tables. Dangerous, will delete all existing data in the database before creating the tables. diff --git a/manpages/taler-exchange-httpd.1.rst b/manpages/taler-exchange-httpd.1.rst index fdbe6d0e..d8462a6c 100644 --- a/manpages/taler-exchange-httpd.1.rst +++ b/manpages/taler-exchange-httpd.1.rst @@ -12,18 +12,22 @@ Synopsis ======== **taler-exchange-httpd** +[**-a** | **––allow-timetravel**] [**-C** | **––connection-close**] [**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-f** *FILENAME* | **––file-input=**\ \ *FILENAME*] [**-h** | **––help**] [**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-n** *N* | **––num-threads=**\ \ *N*] +[**-T** *USEC* | **––timetravel=**\ \ *USEC*] [**-t** *SECONDS* | **––timeout=**\ \ *SECONDS*] [**-v** | **––version**] Description =========== -**taler-exchange-httpd** is a command line tool to run the Taler +**taler-exchange-httpd** is a command-line tool to run the Taler exchange (HTTP server). The required configuration, keys and database must exist before running this command. @@ -43,12 +47,6 @@ Its options are as follows: Use the configuration and other resources for the merchant to operate from FILENAME. -**-h** \| **––help** - Print short help on options. - -**-v** \| **––version** - Print version information. - **-f** *FILENAME* \| **––file-input=**\ \ *FILENAME* This option is only available if the exchange was compiled with the configure option ––enable-developer-mode. It is used for generating @@ -66,13 +64,30 @@ Its options are as follows: to test taler-exchange-httpd against many different possible inputs in a controlled way. +**-h** \| **––help** + Print short help on options. + +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + +**-n** *N* \| **––num-threads=**\ \ *N* + Use *N* threads in the thread pool. + +**-T** *USEC* \| **––timetravel=**\ \ *USEC* + Modify the system time by *USEC* microseconds. + *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``). + This option is intended for debugging/testing only. + **-t** *SECONDS* \| **––timeout=**\ \ *SECONDS* Specifies the number of SECONDS after which the HTTPD should close (idle) HTTP connections. -**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* - Specifies the log level to use. Accepted values are: DEBUG, INFO, - WARNING, ERROR. +**-v** \| **––version** + Print version information. SIGNALS ======= diff --git a/manpages/taler-exchange-offline.1.rst b/manpages/taler-exchange-offline.1.rst index 8d62ac5f..793a00fc 100644 --- a/manpages/taler-exchange-offline.1.rst +++ b/manpages/taler-exchange-offline.1.rst @@ -15,7 +15,7 @@ Synopsis [**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] [**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] -[**-o** *FILE* | **––output=**\ \ *FILE*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] [**-v** | **––version**] [subcommand ...] @@ -58,9 +58,8 @@ The general options for **taler-exchange-offline** are: Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, ``WARNING``, ``ERROR``. -**-o** *FILE* \| **––output=**\ \ *FILE* - Where to write a denomination key signing request file to be given to - the auditor. +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. **-v** \| **––version** Print version information. diff --git a/manpages/taler-exchange-transfer.1.rst b/manpages/taler-exchange-transfer.1.rst index 05ee8aca..743d2cce 100644 --- a/manpages/taler-exchange-transfer.1.rst +++ b/manpages/taler-exchange-transfer.1.rst @@ -12,14 +12,18 @@ Synopsis ======== **taler-exchange-transfer** +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-T** *USEC* | **––timetravel**\ \ *USEC*] [**-t** | **––test**] [**-v** | **––version**] Description =========== -**taler-exchange-transfer** is a command line tool to actually execute scheduled wire transfers (using the bank/wire gateway). +**taler-exchange-transfer** is a command-line tool to actually execute scheduled wire transfers (using the bank/wire gateway). The transfers are prepared by the **taler-exchange-aggregator** and **taler-exchange-closer** tools. **-c** *FILENAME* \| **––config=**\ \ *FILENAME* @@ -29,6 +33,18 @@ The transfers are prepared by the **taler-exchange-aggregator** and **taler-exch **-h** \| **––help** Print short help on options. +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + +**-T** *USEC* \| **––timetravel=**\ \ *USEC* + Modify the system time by *USEC* microseconds. + *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``). + This option is intended for debugging/testing only. + **-t** \| **––test** Run in test mode and exit when idle. diff --git a/manpages/taler-exchange-wirewatch.1.rst b/manpages/taler-exchange-wirewatch.1.rst index 2cf56e87..605ff54b 100644 --- a/manpages/taler-exchange-wirewatch.1.rst +++ b/manpages/taler-exchange-wirewatch.1.rst @@ -12,34 +12,49 @@ Synopsis ======== **taler-exchange-wirewatch** -[**-t** *PLUGINNAME* | **––type=**\ \ *PLUGINNAME*] +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] [**-h** | **––help**] -[**-T** | **––test**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] [**-r** | **––reset**] +[**-T** | **––test**] +[**-t** *PLUGINNAME* | **––type=**\ \ *PLUGINNAME*] [**-v** | **––version**] Description =========== -**taler-exchange-wirewatch** is a command line tool to import wire +**taler-exchange-wirewatch** is a command-line tool to import wire transactions into the Taler exchange database. Its options are as follows: -**-t** *PLUGINNAME* \| **––type=**\ \ *PLUGINNAME* - Use the specified wire plugin and its configuration to talk to the - bank. +**-c** *FILENAME* \| **––config=**\ \ *FILENAME* + Use the configuration and other resources for the exchange to operate + from *FILENAME*. **-h** \| **––help** Print short help on options. -**-T** \| **––test** - Run in test mode and exit when idle. +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. **-r** \| **––reset** Ignore our own database and start with transactions from the beginning of time. +**-T** *USEC* \| **––timetravel=**\ \ *USEC* + Modify the system time by *USEC* microseconds. + *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``). + This option is intended for debugging/testing only. + +**-t** \| **––test** + Run in test mode and exit when idle. + **-v** \| **––version** Print version information. diff --git a/manpages/taler-merchant-benchmark.1.rst b/manpages/taler-merchant-benchmark.1.rst index 4f44503a..45f966dd 100644 --- a/manpages/taler-merchant-benchmark.1.rst +++ b/manpages/taler-merchant-benchmark.1.rst @@ -19,7 +19,7 @@ Synopsis Description =========== -**taler-merchant-benchmark** is a command line tool to populate your +**taler-merchant-benchmark** is a command-line tool to populate your merchant database with payments for benchmarking. diff --git a/manpages/taler-merchant-httpd.1.rst b/manpages/taler-merchant-httpd.1.rst index 2de9df6d..df175598 100644 --- a/manpages/taler-merchant-httpd.1.rst +++ b/manpages/taler-merchant-httpd.1.rst @@ -12,13 +12,19 @@ taler-merchant-httpd(1) Synopsis ======== -**taler-merchant-httpd** [*options*] - +**taler-merchant-httpd** +[**-C** | **––connection-close**] +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] +[**-h** | **––help**] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-T** *USEC* | **––timetravel**\ \ *USEC*] +[**-v** | **––version**] Description =========== -taler-merchant-httpd is a command line tool to run the Taler merchant +taler-merchant-httpd is a command-line tool to run the Taler merchant (HTTP backend). The required configuration and database must exist before running this command. @@ -27,19 +33,31 @@ Options ======= **-C** \| **––connection-close** - 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). + 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). **-c** *FILENAME* \| **––config=**\ \ *FILENAME* - Use the configuration and other resources for the merchant to - operate from FILENAME. + Use the configuration and other resources for the merchant to + operate from FILENAME. **-h** \| **––help** - Print short help on options. + Print short help on options. + +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. + +**-T** *USEC* \| **––timetravel=**\ \ *USEC* + Modify the system time by *USEC* microseconds. + *USEC* may be prefixed with ``+`` or ``-`` (e.g. ``-T +300``). + This option is intended for debugging/testing only. **-v** \| **––version** - Print version information. + Print version information. Signals diff --git a/manpages/taler-merchant-setup-reserve.1.rst b/manpages/taler-merchant-setup-reserve.1.rst index 5559d3fe..321af52a 100644 --- a/manpages/taler-merchant-setup-reserve.1.rst +++ b/manpages/taler-merchant-setup-reserve.1.rst @@ -13,13 +13,27 @@ taler-merchant-setup-reserve(1) Synopsis ======== -**taler-merchant-setup-reserve** [*options*] +**taler-merchant-setup-reserve** +[**-A** *USERNAME:PASSWORD* | **––auth=**\ \ *USERNAME:PASSWORD*] +[**-a** *VALUE* | **––amount=**\ \ *VALUE*] +[**-C** *CERTFILE* | **––cert=**\ \ *CERTFILE*] +[**-c** *FILENAME* | **––config=**\ \ *FILENAME*] +[**-e** *URL* | **––exchange-url=**\ \ *URL*] +[**-h** | **––help**] +[**-k** *KEYFILE* | **––key=**\ \ *KEYFILE*] +[**-L** *LOGLEVEL* | **––loglevel=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ \ *FILENAME*] +[**-m** *URL* | **––merchant-url=**\ \ *URL*] +[**-p** *KEYFILEPASSPHRASE* | **––pass=**\ \ *KEYFILEPASSPHRASE*] +[**-t** *CERTTYPE* | **––type=**\ \ *CERTTYPE*] +[**-w** *METHOD* | **––wire-method=**\ \ *METHOD*] +[**-v** | **––version**] Description =========== -**taler-merchant-setup-reserve** is a command line tool to setup a reserve +**taler-merchant-setup-reserve** is a command-line tool to setup a reserve (creating the private reserve key) and obtaining the wire transfer information from the exchange needed to fill the reserve. @@ -27,55 +41,69 @@ from the exchange needed to fill the reserve. Options ======= -**-a** *VALUE* \| **––amount=**\ \ *VALUE* - Amount to be transferred to the reserve. Mandatory. - **-A** *USERNAME:PASSWORD* \| **––auth=**\ \ *USERNAME:PASSWORD* - Use USERNAME and PASSWORD for HTTP client authentication. 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 "-C", "-k" and "-p" options. The PASSWORD given to this option is given to the server! Optional. + Use ``USERNAME`` and ``PASSWORD`` for HTTP client authentication. + 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 ``-C``, ``-k`` and ``-p`` options. + The ``PASSWORD`` given to this option is given to the server! + +**-a** *VALUE* \| **––amount=**\ \ *VALUE* + Mandatory. + Amount to be transferred to the reserve. **-C** *CERTFILE* \| **––cert=**\ \ *CERTFILE* - The specified CERTFILE contains a TLS client certificate to be used to authenticate the client. Optional. See also "-t". + The specified ``CERTFILE`` contains a TLS client certificate to be used to + authenticate the client. See also ``-t``. + +**-c** *FILENAME* \| **––config=**\ \ *FILENAME* + Use the configuration and other resources for the merchant to + operate from ``FILENAME``. **-e** *URL* \| **––exchange-url=**\ \ *URL* - Use URL 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. Mandatory. + Mandatory. + Use ``URL`` 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. + +**-h** \| **––help** + Print short help on options. **-k** *KEYFILE* \| **––key=**\ \ *KEYFILE* - The specified KEYFILE contains a TLS client private key to be used to authenticate the client. Optional. See also "-p" and "-C". + The specified ``KEYFILE`` contains a TLS client private key to be used to + authenticate the client. See also ``-p`` and ``-C``. + +**-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* + Send logging output to *FILENAME*. **-m** *URL* \| **––merchant-url=**\ \ *URL* - Use URL as the merchant base URL. Should include the path to - the instance if the reserve is to be created for a non-default instance. - Mandatory. + Mandatory. + Use ``URL`` as the merchant base URL. + Should include the path to the instance if the reserve is to be + created for a non-default instance. **-p** *KEYFILEPASSPHRASE* \| **––pass=**\ \ *KEYFILEPASSPHRASE* - The specified KEYFILEPASSPHRASE is to be used to decrypt the KEYFILE. Optional. See also "-k". Not to be confused with "-A". The KEYFILEPASSPHRASE given here is only used locally to decrypt the KEYFILE. + The specified ``KEYFILEPASSPHRASE`` is to be used to decrypt the KEYFILE. + See also ``-k``. Not to be confused with ``-A``. + The ``KEYFILEPASSPHRASE`` given here is only used locally to decrypt the KEYFILE. **-t** *CERTTYPE* \| **––type=**\ \ *CERTTYPE* - The specified CERTFILE contains a TLS client certificate of CERTTYPE. Default is "PEM". Optional. See also "-C". + The specified CERTFILE contains a TLS client certificate of ``CERTTYPE``. + Default is ``PEM``. See also ``-C``. **-w** *METHOD* \| **––wire-method=**\ \ *METHOD* - 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 "iban" or "x-taler-bank". - Mandatory. - -**-c** *FILENAME* \| **––config=**\ \ *FILENAME* - Use the configuration and other resources for the merchant to - operate from FILENAME. - -**-h** \| **––help** - Print short help on options. + 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 ``iban`` or ``x-taler-bank``. **-v** \| **––version** - Print version information. - -**-l** *LF* \| **––logfile=**\ \ *LF* - Sends logs to file whose path is LF. - -**-L** *LOGLEVEL* \| **––log=**\ \ *LOGLEVEL* - Use loglevel LOGLEVEL. + Print version information. See Also diff --git a/manpages/taler-wallet-cli.1.rst b/manpages/taler-wallet-cli.1.rst index 8e7d3be0..d109470b 100644 --- a/manpages/taler-wallet-cli.1.rst +++ b/manpages/taler-wallet-cli.1.rst @@ -21,7 +21,7 @@ Synopsis Description =========== -**taler-wallet-cli** is a command line tool to be used by developers +**taler-wallet-cli** is a command-line tool to be used by developers for testing. **-h** | **––help** |