[taler-docs] branch master updated (5c1cfafd -> 85f086cd)

[gnunet]

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

ms pushed a change to branch master
in repository docs.

    from 5c1cfafd Improve corebank and conversion API
     new e4424812 indentation
     new 85f086cd libeufin-nexus.conf manpage

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 manpages/libeufin-nexus.conf.5.rst | 86 ++++++++++++++++++++++++++++++--------
 1 file changed, 68 insertions(+), 18 deletions(-)

diff --git a/manpages/libeufin-nexus.conf.5.rst 
b/manpages/libeufin-nexus.conf.5.rst
index 8ec5527a..59863a0c 100644
--- a/manpages/libeufin-nexus.conf.5.rst
+++ b/manpages/libeufin-nexus.conf.5.rst
@@ -12,7 +12,63 @@ taler.conf(5)
 Description
 ===========
 
-.. include:: ../frags/common-conf-syntax.rst
+The configuration file is line-oriented.  Blank lines and whitespace at the
+beginning and end of a line are ignored.  Comments start with ``#`` or ``%``
+in the first column (after any beginning-of-line whitespace) and go to the end
+of the line.
+
+The file is split into sections.  Every section begins with ``[SECTIONNAME]``
+and contains a number of options of the form ``OPTION=VALUE``.  There may be
+whitespace around the ``=`` (equal sign).  Section names and options are
+*case-insensitive*.
+
+The values, however, are *case-sensitive*.  In particular, boolean values are
+one of ``YES`` or ``NO``.  Values can include whitespace by surrounding the
+entire value with ``"`` (double quote).  Note, however, that there are no
+escape characters in such strings; all characters between the double quotes
+(including other double quotes) are taken verbatim.
+
+Durations must be expressed with a number followed by the time unit.  The 
following
+time units are supported: 's' (seconds), 'm' (minutes), 'h' (hours).  For 
example,
+the value *5m* denotes a duration of *five minutes*.
+
+Values that represent filenames can begin with a ``/bin/sh``-like variable
+reference.  This can be simple, such as ``$TMPDIR/foo``, or complex, such as
+``${TMPDIR:-${TMP:-/tmp}}/foo``.  The variables are expanded either using
+key-values from the ``[PATHS]`` section (see below) or from the environment
+(``getenv()``). The values from ``[PATHS]`` take precedence over those from
+the environment.  If the variable name is found in neither ``[PATHS]`` nor the
+environment, a warning is printed and the value is left unchanged.  Variables 
(including those from the environment) are expanded recursively, so if 
``FOO=$BAR`` and ``BAR=buzz`` then the result is ``FOO=buzz``.  Recursion is 
bounded to at most 128 levels to avoid undefined behavior for mutually 
recursive expansions like if ``BAR=$FOO`` in the example above.
+
+The ``[PATHS]`` section is special in that it contains paths that can be
+referenced using ``$`` in other configuration values that specify
+*filenames*. Note that configuration options that are not specifically
+retrieved by the application as *filenames* will not see “$”-expressions
+expanded. To expand ``$``-expressions when using ``taler-config``, you must 
pass
+the ``-f`` command-line option.
+
+The system automatically pre-populates the ``[PATHS]`` section with a few 
values
+at run-time (in addition to the values that are in the actual configuration
+file and automatically overwriting those values if they are present).
+These automatically generated values refer to installation properties
+from `GNU autoconf
+<https://www.gnu.org/prep/standards/html_node/Directory-Variables.html>`_. The
+values are usually dependent on an ``INSTALL_PREFIX`` which is determined by
+the ``--prefix`` option given to configure.  The canonical values are:
+
+  * LIBEXECDIR = $INSTALL_PREFIX/taler/libexec/
+  * DOCDIR = $INSTALL_PREFIX/share/doc/taler/
+  * ICONDIR = $INSTALL_PREFIX/share/icons/
+  * LOCALEDIR = $INSTALL_PREFIX/share/locale/
+  * PREFIX = $INSTALL_PREFIX/
+  * BINDIR = $INSTALL_PREFIX/bin/
+  * LIBDIR = $INSTALL_PREFIX/lib/taler/
+  * DATADIR = $INSTALL_PREFIX/share/taler/
+
+Note that on some platforms, the given paths may differ depending
+on how the system was compiled or installed, the above are just the
+canonical locations of the various resources.  These
+automatically generated values are never written to disk.
 
 Files containing default values for many of the options described below
 are installed under ``$TALER_PREFIX/share/libeufin-nexus/config.d/``.
@@ -27,7 +83,6 @@ 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
 --------------
 
@@ -99,16 +154,13 @@ The following configuration value(s) belong to the 
“[nexus-submit]” section.
 
 FREQUENCY
   Duration value to instruct the ``ebics-submit`` subcommand how much to wait
-  before checking the database again to find new unsubmitted payments.  The 
duration
-  must be expressed with a number followed by the time unit.  The following 
time
-  units are supported: 's' (seconds), 'm' (minutes), 'h' (hours).  For example,
-  the value *5m* causes retries to be run every five minutes.
+  before checking the database again to find new unsubmitted payments.
 
 SUBMISSIONS_LOG_DIRECTORY
-  Optional value to define the path where the pain.001 documents would be 
stored
-  after a submission.  This directory would contain several directories, each 
named
-  after the YYYY-MM-DD format.  The pain.001 file would then be named in the 
following
-  schema: 
``$submissionTimestampMicroseconds_requestUid_$requestUid_pain.001.xml``.
+  Optional value to define the path where the pain.001 documents gets stored 
*before*
+  being submitted to the bank.  This directory would contain several 
directories,
+  each named after the YYYY-MM-DD format.  The pain.001 file would then be 
named in
+  the following schema: 
``$submissionTimestampMicroseconds_requestUid_$requestUid_pain.001.xml``.
   ``$requestUid`` is the same value that constitutes the pain.001 ``MsgIg`` 
element.
   In the event that one log file would be overridden, ``ebics-submit`` fails 
without
   overriding it.
@@ -121,17 +173,15 @@ The following configuration value(s) belong to the 
“[nexus-fetch]” section.
 
 FREQUENCY
   Duration value to instruct the ``ebics-fetch`` subcommand how often it should
-  download from the bank.  The duration must be expressed with a number 
followed
-  by the time unit.  The following time units are supported: 's' (seconds), 'm'
-  (minutes), 'h' (hours).  For example, the value *5m* causes downloads to be 
run
-  every five minutes.
+  download from the bank.
 
 STATEMENT_LOG_DIRECTORY
   Optional value to define the path where the downloaded documents would be 
stored
-  This directory would contain several directories, each named after the 
YYYY-MM-DD
-  format.  The stored files would then be named in the following schema:
-  ``$downloadTimestampMicroseconds_$filenameAsGivenByTheBank``.  In the event 
that
-  one log file would be overridden, ``ebics-fetch`` fails without overriding 
it.
+  *before* being ingested in the database.  This directory would contain 
several
+  directories, each named after the YYYY-MM-DD format.  The stored files would 
then
+  be named after the following schema:
+  ``$downloadTimestampMicroseconds_$filenameAsGivenByTheBank``.  In case one 
log file
+  would be overridden, ``ebics-fetch`` fails without overriding it.
   Exception to this naming scheme are the HAC responses, since they do not get 
any
   filename assigned by the ZIP archive (they are sent unzipped).  Their naming 
scheme
   is: ``$downloadTimestampMicroseconds_HAC_response.pain.002.xml``

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