summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2017-11-04 11:51:30 +0100
committerChristian Grothoff <christian@grothoff.org>2017-11-04 11:51:30 +0100
commit65d6a4851e9544fded2b776fb955900598744f96 (patch)
tree7919d1024347d49da0719bbd64ce7ab13f482356 /doc
parentdc03bcf42d48ba06cdc26fd8f31dae72324be387 (diff)
downloadmerchant-65d6a4851e9544fded2b776fb955900598744f96.tar.gz
merchant-65d6a4851e9544fded2b776fb955900598744f96.tar.bz2
merchant-65d6a4851e9544fded2b776fb955900598744f96.zip
add taler-merchant-tip-enable, including docs
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am21
-rw-r--r--doc/taler-merchant-httpd.137
-rw-r--r--doc/taler-merchant-tip-enable.147
3 files changed, 101 insertions, 4 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index fdfea961..e20e3337 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -11,13 +11,26 @@ arch.jpg: arch.dot
AM_MAKEINFOHTMLFLAGS = --no-split --css-ref=docstyle.css --css-ref=brown-paper.css
+man_MANS = \
+ taler-merchant-tip-enable.1 \
+ taler-merchant-httpd.1
+
info_TEXINFOS = manual.texi
+
manual_TEXINFOS = version.texi
+extra_TEXINFOS = \
+ fdl-1.3.texi \
+ agpl.texi \
+ syntax.texi
+
EXTRA_DIST = \
arch.dot \
- lgpl.texi \
- agpl.texi \
- fdl-1.3.texi \
+ $(extra_TEXINFOS) \
docstyle.css \
- brown-paper.css
+ brown-paper.css \
+ $(man_MANS)
+
+DISTCLEANFILES = \
+ manual.cps \
+ manual.dvi
diff --git a/doc/taler-merchant-httpd.1 b/doc/taler-merchant-httpd.1
new file mode 100644
index 00000000..7e345875
--- /dev/null
+++ b/doc/taler-merchant-httpd.1
@@ -0,0 +1,37 @@
+.TH TALER\-MERCHANT\-HTTPD 1 "Nov 4, 2017" "GNU Taler"
+
+.SH NAME
+taler\-merchant\-httpd \- Run Taler merchant backend (with RESTful API)
+
+.SH SYNOPSIS
+.B taler\-merchant\-httpd
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBtaler\-merchant\-httpd\fP is a command line tool to run the Taler merchant (HTTP backend). The required configuration and database must exist before running this command.
+
+.SH OPTIONS
+.B
+.IP "\-C, \-\-connection-close"
+Force each HTTP connection to be closed after each request (useful in combination with \-f to avoid having to wait for nc to time out).
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration and other resources for the merchant to operate from FILENAME.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-v, \-\-version"
+Print version information.
+
+.SH SIGNALS
+.B
+.IP SIGTERM
+Sending a SIGTERM to the process will cause it to shutdown cleanly.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
+
+.SH "SEE ALSO"
+\fBtaler\-merchant\-dbinit\fP(1), \fBtaler\-merchant\-tip\-enable\fP(1), \fBtaler.conf\fP(5)
diff --git a/doc/taler-merchant-tip-enable.1 b/doc/taler-merchant-tip-enable.1
new file mode 100644
index 00000000..b61504b6
--- /dev/null
+++ b/doc/taler-merchant-tip-enable.1
@@ -0,0 +1,47 @@
+.TH TALER\-MERCHANT\-TIP\-ENABLE 1 "Nov 4, 2017" "GNU Taler"
+
+.SH NAME
+taler\-merchant\-tip\-enable \- Tell Taler merchant backend about reserve funding for tipping
+
+.SH SYNOPSIS
+.B taler\-merchant\-tip\-enable
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBtaler\-merchant\-tip\-enable\fP is a command line tool to inform the Taler merchant backend that a wire transfer was made to enable tipping from the backend. Note that the command cannot check that the wire transfer was made correctly (with the correct wire subject and the specified amount), and will thus just trust the operator. Enabling tipping at an instance without a wire transfer may cause visitors to receive unfunded tips and experience error messages. You should read the manual chapter on tipping before using this command.
+
+.SH OPTIONS
+.B
+.IP "\-a VALUE, \-\-amount=VALUE"
+Which amount was transferred into the reserve at the exchange. Must be of the format CUR:VALUE.FRACTION.
+.B
+.IP "\-b URI, \-\-backend=URI"
+At which URI does the backend run that we are to inform about the availability of funding for tipping?
+.B
+.IP "\-C UUID, \-\-credit-uuid=UUID"
+What is the UUID of the wire transfer. The backend will automatically detect if the same UUID is used repeatedly, and ignore multiple invocations. Pass a UUID generated by the wire transfer of the bank.
+.B
+.IP "\-e TIMESTAMP, \-\-expiration=TIMESTAMP"
+When does the reserve expire. Determining this value may today require information from the exchange operator.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-i NAME, \-\-instance=NAME"
+Name of the instance where tipping is to be enabled. The instance must have the reserve (private) key and exchange URI already configured. Note that this command-line tool must also have access to the same configuration with the instance's private key in it.
+.B
+.IP "\-v, \-\-version"
+Print version information.
+.B
+
+.SH SIGNALS
+.B
+.IP SIGTERM
+Sending a SIGTERM to the process will cause it to shutdown cleanly.
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
+
+.SH "SEE ALSO"
+\fBtaler\-merchant\-httpd\fP(1), \fBtaler.conf\fP(5)