diff options
Diffstat (limited to 'man/taler-exchange-benchmark.1')
| -rw-r--r-- | man/taler-exchange-benchmark.1 | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/man/taler-exchange-benchmark.1 b/man/taler-exchange-benchmark.1 new file mode 100644 index 00000000..b4c4debd --- /dev/null +++ b/man/taler-exchange-benchmark.1 @@ -0,0 +1,84 @@ +.\" Man page generated from reStructuredText. +. +.TH "TALER-EXCHANGE-BENCHMARK" "1" "Sep 18, 2019" "0.6pre1" "GNU Taler" +.SH NAME +taler-exchange-benchmark \- measure exchange performance +. +.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\-exchange\-benchmark\fP +[\fB\-c\fP\ \fICONFIG_FILENAME\fP\ |\ \fB–config=\fP\fICONFIG_FILENAME\fP] +[\fB\-b\fP\ \fIBANK_URL\fP\ |\ \fB—bank\-url=\fP\fIBANK_URL\fP] +[\fB\-n\fP\ \fIHOWMANY_COINS\fP\ |\ \fB–coins\-number=\fP\fIHOWMANY_COINS\fP] +[\fB\-l\fP\ \fILOGLEVEL\fP\ |\ \fB–log\-level=\fP\fILOGLEVEL\fP] +[\fB\-h\fP\ |\ \fB–help\fP] +.SH DESCRIPTION +.sp +\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. +.INDENT 0.0 +.TP +\fB\-c\fP \fICONFIG_FILENAME\fP | \fB–config=\fP\fICONFIG_FILENAME\fP +(Mandatory) Use CONFIG_FILENAME. +.TP +\fB\-b\fP \fIBANK_URL\fP | \fB—bank\-url=\fP\fIBANK_URL\fP +(Mandatory) The URL where the fakebank listens at. Must match the +host component in the exchange’s escrow account “payto” URL. +.TP +\fB\-n\fP \fIHOWMANY_COINS\fP | \fB–coins\-number=\fP\fIHOWMANY_COINS\fP +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. +.TP +\fB\-l\fP \fILOGLEVEL\fP | \fB–log\-level=\fP\fILOGLEVEL\fP +GNUnet\-compatible log level, takes values “ERROR/WARNING/INFO/DEBUG” +.TP +\fB\-h\fP | \fB–help\fP +Prints a compiled\-in help text. +.UNINDENT +.SH SEE ALSO +.sp +taler\-exchange\-dbinit(1), taler\-exchange\-keyup(1), +taler\-exchange\-httpd(1), taler.conf(5) +.SH BUGS +.sp +Report bugs by using \fI\%https://gnunet.org/bugs/\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014, 2015, 2016 Florian Dold, Benedikt Muller, Sree Harsha Totakura, Christian Grothoff, Marcello Stanisci (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. |