taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit 32d417635a2011cc5b3f398f2f855ff45a26f8f6
parent a7c0cb222a6d78bf773852b88b0318e4ab830ed0
Author: Antoine A <>
Date:   Tue, 12 Dec 2023 17:20:31 +0000

Improve libeufin manpages

Diffstat:
Afrags/libeufin-config-cli.rst | 46++++++++++++++++++++++++++++++++++++++++++++++
Mmanpages/libeufin-bank.1.rst | 4+---
Mmanpages/libeufin-nexus.1.rst | 4+++-
3 files changed, 50 insertions(+), 4 deletions(-)

diff --git a/frags/libeufin-config-cli.rst b/frags/libeufin-config-cli.rst @@ -0,0 +1,45 @@ +config +------ + +This command inspect or change the configuration. + +**-h** \| **--help** + Print short help on options. + +Subcommands: **get**, **dump**, **pathsub** + +config get +----------- + +This command lookup config value. + +It takes two arguments, the section name and the option name + +**-h** \| **--help** + Print short help on options. +**-c** \| **--config** *FILENAME* + Specifies the configuration file. +**-f** \| **--filename** + Interpret value as path with dollar-expansion. + +config dump +----------- + +This command dump the configuration. + +**-h** \| **--help** + Print short help on options. +**-c** \| **--config** *FILENAME* + Specifies the configuration file. + +config pathsub +-------------- + +This command substitute variables in a path. + +It takes one argument, a path expresion. + +**-h** \| **--help** + Print short help on options. +**-c** \| **--config** *FILENAME* + Specifies the configuration file. +\ No newline at end of file diff --git a/manpages/libeufin-bank.1.rst b/manpages/libeufin-bank.1.rst @@ -146,10 +146,8 @@ Its options are as follows: **-c** \| **--config** *FILENAME* Specifies the configuration file. -config ------- +.. include:: ../frags/libeufin-config-cli.rst -TODO SEE ALSO ======== diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst @@ -17,7 +17,7 @@ Synopsis [**--version**] COMMAND [ARGS...] -Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch** +Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch**, **config** Description @@ -121,6 +121,8 @@ This subcommand downloads banking records via EBICS and stores them into the dat **--import** Reads one ISO20022 document from STDIN. It prints the result on the console **and** also ingests the input content into the database. NOTE: if used in a debug scenario, consider to destroy the database before going to production for the following reasons; (1) the database likely ends up having phony transactions that do not belong to the bank account associated with the EBICS subscriber, and (2) whose timestamps will alter the way ebics-fetch will request new records to the bank. (3) This flags skips the check on the bank keys, so the database could receive records even though hte bank keys were not accepted / downloaded. +.. include:: ../frags/libeufin-config-cli.rst + SEE ALSO ========