summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-07-16 15:55:36 +0200
committerChristian Grothoff <christian@grothoff.org>2023-07-16 15:55:36 +0200
commit7d58b8a3792831ac64b00687a013b39e167575e8 (patch)
tree2e6288775e6e8442ed85ba29b3355e53ded56c1d
parent3adad886c5f38a9855cbe079cd89b17ca3142374 (diff)
downloaddocs-7d58b8a3792831ac64b00687a013b39e167575e8.tar.gz
docs-7d58b8a3792831ac64b00687a013b39e167575e8.tar.bz2
docs-7d58b8a3792831ac64b00687a013b39e167575e8.zip
-new man page
-rw-r--r--conf.py7
-rw-r--r--manpages/taler-aggregator-benchmark.1.rst72
-rw-r--r--taler-developer-manual.rst19
3 files changed, 89 insertions, 9 deletions
diff --git a/conf.py b/conf.py
index 63203313..2e9a692b 100644
--- a/conf.py
+++ b/conf.py
@@ -477,6 +477,13 @@ man_pages = [
1,
),
(
+ "manpages/taler-aggregator-benchmark.1",
+ "taler-aggregator-benchmark",
+ "generate database to measure aggregator performance",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
"manpages/taler-exchange-dbinit.1",
"taler-exchange-dbinit",
"initialize Taler exchange database",
diff --git a/manpages/taler-aggregator-benchmark.1.rst b/manpages/taler-aggregator-benchmark.1.rst
new file mode 100644
index 00000000..b9e5bce6
--- /dev/null
+++ b/manpages/taler-aggregator-benchmark.1.rst
@@ -0,0 +1,72 @@
+taler-aggregator-benchmark(1)
+#############################
+
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-aggregator-benchmark** - setup database to measure aggregator performance
+
+
+Synopsis
+========
+
+**taler-aggregator-benchmark**
+[**-c** *CONFIG_FILENAME* | **--config=**\ ‌\ *CONFIG_FILENAME*]
+[**-d** *DN* | **--deposits=**\ \ *DN*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--log-level=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
+[**-m** *DM* | **--merchants=**\ ‌\ *DM*]
+[**-r** *RATE* | **--refunds=**\ \ *RATE*]
+[**-v** | **--version**]
+
+Description
+===========
+
+**taler-aggregator-benchmark** is a command-line tool to fill an exchange
+database with records suitable for benchmarking the
+**taler-exchange-aggregator**. The **taler-aggregator-benchmark** tool does
+not run the actual workload for the benchmark (which usually consists of
+starting multiple **taler-exchange-aggregator** processes) and instead only
+prepares the database with synthetic work.
+
+**-c** *CONFIG_FILENAME* \| **--config=**\ ‌\ *CONFIG_FILENAME*
+ (Mandatory) Use CONFIG_FILENAME.
+
+**-d** *DN* \| **--deposits=**\ ‌\ *DN*
+ How many deposits should be instantiated *per merchant*.
+ Defaults to 1.
+
+**-h** \| **--help**
+ Prints a compiled-in help text.
+
+**-L** *LOGLEVEL* \| **--log-level=**\ ‌\ *LOGLEVEL*
+ Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+ ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME*
+ Send logging output to *FILENAME*.
+
+**-m** *DM* \| **--merchants=**\ ‌\ *DM*
+ How many different merchants should we create. Defaults to 1.
+
+**-r** *RATE* \| **--refunds=**\ \ *RATE*
+ Probability of a deposit having a refund (as an integer between 0-100).
+
+**-v** \| **--version**
+ Print version information.
+
+See Also
+========
+
+taler-exchange-dbinit(1), taler-merchant-benchmark(1),
+taler-exchange-aggregator(1), taler-unified-setup(1), taler.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/taler-developer-manual.rst b/taler-developer-manual.rst
index d0195de3..8f470395 100644
--- a/taler-developer-manual.rst
+++ b/taler-developer-manual.rst
@@ -67,7 +67,7 @@ overview:
Android point-of-sale App and the Android casher app.
* taler-ios: iOS wallet App.
-
+
* sync: backup service, provides a simple REST API to allow users to
make encrypted backups of their wallet state.
@@ -406,10 +406,10 @@ All commands run from deployment.git/docker/demo.
# Start services.
$ docker-compose start --remove-orphans -d
-
+
# Stop services.
$ docker-compose stop
-
+
# Build base image (without tags-file builds master)
$ ./build_base.sh images/base/Dockerfile [tags-file]
@@ -898,10 +898,11 @@ This app runs on all iPhone models at least as new as the iPhone 6S.
Building
^^^^^^^^
-Before building the iOS wallet, you must first checkout the quickjs-tart repo:
- https://git.taler.net/quickjs-tart.git
-and the wallet-core repo:
- https://git.taler.net/wallet-core.git
+Before building the iOS wallet, you must first checkout the
+`quickjs-tart repo <https://git.taler.net/quickjs-tart.git>`__
+and the
+`wallet-core repo <https://git.taler.net/wallet-core.git>`__.
+
Build wallet-core first, then copy/move its product "taler-wallet-core-qjs.mjs"
into your quickjs-tart folder right at the top level.
@@ -913,8 +914,8 @@ Taler.xcworkspace.
Have all 3 local repos (wallet-core, quickjs-tart, and this one) adjacent at
the same level (e.g. in a "GNU Taler" folder).
-Taler.xcworkspace expects the QuickJS framework sub-project to be at:
- ../quickjs-tart/QuickJS-rt.xcodeproj
+Taler.xcworkspace expects the QuickJS framework sub-project to be at
+``../quickjs-tart/QuickJS-rt.xcodeproj``.
Android Apps