Update payment generator manpage.

3 files changed, 83 insertions, 51 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index fa9e36ce..d0140d5b 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -19,7 +19,7 @@ merchant-api-python.html: merchant-api.content.texi arch-api.png
 AM_MAKEINFOHTMLFLAGS = --no-split --css-ref=docstyle.css --css-ref=brown-paper.css
 
 man_MANS = \
-  taler-merchant-generate-payments.1 \
+  taler-merchant-benchmark.1 \
   taler-merchant-httpd.1
 
 info_TEXINFOS = \
diff --git a/doc/taler-merchant-benchmark.1 b/doc/taler-merchant-benchmark.1
new file mode 100644
index 00000000..acf8a6d6
--- /dev/null
+++ b/doc/taler-merchant-benchmark.1
@@ -0,0 +1,82 @@
+.TH TALER\-MERCHANT\-BENCHMARK 1 "Mar 5, 2019" "GNU Taler"
+
+.SH NAME
+taler\-merchant\-benchmark \- Generate Taler\-style fake payments.
+
+.SH SYNOPSIS
+.B taler\-merchant\-benchmark
+.RI [ subcommand ]
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBtaler\-merchant\-benchmark\fP is a command line tool to populate your merchant database with fake Taler\-style payments.
+
+.SH SUBCOMMAND
+.B
+.SS ordinary
+Generate normal payments: all the payments are performed (by the default instance) and aggregated by the exchange.
+Takes the following options.
+
+.B
+.IP "\-p PN,  \-\-payments\-number=PN"
+Perform PN many payments, defaults to 1.
+
+.B
+.IP "\-t TN,  \-\-tracks\-number=TN"
+Perform TN many tracking operations, defaults to 1.
+
+.B
+.SS corner
+Drive the generator to create unusual situations, like for example leaving payments
+unaggregated, or using a non-default merchant instance.  Takes the following options.
+
+.B
+.IP "\-t TC, \-\-two\-coins=TC"
+Perform TC many payments that use two coins (normally, all the payments use only one coin).  TC defaults to 1.
+
+.B
+.IP "\-i AI, \-\-alt\-instance=AI"
+Use AI as the instance, instead of 'default' (which is the default instance used.)
+
+.B
+.IP "\-u UN, \-\-unaggregated\-number=UN"
+Generate UN payments that will be left unaggregated.  Note that subsequent invocations of the generator may pick
+those unaggregated payments and actually aggregated them.
+
+
+.SH COMMON OPTIONS
+
+.B
+.IP "\-m URL, \-\-merchant\-url=URL"
+Use URL as the merchant base URL during the benchmark.  The URL is mainly used to download and pay for contracts.
+
+.B
+.IP "\-b URL, \-\-bank\-url=URL"
+Use URL as the bank's base URL during the benchmark.  The URL is used to test whether the bank is up and running.
+
+.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.
+
+.B
+.IP "\-l LF, \-\-logfile=LF"
+Sends logs to file whose path is LF.
+
+.B
+.IP "\-L LOGLEVEL, \-\-log=LOGLEVEL"
+Use loglevel LOGLEVEL.
+
+.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-generate-payments.1 b/doc/taler-merchant-generate-payments.1
deleted file mode 100644
index a848f2cc..00000000
--- a/doc/taler-merchant-generate-payments.1
+++ /dev/null
@@ -1,50 +0,0 @@
-.TH TALER\-MERCHANT\-GENERATE\-PAYMENTS 1 "Nov 4, 2017" "GNU Taler"
-
-.SH NAME
-taler\-merchant\-generate\-payments \- Generate Taler\-style fake payments.
-
-.SH SYNOPSIS
-.B taler\-merchant\-httpd
-.RI [ options ]
-.br
-
-.SH DESCRIPTION
-\fBtaler\-merchant\-generate\-payments\fP is a command line tool to populate your merchant database with fake Taler\-style payments.
-
-.SH OPTIONS
-.B
-.IP "\-n TIMES,  \-\-times TIMES"
-Generate TIMES payments.
-
-.B
-.IP "\-b,  \-\-remote\-bank"
-If given, use the bank specified in the configuration.  Without this option, the "fake bank" will be started on port 8888.
-
-.B
-.IP "\-e,  \-\-remote\-exchange"
-Do not fork any exchange, so the payments will be executed against the exchange specified in the configuration.
-
-.B
-.IP "\-m, \-\-remote\-merchant"
-Do not fork any merchant.  All the payments will be executed against the merchant backend specified in the configuration.
-
-.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)