From 4a0c763410651ee717370e88894bf482f0996c11 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Fri, 8 Jan 2021 14:28:50 -0500 Subject: taler-bank-transfer(1): reorder opts, both in synopsis and description --- manpages/taler-bank-transfer.1.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/manpages/taler-bank-transfer.1.rst b/manpages/taler-bank-transfer.1.rst index e37d596a..dcf74925 100644 --- a/manpages/taler-bank-transfer.1.rst +++ b/manpages/taler-bank-transfer.1.rst @@ -14,15 +14,15 @@ Synopsis **taler-bank-transfer** [**-a** *VALUE* | **––amount=**\ ‌\ *VALUE*] [**-b** *URL* | **––bank=**\ ‌\ *URL*] -[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*] [**-C** *ACCOUNT* | **––credit=**\ ‌\ *ACCOUNT*] +[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*] [**-D** *ACCOUNT* | **––debit=**\ ‌\ *ACCOUNT*] [**-h** | **––help**] [**-i** | **––credit-history**] [**-o** | **––debit-history**] [**-p** *PASSPHRASE* | **––pass=**\ ‌\ *PASSPHRASE*] -[**-s** *ACCOUNT-SECTION* | **––section=**\ ‌\ *ACCOUNT-SECTION*] [**-S** *STRING* | **––subject=**\ ‌\ *STRING*] +[**-s** *ACCOUNT-SECTION* | **––section=**\ ‌\ *ACCOUNT-SECTION*] [**-u** *USERNAME* | **––user=**\ ‌\ *USERNAME*] [**-v** | **––version**] [**-w** *ROW* | **––since-when=**\ ‌\ *ROW*] @@ -56,14 +56,14 @@ Options **-b** *URL* \| **––bank=**\ ‌\ *URL* URL at which the bank is operation. Conflicts with **-s**. -**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME* - Use the given configuration file. - **-C** *ACCOUNT* \| **––credit=**\ ‌\ *ACCOUNT* When doing a wire transfer from the exchange, the money should be credited to *ACCOUNT*. Specifies the payto:// URI of the account. Can also be used as a filter by credit account when looking at transaction histories. +**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME* + Use the given configuration file. + **-D** *ACCOUNT* \| **––debit=**\ ‌\ *ACCOUNT* When doing a wire transfer to the exchange, the *ACCOUNT* is to be debited. Specifies the payto:// URI of the account. Can also be used as a filter by debit -- cgit v1.2.3 From bd538d48e93ff3e74986858872dfd3a279e0135c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Fri, 8 Jan 2021 14:31:00 -0500 Subject: taler-wire-gateway-client(1): rename from taler-bank-transfer(1) --- manpages/taler-bank-transfer.1.rst | 109 ------------------------------- manpages/taler-wire-gateway-client.1.rst | 109 +++++++++++++++++++++++++++++++ 2 files changed, 109 insertions(+), 109 deletions(-) delete mode 100644 manpages/taler-bank-transfer.1.rst create mode 100644 manpages/taler-wire-gateway-client.1.rst diff --git a/manpages/taler-bank-transfer.1.rst b/manpages/taler-bank-transfer.1.rst deleted file mode 100644 index dcf74925..00000000 --- a/manpages/taler-bank-transfer.1.rst +++ /dev/null @@ -1,109 +0,0 @@ -taler-bank-transfer(1) -###################### - -.. only:: html - - Name - ==== - - **taler-bank-transfer** - trigger a transfer at the bank (or obtain transaction history) - -Synopsis -======== - -**taler-bank-transfer** -[**-a** *VALUE* | **––amount=**\ ‌\ *VALUE*] -[**-b** *URL* | **––bank=**\ ‌\ *URL*] -[**-C** *ACCOUNT* | **––credit=**\ ‌\ *ACCOUNT*] -[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*] -[**-D** *ACCOUNT* | **––debit=**\ ‌\ *ACCOUNT*] -[**-h** | **––help**] -[**-i** | **––credit-history**] -[**-o** | **––debit-history**] -[**-p** *PASSPHRASE* | **––pass=**\ ‌\ *PASSPHRASE*] -[**-S** *STRING* | **––subject=**\ ‌\ *STRING*] -[**-s** *ACCOUNT-SECTION* | **––section=**\ ‌\ *ACCOUNT-SECTION*] -[**-u** *USERNAME* | **––user=**\ ‌\ *USERNAME*] -[**-v** | **––version**] -[**-w** *ROW* | **––since-when=**\ ‌\ *ROW*] - -Description -=========== - -**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. - -You can do one of the following four operations during one invocation. - - (1) Execute wire transfer from the exchange to consumer account (**-C**). - (2) Execute wire transfer from consumer account to the exchange (**-D**). - (3) Inspect credit history of the exchange (**-i**). - (4) Inspect debit history of the exchange (**-o**). - -Doing more than one of these at a time will result in an error. Note, -however, that the **-C** and **-D** options also can be used to act as filters -on transaction history operations. - - -Options -======= - -**-a** *VALUE* \| **––amount=**\ ‌\ *VALUE* - Amount to transfer. Given in the Taler-typical format of - CURRENCY:VALUE.FRACTION. - -**-b** *URL* \| **––bank=**\ ‌\ *URL* - URL at which the bank is operation. Conflicts with **-s**. - -**-C** *ACCOUNT* \| **––credit=**\ ‌\ *ACCOUNT* - When doing a wire transfer from the exchange, the money should be credited to *ACCOUNT*. - Specifies the payto:// URI of the account. Can also be used as a filter by credit - account when looking at transaction histories. - -**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME* - Use the given configuration file. - -**-D** *ACCOUNT* \| **––debit=**\ ‌\ *ACCOUNT* - When doing a wire transfer to the exchange, the *ACCOUNT* 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. - -**-h** \| **––help** - Print short help on options. - -**-i** \| **––credit-history** - Obtain credit history of the exchange. Conflicts with **-o**. - -**-o** \| **––debit-history** - Obtain debit history of the exchange. Conflicts with **-i**. - -**-S** *SUBJECT* \| **––subject=**\ ‌\ *SUBJECT* - Use *SUBJECT* 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. - -**-s** *ACCOUNT_SECTION* \| **––section=**\ ‌\ *ACCOUNT-SECTION* - Obtain exchange account information from the *ACCOUNT-SECTION* of the configuration. Conflicts with **-u**, **-p** and **-b**. Note that either **-b** or **-s** must be specified. - -**-u** *USERNAME* \| **––user=**\ ‌\ *USERNAME* - Specifies the username for authentication. Optional and conflicts with **-s**. If neither **-u** nor **-s** are used, we will attempt to talk to the bank without authentication. - -**-p** *PASSPHRASE* \| **––pass=**\ ‌\ *PASSPHRASE* - Specifies the pass phrase for authentication. Conflicts with **-s**. - -**-v** \| **––version** - Print version information. - -**-w** *ROW* \| **––since-when=**\ ‌\ *ROW* - Specifies a *ROW* from which the history should be obtained. If not given, the 10 youngest transactions are returned. - - -See Also -======== - -taler-bank-manage(1), taler.conf(5), https://docs.taler.net/core/api-wire.html#wire-transfer-test-apis - -Bugs -==== - -Report bugs by using https://bugs.taler.net/ or by sending electronic -mail to diff --git a/manpages/taler-wire-gateway-client.1.rst b/manpages/taler-wire-gateway-client.1.rst new file mode 100644 index 00000000..cd76d01b --- /dev/null +++ b/manpages/taler-wire-gateway-client.1.rst @@ -0,0 +1,109 @@ +taler-wire-gateway-client(1) +############################ + +.. only:: html + + Name + ==== + + **taler-wire-gateway-client** - trigger a transfer at the bank (or obtain transaction history) + +Synopsis +======== + +**taler-wire-gateway-client** +[**-a** *VALUE* | **––amount=**\ ‌\ *VALUE*] +[**-b** *URL* | **––bank=**\ ‌\ *URL*] +[**-C** *ACCOUNT* | **––credit=**\ ‌\ *ACCOUNT*] +[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*] +[**-D** *ACCOUNT* | **––debit=**\ ‌\ *ACCOUNT*] +[**-h** | **––help**] +[**-i** | **––credit-history**] +[**-o** | **––debit-history**] +[**-p** *PASSPHRASE* | **––pass=**\ ‌\ *PASSPHRASE*] +[**-S** *STRING* | **––subject=**\ ‌\ *STRING*] +[**-s** *ACCOUNT-SECTION* | **––section=**\ ‌\ *ACCOUNT-SECTION*] +[**-u** *USERNAME* | **––user=**\ ‌\ *USERNAME*] +[**-v** | **––version**] +[**-w** *ROW* | **––since-when=**\ ‌\ *ROW*] + +Description +=========== + +**taler-wire-gateway-client** 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. + +You can do one of the following four operations during one invocation. + + (1) Execute wire transfer from the exchange to consumer account (**-C**). + (2) Execute wire transfer from consumer account to the exchange (**-D**). + (3) Inspect credit history of the exchange (**-i**). + (4) Inspect debit history of the exchange (**-o**). + +Doing more than one of these at a time will result in an error. Note, +however, that the **-C** and **-D** options also can be used to act as filters +on transaction history operations. + + +Options +======= + +**-a** *VALUE* \| **––amount=**\ ‌\ *VALUE* + Amount to transfer. Given in the Taler-typical format of + CURRENCY:VALUE.FRACTION. + +**-b** *URL* \| **––bank=**\ ‌\ *URL* + URL at which the bank is operation. Conflicts with **-s**. + +**-C** *ACCOUNT* \| **––credit=**\ ‌\ *ACCOUNT* + When doing a wire transfer from the exchange, the money should be credited to *ACCOUNT*. + Specifies the payto:// URI of the account. Can also be used as a filter by credit + account when looking at transaction histories. + +**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME* + Use the given configuration file. + +**-D** *ACCOUNT* \| **––debit=**\ ‌\ *ACCOUNT* + When doing a wire transfer to the exchange, the *ACCOUNT* 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. + +**-h** \| **––help** + Print short help on options. + +**-i** \| **––credit-history** + Obtain credit history of the exchange. Conflicts with **-o**. + +**-o** \| **––debit-history** + Obtain debit history of the exchange. Conflicts with **-i**. + +**-S** *SUBJECT* \| **––subject=**\ ‌\ *SUBJECT* + Use *SUBJECT* 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. + +**-s** *ACCOUNT_SECTION* \| **––section=**\ ‌\ *ACCOUNT-SECTION* + Obtain exchange account information from the *ACCOUNT-SECTION* of the configuration. Conflicts with **-u**, **-p** and **-b**. Note that either **-b** or **-s** must be specified. + +**-u** *USERNAME* \| **––user=**\ ‌\ *USERNAME* + Specifies the username for authentication. Optional and conflicts with **-s**. If neither **-u** nor **-s** are used, we will attempt to talk to the bank without authentication. + +**-p** *PASSPHRASE* \| **––pass=**\ ‌\ *PASSPHRASE* + Specifies the pass phrase for authentication. Conflicts with **-s**. + +**-v** \| **––version** + Print version information. + +**-w** *ROW* \| **––since-when=**\ ‌\ *ROW* + Specifies a *ROW* from which the history should be obtained. If not given, the 10 youngest transactions are returned. + + +See Also +======== + +taler-bank-manage(1), taler.conf(5), https://docs.taler.net/core/api-wire.html#wire-transfer-test-apis + +Bugs +==== + +Report bugs by using https://bugs.taler.net/ or by sending electronic +mail to -- cgit v1.2.3 From 389ab38b74d707af895ae08c5616faa474a3cdaa Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Fri, 8 Jan 2021 14:33:59 -0500 Subject: taler-wire-gateway-client(1): add opts ‘-L’, ‘-l’ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- manpages/taler-wire-gateway-client.1.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/manpages/taler-wire-gateway-client.1.rst b/manpages/taler-wire-gateway-client.1.rst index cd76d01b..538b412e 100644 --- a/manpages/taler-wire-gateway-client.1.rst +++ b/manpages/taler-wire-gateway-client.1.rst @@ -19,6 +19,8 @@ Synopsis [**-D** *ACCOUNT* | **––debit=**\ ‌\ *ACCOUNT*] [**-h** | **––help**] [**-i** | **––credit-history**] +[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*] +[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*] [**-o** | **––debit-history**] [**-p** *PASSPHRASE* | **––pass=**\ ‌\ *PASSPHRASE*] [**-S** *STRING* | **––subject=**\ ‌\ *STRING*] @@ -75,9 +77,19 @@ Options **-i** \| **––credit-history** Obtain credit history of the exchange. Conflicts with **-o**. +**-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*. + **-o** \| **––debit-history** Obtain debit history of the exchange. Conflicts with **-i**. +**-p** *PASSPHRASE* \| **––pass=**\ ‌\ *PASSPHRASE* + Specifies the pass phrase for authentication. Conflicts with **-s**. + **-S** *SUBJECT* \| **––subject=**\ ‌\ *SUBJECT* Use *SUBJECT* 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. @@ -87,9 +99,6 @@ Options **-u** *USERNAME* \| **––user=**\ ‌\ *USERNAME* Specifies the username for authentication. Optional and conflicts with **-s**. If neither **-u** nor **-s** are used, we will attempt to talk to the bank without authentication. -**-p** *PASSPHRASE* \| **––pass=**\ ‌\ *PASSPHRASE* - Specifies the pass phrase for authentication. Conflicts with **-s**. - **-v** \| **––version** Print version information. -- cgit v1.2.3 From c615f5c778f84f271b4105871c2d766cfcaf485b Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Fri, 8 Jan 2021 14:37:50 -0500 Subject: update conf.py for rename (-bank-transfer => -wire-gateway-client) --- conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/conf.py b/conf.py index 534b2f00..c3ea73a0 100644 --- a/conf.py +++ b/conf.py @@ -279,8 +279,6 @@ man_pages = [ "setup auditor database", "GNU Taler contributors", 1), ("manpages/taler-auditor.1", "taler-auditor", "audit exchange", "GNU Taler contributors", 1), - ("manpages/taler-bank-transfer.1", "taler-bank-transfer", - "trigger a transfer at the bank", "GNU Taler contributors", 1), ("manpages/taler-config-generate.1", "taler-config-generate", "tool to simplify Taler configuration generation", "GNU Taler contributors", 1), @@ -316,6 +314,8 @@ man_pages = [ ("manpages/taler-merchant-setup-reserve.1", "taler-merchant-setup-reserve", "setup reserve for tipping at a Taler merchant backend", "GNU Taler contributors", 1), + ("manpages/taler-wire-gateway-client.1", "taler-wire-gateway-client", + "trigger a transfer at the bank", "GNU Taler contributors", 1), ("manpages/taler.conf.5", "taler.conf", "Taler configuration file", "GNU Taler contributors", 5), ] -- cgit v1.2.3