summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2017-12-14 15:33:10 +0100
committerChristian Grothoff <christian@grothoff.org>2017-12-14 15:33:10 +0100
commit229907c6e233609ccfafe1823f281581bf5e9680 (patch)
tree2c4b89388a2dbcd3eb17a9080becc6a4fa1cdd19 /doc
parent1897d65af506f083d8296e6184c9633d0fb5bae0 (diff)
downloadexchange-229907c6e233609ccfafe1823f281581bf5e9680.tar.gz
exchange-229907c6e233609ccfafe1823f281581bf5e9680.tar.bz2
exchange-229907c6e233609ccfafe1823f281581bf5e9680.zip
implement taler-bank-transfer, fixes #5195
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/taler-bank-transfer.150
-rw-r--r--doc/taler-exchange-reservemod.141
3 files changed, 51 insertions, 43 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index fe997ccea..cfcbea609 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,13 +5,13 @@ SUBDIRS = .
man_MANS = \
taler-auditor.1 \
taler-auditor-sign.1 \
+ taler-bank-transfer.1 \
taler-config-generate.1 \
taler-exchange-aggregator.1 \
taler-exchange-dbinit.1 \
taler-exchange-httpd.1 \
taler-exchange-keyup.1 \
taler-exchange-keycheck.1 \
- taler-exchange-reservemod.1 \
taler-exchange-wire.1 \
taler-exchange-wirewatch.1 \
taler.conf.5
@@ -35,4 +35,3 @@ EXTRA_DIST = \
docstyle.css \
brown-paper.css \
exchange-db.png
-
diff --git a/doc/taler-bank-transfer.1 b/doc/taler-bank-transfer.1
new file mode 100644
index 000000000..da13229bb
--- /dev/null
+++ b/doc/taler-bank-transfer.1
@@ -0,0 +1,50 @@
+.TH TALER\-BANK\-TRANSFER 1 "Dec 14, 2017" "GNU Taler"
+
+.SH NAME
+taler\-bank\-transfer \- Trigger a transfer at the bank
+
+.SH SYNOPSIS
+.B taler\-bank\-transfer
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBtaler\-bank\-transfer\fP is a command line tool to trigger bank transfers.
+
+.SH OPTIONS
+.B
+.IP "\-a VALUE, \-\-amount=VALUE"
+Amount to transfer. Given in the Taler\-typical format of CURRENCY:VALUE.FRACTION
+.B
+.IP "\-b URL, \-\-bank=URL"
+URL at which the bank is operation.
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the given configuration file.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-D ACCOUNT, \-\-debit=ACCOUNT"
+The money should be debited from ACCOUNT. Specifies the number of the account.
+.B
+.IP "\-C ACCOUNT, \-\-credit=ACCOUNT"
+The money should be credited to ACCOUNT. Specifies the number of the account.
+.B
+.IP "\-s STRING, \-\-subject=STRING"
+Use STRING for the wire transfer subject.
+.B
+.IP "\-u USERNAME, \-\-user=USERNAME"
+Specifies the username for authentication.
+.B
+.IP "\-p PASSPHRASE, \-\-pass=PASSPHRASE"
+Specifies the pass phrase for authentication.
+.B
+.IP "\-v, \-\-version"
+Print version information.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
+
+.SH "SEE ALSO"
+\fBtaler\-bank\-manage\fP(1), \fBtaler.conf\fP(5)
diff --git a/doc/taler-exchange-reservemod.1 b/doc/taler-exchange-reservemod.1
deleted file mode 100644
index c74eafbbf..000000000
--- a/doc/taler-exchange-reservemod.1
+++ /dev/null
@@ -1,41 +0,0 @@
-.TH TALER\-EXCHANGE\-RESERVEMOD 1 "Apr 22, 2015" "GNU Taler"
-
-.SH NAME
-taler\-exchange\-reservemod \- Modify reserve balance in the Taler exchange database.
-
-.SH SYNOPSIS
-.B taler\-exchange\-reservemod
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-exchange\-reservemod\fP is a command line tool to modify reserves in the Taler exchange database. Basically, it can be used to import deposits, either for testing or as part of the import from the list of incoming transactions.
-
-.SH OPTIONS
-.B
-.IP "\-a DENOM, \-\-add=DENOM"
-Amount to add to the reserve.
-.B
-.IP "\-d DIRNAME, \-\-exchange-dir=DIRNAME"
-Use the configuration and other resources for the exchange to operate from DIRNAME.
-.B
-.IP "\-h, \-\-help"
-Print short help on options.
-.B
-.IP "\-s JSON, \-\-sender=JSON"
-JSON-formatted acount details of the sender of the wire transfer.
-.B
-.IP "\-t JSON, \-\-transfer=JSON"
-JSON-formatted details that uniquely identify the wire transfer.
-.B
-.IP "\-R KEY, \-\-reserve=KEY"
-Public EdDSA key of the reserve to modify.
-.B
-.IP "\-v, \-\-version"
-Print version information.
-
-.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
-
-.SH "SEE ALSO"
-\fBtaler\-exchange\-httpd\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-dbinit\fP(1), \fBtaler.conf\fP(5)