summaryrefslogtreecommitdiff
path: root/man/taler-merchant-setup-reserve.1
blob: e0437f595fce6351db11350a4ebea5cf7eebff4d (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
.\" Man page generated from reStructuredText.
.
.TH "TALER-MERCHANT-SETUP-RESERVE" "1" "Jul 06, 2022" "0.9" "GNU Taler"
.SH NAME
taler-merchant-setup-reserve \- setup reserve for tipping at a Taler merchant backend
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBtaler\-merchant\-setup\-reserve\fP
[\fB\-A\fP\ \fIUSERNAME:PASSWORD\fP\ |\ \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP]
[\fB\-a\fP\ \fIVALUE\fP\ |\ \fB\-\-amount=\fP\fIVALUE\fP]
[\fB\-C\fP\ \fICERTFILE\fP\ |\ \fB\-\-cert=\fP\fICERTFILE\fP]
[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP]
[\fB\-e\fP\ \fIURL\fP\ |\ \fB\-\-exchange\-url=\fP\fIURL\fP]
[\fB\-h\fP\ |\ \fB\-\-help\fP]
[\fB\-k\fP\ \fIKEYFILE\fP\ |\ \fB\-\-key=\fP\fIKEYFILE\fP]
[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP‌\fILOGLEVEL\fP]
[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP‌\fIFILENAME\fP]
[\fB\-m\fP\ \fIURL\fP\ |\ \fB\-\-merchant\-url=\fP\fIURL\fP]
[\fB\-p\fP\ \fIKEYFILEPASSPHRASE\fP\ |\ \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP]
[\fB\-t\fP\ \fICERTTYPE\fP\ |\ \fB\-\-type=\fP\fICERTTYPE\fP]
[\fB\-w\fP\ \fIMETHOD\fP\ |\ \fB\-\-wire\-method=\fP\fIMETHOD\fP]
[\fB\-v\fP\ |\ \fB\-\-version\fP]
.SH DESCRIPTION
.sp
\fBtaler\-merchant\-setup\-reserve\fP 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.
.SH OPTIONS
.INDENT 0.0
.TP
\fB\-A\fP \fIUSERNAME:PASSWORD\fP | \fB\-\-auth=\fP\fIUSERNAME:PASSWORD\fP
Use \fBUSERNAME\fP and \fBPASSWORD\fP 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 \fB\-C\fP, \fB\-k\fP and \fB\-p\fP options.
The \fBPASSWORD\fP given to this option is given to the server!
.TP
\fB\-a\fP \fIVALUE\fP | \fB\-\-amount=\fP\fIVALUE\fP
Mandatory.
Amount to be transferred to the reserve.
.TP
\fB\-C\fP \fICERTFILE\fP | \fB\-\-cert=\fP\fICERTFILE\fP
The specified \fBCERTFILE\fP contains a TLS client certificate to be used to
authenticate the client. See also \fB\-t\fP\&.
.TP
\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP
Use the configuration and other resources for the merchant to
operate from \fBFILENAME\fP\&.
.TP
\fB\-e\fP \fIURL\fP | \fB\-\-exchange\-url=\fP\fIURL\fP
Mandatory.
Use \fBURL\fP 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.
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-k\fP \fIKEYFILE\fP | \fB\-\-key=\fP\fIKEYFILE\fP
The specified \fBKEYFILE\fP contains a TLS client private key to be used to
authenticate the client. See also \fB\-p\fP and \fB\-C\fP\&.
.TP
\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP‌\fILOGLEVEL\fP
Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
\fBWARNING\fP, \fBERROR\fP\&.
.TP
\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP‌\fIFILENAME\fP
Send logging output to \fIFILENAME\fP\&.
.TP
\fB\-m\fP \fIURL\fP | \fB\-\-merchant\-url=\fP\fIURL\fP
Mandatory.
Use \fBURL\fP as the merchant base URL.
Should include the path to the instance if the reserve is to be
created for a non\-default instance.
.TP
\fB\-p\fP \fIKEYFILEPASSPHRASE\fP | \fB\-\-pass=\fP\fIKEYFILEPASSPHRASE\fP
The specified \fBKEYFILEPASSPHRASE\fP is to be used to decrypt the KEYFILE.
See also \fB\-k\fP\&. Not to be confused with \fB\-A\fP\&.
The \fBKEYFILEPASSPHRASE\fP given here is only used locally to decrypt the KEYFILE.
.TP
\fB\-t\fP \fICERTTYPE\fP | \fB\-\-type=\fP\fICERTTYPE\fP
The specified CERTFILE contains a TLS client certificate of \fBCERTTYPE\fP\&.
Default is \fBPEM\fP\&. See also \fB\-C\fP\&.
.TP
\fB\-w\fP \fIMETHOD\fP | \fB\-\-wire\-method=\fP\fIMETHOD\fP
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 \fBiban\fP or \fBx\-taler\-bank\fP\&.
.TP
\fB\-v\fP | \fB\-\-version\fP
Print version information.
.UNINDENT
.SH SEE ALSO
.sp
taler\-merchant\-dbinit(1), taler.conf(5)
.SH BUGS
.sp
Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic
mail to <\fI\%taler@gnu.org\fP>.
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.