diff options
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/taler-exchange-benchmark.1 | 41 |
2 files changed, 42 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index cfcbea609..b3c527168 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -14,6 +14,7 @@ man_MANS = \ taler-exchange-keycheck.1 \ taler-exchange-wire.1 \ taler-exchange-wirewatch.1 \ + taler-exchange-benchmark.1 \ taler.conf.5 AM_MAKEINFOHTMLFLAGS = --no-split --css-ref=docstyle.css --css-ref=brown-paper.css diff --git a/doc/taler-exchange-benchmark.1 b/doc/taler-exchange-benchmark.1 new file mode 100644 index 000000000..118693751 --- /dev/null +++ b/doc/taler-exchange-benchmark.1 @@ -0,0 +1,41 @@ +.TH TALER\-EXCHANGE\-BENCHMARK 1 "Jul 25, 2018" "GNU Taler" + +.SH NAME +taler\-exchange\-benchmark \- Measure exchange performance. + +.SH SYNOPSIS +.B taler\-exchange\-benchmark +.RI [ options ] +.br + +.SH DESCRIPTION +\fBtaler\-exchange\-benchmark\fP is a command line tool to measure the time spent to serve withdrawals/deposits/refreshes. It usually needs a dedicate configuration file where all the services - the exchange and the (fake)bank - listen to URLs not subject to any reverse proxy, as say Nginx. Moreover, the benchmark runs on a "volatile" database, that means that table are always erased during a single benchmark run. + +.SH OPTIONS + +.B +.IP "\-c CONFIG_FILENAME, \-\-config=CONFIG_FILENAME" +(Mandatory) Use CONFIG_FILENAME. + +.B +.IP "\-b BANK_URL, --bank-url=BANK_URL" +(Mandatory) The URL where the fakebank listens at. Must match the host component in the exchange's escrow account "payto" URL. + +.B +.IP "\-n HOWMANY_COINS, \-\-coins-number=HOWMANY_COINS" +Defaults to 1. Specifies how many coins this benchmark should withdraw and spend. After being spent, each coin will be refreshed with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1; future versions of this tool should offer this parameter as a CLI option. + +.B +.IP "\-l LOGLEVEL, \-\-log\-level=LOGLEVEL" +GNUnet-compatible log level, takes values "ERROR/WARNING/INFO/DEBUG" + +.B +.IP "\-h, \-\-help" +Prints a compiled-in help text. + +.B +.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\-dbinit\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-httpd\fP(1), \fBtaler.conf\fP(5) |