[taler-docs] branch master updated: nexus config manpage

[gnunet]

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

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new b4ce9854 nexus config manpage
b4ce9854 is described below

commit b4ce985452cd0c1a3f2f01c7a3d15bb2b1c3aa19
Author: MS <ms@taler.net>
AuthorDate: Wed Nov 1 11:42:08 2023 +0100

    nexus config manpage
---
 conf.py                            |  7 +++
 libeufin/nexus-manual.rst          |  4 +-
 manpages/libeufin-nexus.1.rst      |  5 ++
 manpages/libeufin-nexus.conf.5.rst | 95 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 109 insertions(+), 2 deletions(-)

diff --git a/conf.py b/conf.py
index f6897355..fc747f0a 100644
--- a/conf.py
+++ b/conf.py
@@ -721,6 +721,13 @@ man_pages = [
         "GNU Taler contributors",
         1,
     ),
+    (
+        "manpages/libeufin-nexus.conf.5",
+        "libeufin-nexus.conf",
+        "LibEuFin Nexus configuration file",
+        "GNU Taler contributors",
+        5,
+    ),
 ]
 
 # If true, show URL addresses after external links.
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst
index 1faf725d..c027e691 100644
--- a/libeufin/nexus-manual.rst
+++ b/libeufin/nexus-manual.rst
@@ -60,8 +60,8 @@ The following snippet shows the mandatory configuration 
values.
   PARTNER_ID = myorg
 
   # Key files
-  BANK_PUBLIC_KEYS_FILE = ${LIBEUFIN_DATA_HOME}/bank-keys.json
-  CLIENT_PRIVATE_KEYS_FILE = ${LIBEUFIN_DATA_HOME}/subscriber-keys.json
+  BANK_PUBLIC_KEYS_FILE = ${LIBEUFIN_HOME}/bank-keys.json
+  CLIENT_PRIVATE_KEYS_FILE = ${LIBEUFIN_HOME}/subscriber-keys.json
 
   # Account information
   IBAN = myiban
diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
index f170353d..181b7927 100644
--- a/manpages/libeufin-nexus.1.rst
+++ b/manpages/libeufin-nexus.1.rst
@@ -92,6 +92,11 @@ Its options are as follows:
    This flag, enabled by default, causes the command to run only once without 
any long-polling behaviour.
    The configuration value FREQUENCY gets therefore ignored.
 
+SEE ALSO
+========
+
+libeufin-nexus.conf(5)
+
 Bugs
 ====
 
diff --git a/manpages/libeufin-nexus.conf.5.rst 
b/manpages/libeufin-nexus.conf.5.rst
new file mode 100644
index 00000000..d6609943
--- /dev/null
+++ b/manpages/libeufin-nexus.conf.5.rst
@@ -0,0 +1,95 @@
+taler.conf(5)
+#############
+
+.. only:: html
+
+   Name
+   ====
+
+   **taler.conf** - Taler configuration file
+
+
+Description
+===========
+
+.. include:: ../frags/common-conf-syntax.rst
+
+Files containing default values for many of the options described below
+are installed under ``$TALER_PREFIX/share/libeufin-nexus/config.d/``.
+The configuration file given with **-c** to Taler binaries
+overrides these defaults.
+
+A configuration file may include another, by using the ``@INLINE@`` directive,
+for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
+include the entirety of ``sub.conf`` at that point in ``main.conf``.
+
+Be extra careful when using ``taler-config -V VALUE`` to change configuration
+values: it will destroy all uses of ``@INLINE@`` and furthermore remove all
+comments from the configuration file!
+
+
+GLOBAL OPTIONS
+--------------
+
+The following options are from the “[nexus-ebics]” section and used by
+the ``libeufin-nexus ebics-setup`` command.
+
+
+CURRENCY
+  Name of the currency, e.g. “EUR” for Euro.
+
+HOST_BASE_URL = http://bank.example.com/
+  URL of the EBICS server
+
+BANK_DIALECT
+  Name of the following combination: EBICS version and ISO20022 recommendations
+  that Nexus would honor in the communication with the bank.  Currently only 
the
+  'postfinance' value is supported.
+
+HOST_ID
+  EBICS specific: name of the EBICS host
+
+USER_ID
+  EBICS specific: user ID of the EBICS subscriber.  This value must be assigned
+  by the bank after having activated a new EBICS subscriber.
+
+PARTNER_ID
+  EBICS specific: partner ID of the EBICS subscriber.  This value must be 
assigned
+  by the bank after having activated a new EBICS subscriber.
+
+
+BANK_PUBLIC_KEYS_FILE
+  Filesystem location where Nexus should store the bank public keys.
+  
+CLIENT_PRIVATE_KEYS_FILE
+  Filesystem location where Nexus should store the subscriber private keys.
+
+IBAN
+  IBAN of the bank account that is associated with the EBICS subscriber.
+
+BIC
+  BIC of the bank account that is associated with the EBICS subscriber.
+
+NAME
+  Legal entity that is associated with the EBICS subscriber.
+
+
+The “[PATHS]” section is special in that it contains paths that can be
+referenced using “$” in other configuration values that specify
+filenames. For Taler, it commonly contains the following paths:
+
+LIBEUFIN_HOME
+  Home directory of the user, usually “${HOME}”. Can be overwritten by
+  testcases by setting ${LIBEUFIN_TEST_HOME}.
+
+
+SEE ALSO
+========
+
+libeufin-nexus(1)
+
+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.