gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated: -update man pages


From: gnunet
Subject: [taler-docs] branch master updated: -update man pages
Date: Sat, 15 Jul 2023 19:07:39 +0200

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new ab4dba33 -update man pages
ab4dba33 is described below

commit ab4dba339489fb401ae781d30fe1dfabcbbb9245
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Sat Jul 15 18:52:20 2023 +0200

    -update man pages
---
 conf.py                                 |   7 +++
 manpages/taler-exchange-benchmark.1.rst |  23 +++----
 manpages/taler-unified-setup.1.rst      | 103 ++++++++++++++++++++++++++++++++
 3 files changed, 118 insertions(+), 15 deletions(-)

diff --git a/conf.py b/conf.py
index a69ffd2c..63203313 100644
--- a/conf.py
+++ b/conf.py
@@ -462,6 +462,13 @@ man_pages = [
         "GNU Taler contributors",
         1,
     ),
+    (
+        "manpages/taler-unified-setup.1",
+        "taler-unified-setup",
+        "conveniently start and stop various GNU Taler services",
+        "GNU Taler contributors",
+        1,
+    ),
     (
         "manpages/taler-exchange-benchmark.1",
         "taler-exchange-benchmark",
diff --git a/manpages/taler-exchange-benchmark.1.rst 
b/manpages/taler-exchange-benchmark.1.rst
index bcbcb3c1..1c5441d6 100644
--- a/manpages/taler-exchange-benchmark.1.rst
+++ b/manpages/taler-exchange-benchmark.1.rst
@@ -21,7 +21,6 @@ Synopsis
 [**-K** | **--linger**]
 [**-L** *LOGLEVEL* | **--log-level=**\ ‌\ *LOGLEVEL*]
 [**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
-[**-m** *MODE* | **--mode=**\ \ *MODE*]
 [**-n** *HOWMANY_COINS* | **--coins-number=**\ ‌\ *HOWMANY_COINS*]
 [**-p** *NPROCS* | **--parallelism=**\ \ *NPROCS*]
 [**-R** *RATE* | **--refresh-rate=**\ \ *RATE*]
@@ -32,11 +31,8 @@ Description
 ===========
 
 **taler-exchange-benchmark** 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.
+spent to serve withdrawals/deposits/refreshes.  Before running the benchmark,
+the GNU Taler services must already be running at the configured addresses.
 
 **-c** *CONFIG_FILENAME* \| **--config=**\ ‌\ *CONFIG_FILENAME*
    (Mandatory) Use CONFIG_FILENAME.
@@ -45,11 +41,7 @@ that table are always erased during a single benchmark run.
    Create all reserves first, before starting normal operations.
 
 **-f** \| **--fakebank**
-   Launch a fakebank instead of the Python bank. Only meaningful if the
-   mode is to launch more than just a client.  Note that using the
-   fakebank will cause the benchmark application to reset all databases
-   as the fakebank is stateless and thus previous database state would
-   inherently cause trouble.
+   Expect to interact with a fakebank instead of libeufin.
 
 **-h** \| **--help**
    Prints a compiled-in help text.
@@ -64,9 +56,6 @@ that table are always erased during a single benchmark run.
 **-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME*
    Send logging output to *FILENAME*.
 
-**-m** *MODE* \| **--mode=**\ \ *MODE*
-   Mode of operation. Accepted values are: ``exchange``, ``clients``, ``both``.
-
 **-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
@@ -81,6 +70,10 @@ that table are always erased during a single benchmark run.
 **-r** *N* \| **--reserves=**\ \ *N*
    Create *N* reserves per client.
 
+**-u** *SECTION* \| **--exchange-account-section=**\ \ *SECTION*
+   Which configuration section should be used for the bank account
+   of the exchange.
+
 **-v** \| **--version**
    Print version information.
 
@@ -88,7 +81,7 @@ See Also
 ========
 
 taler-exchange-dbinit(1), taler-exchange-offline(1), 
taler-merchant-benchmark(1),
-taler-exchange-httpd(1), taler.conf(5)
+taler-exchange-httpd(1), taler-unified-setup(1), taler.conf(5)
 
 Bugs
 ====
diff --git a/manpages/taler-unified-setup.1.rst 
b/manpages/taler-unified-setup.1.rst
new file mode 100644
index 00000000..52e3eee1
--- /dev/null
+++ b/manpages/taler-unified-setup.1.rst
@@ -0,0 +1,103 @@
+taler-unified-setup.sh(1)
+#########################
+
+
+.. only:: html
+
+   Name
+   ====
+
+   **taler-unified-setup.sh** - conveniently launch GNU Taler services
+
+
+Synopsis
+========
+
+**taler-unified-setup**
+[**-a**]
+[**-b**]
+[**-c** *CONFIG_FILENAME*]
+[**-d** *METHOD*]
+[**-e**]
+[**-f**]
+[**-h**]
+[**-l** *FILENAME*]
+[**-m**]
+[**-n**]
+[**-r** *MEX*]
+[**-s**]
+[**-t**]
+[**-u** *SECTION*]
+[**-v**]
+[**-w**]
+
+
+Description
+===========
+
+**taler-unified-setup** is a command-line tool to launch and stop
+GNU Taler services in bulk. It is usually used in test cases or
+for development. For production, services should be launched via
+systemd and not via this tool.
+
+**-a**
+   Start auditor
+
+**-b**
+   Start backup/sync service
+
+**-c** *CONFIG_FILENAME*
+   (Mandatory) Use CONFIG_FILENAME.
+
+**-d** *METHOD*
+   use the given wire method. Default is 'x-taler-bank'.
+
+**-e**
+   Start exchange
+
+**-f**
+   Start fakebank
+
+**-h** \| **--help**
+   Prints a compiled-in help text.
+
+**-L** *LOGLEVEL*
+   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+   ``WARNING``, ``ERROR``.
+
+**-m**
+   Start merchant
+
+**-n**
+   Start libeufin nexus
+
+**-r** *MEX*
+   Which exchange to use at the merchant
+
+**-s**
+   Start libeufin sandbox
+
+**-t**
+   Start taler-exchange-transfer
+
+**-u** *SECTION*
+   Specifies configuration section with the exchange account to use
+
+**-v**
+   Use valgrind
+
+**-w**
+   Start taler-exchange-wirewatch
+
+
+See Also
+========
+
+taler-exchange-dbinit(1), taler-exchange-offline(1), 
taler-merchant-benchmark(1),
+taler-exchange-httpd(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>.

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]