gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated: update man page


From: gnunet
Subject: [taler-docs] branch master updated: update man page
Date: Sat, 07 Mar 2020 12:22:55 +0100

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new b318b01  update man page
b318b01 is described below

commit b318b019b0f76045cbffb3f8f729b8ff9f623367
Author: Christian Grothoff <address@hidden>
AuthorDate: Sat Mar 7 12:22:53 2020 +0100

    update man page
---
 manpages/taler-bank-transfer.1.rst | 76 ++++++++++++++++++++++++++++----------
 1 file changed, 57 insertions(+), 19 deletions(-)

diff --git a/manpages/taler-bank-transfer.1.rst 
b/manpages/taler-bank-transfer.1.rst
index 31f2ecf..9e466de 100644
--- a/manpages/taler-bank-transfer.1.rst
+++ b/manpages/taler-bank-transfer.1.rst
@@ -6,59 +6,97 @@ taler-bank-transfer(1)
    Name
    ====
 
-   **taler-bank-transfer** - trigger a transfer at the bank
+   **taler-bank-transfer** - trigger a transfer at the bank (or obtain 
transaction history)
 
 Synopsis
 ========
 
-**taler-bank-transfer** [**-a** *VALUE* | **--amount=**\ ‌\ *VALUE*]
+**taler-bank-transfer**
+[**-a** *VALUE* | **--amount=**\ ‌\ *VALUE*]
 [**-b** *URL* | **--bank=**\ ‌\ *URL*]
 [**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
-[**-h** | **--help**]
 [**-C** *ACCOUNT* | **--credit=**\ ‌\ *ACCOUNT*]
-[**-s** *STRING* | **--subject=**\ ‌\ *STRING*]
-[**-u** *USERNAME* | **--user=**\ ‌\ *USERNAME*]
+[**-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*]
+[**-u** *USERNAME* | **--user=**\ ‌\ *USERNAME*]
 [**-v** | **--version**]
+[**-w** *ROW* | **--since-when=**\ ‌\ *ROW*]
 
 Description
 ===========
 
-**taler-bank-transfer** is a command line tool to trigger bank
-transfers to the exchange.  Useful for testing provided that
-the configured Taler Wire Gateway supports the wire transfer
-API.
+**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. Mandatory option.
+   CURRENCY:VALUE.FRACTION.
 
 **-b** *URL* \| **--bank=**\ ‌\ *URL*
-   URL at which the bank is operation.  Mandatory option.
+   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.
+
+**-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.
 
-**-C** *ACCOUNT* \| **--credit=**\ ‌\ *ACCOUNT*
-   The money should be credited to ACCOUNT. Specifies the number of the
-   account.  Mandatory option.
+**-i** \| **--credit-history**
+   Obtain credit history of the exchange. Conflicts with **-o**.
 
-**-s** *STRING* \| **--subject=**\ ‌\ *STRING*
-   Use STRING for the wire transfer subject.  Must be a reserve public key.
-   Mandatory option.
+**-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.  Mandatory option.
+   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.  Mandatory option.
+   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
 ========
 

-- 
To stop receiving notification emails like this one, please contact
address@hidden.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]