summaryrefslogtreecommitdiff
path: root/manpages/taler-merchant-setup-reserve.1.rst
blob: 321af52adc0eda14ce99e95eefe2b4147c06b24d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
taler-merchant-setup-reserve(1)
###############################


.. only:: html

  Name
  ====

  **taler-merchant-setup-reserve** - setup reserve for tipping


Synopsis
========

**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
(creating the private reserve key) and obtaining the wire transfer information
from the exchange needed to fill the reserve.


Options
=======

**-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!

**-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. 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*
   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. 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*
   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.
   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``. See also ``-C``.

**-w** *METHOD* \| **––wire-method=**\ \ *METHOD*
   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.


See Also
========

taler-merchant-dbinit(1), taler.conf(5)


Bugs
====

Report bugs by using https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.