commit b197775b61dfeec8d469cd8d1816bdccf6baa2fc
parent 870ab01032c56222225e80ea7861e911b4fc0048
Author: Antoine A <>
Date: Fri, 5 Dec 2025 17:20:56 +0100
ebisync: add man pages
Diffstat:
2 files changed, 226 insertions(+), 0 deletions(-)
diff --git a/manpages/libeufin-ebisync.1.rst b/manpages/libeufin-ebisync.1.rst
@@ -0,0 +1,120 @@
+libeufin-ebisync(1)
+#################
+
+.. only:: html
+
+ Name
+ ====
+
+ **libeufin-ebisync** - EBICS synchronization client.
+
+
+Synopsis
+========
+
+**libeufin-ebisync**
+[**-h** | **--help**]
+[**--version**]
+COMMAND [ARGS...]
+
+Subcommands: **dbinit**, **setup**, **fetch**, **config**
+
+
+Description
+===========
+
+**libeufin-ebisync** is a program that provides a service to synchronize ISO20022 files through the EBICS protocol
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+
+**–version**
+ Print version information.
+
+The interaction model is as follows:
+
+- Configure the database with commands ``dbinit``.
+
+- Setup EBICS access with commands ``setup``. Setting the access means to share the client keys with the bank and downloading the bank keys
+
+- After a successful setup, the subcommand ``fetch`` can be run to respectively download files.
+
+The following sections describe each command in detail.
+
+dbinit
+------
+
+This command defines the database schema for LibEuFin EbiSync. It is mandatory to run this command before invoking the ``setup`` command.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ Reset database (DANGEROUS: All existing data is lost)
+**-h** \| **--help**
+ Print short help on options.
+
+setup
+-----
+
+This command creates the client keys, if they aren't found already on the disk, and sends them to the bank if they were not sent yet. In case of sending, it ejects the PDF document that contains the keys fingerprints, so that the user can send it to the bank to confirm their keys. The process continues by checking if the bank keys exist already on disk, and proceeds with downloading them in case they are not. It checks then if the bank keys were accepted by the user; if yes, the setup terminates, otherwise it interactively asks the user to mark the keys as accepted. By accepting the bank keys, the setup terminates successfully.
+
+It is mandatory to run this command before invoking the ``fetch`` command.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--force-keys-resubmission**
+ Resubmits all the keys to the bank.
+**--auto-accept-keys**
+ Accepts the bank keys without interactively asking the user.
+**--generate-registration-pdf**
+ Generates the PDF with the client keys fingerprints, if the keys have the submitted state. That's useful in case the PDF went lost after the first submission and the user needs a new PDF.
+**--debug-ebics**
+ Log EBICS transactions steps and payload at log_dir.
+**-h** \| **--help**
+ Print short help on options.
+
+ebics-fetch
+-----------
+
+This subcommand fetches ISO20022 files from the bank and store them at a configured destination.
+
+Fetches of new documents are executed at 'FREQUENCY' or any time a real-time EBICS notification is received. Every day, a checkpoint is performed, during which all documents since the last checkpoint are fetched.
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--transient**
+ Execute once and return, ignoring the 'FREQUENCY' configuration value.
+**--pinned-start** *YYYY-MM-DD*
+ Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents.
+**--peek**
+ Only supported in --transient mode, do not consume fetched documents.
+**--checkpoint**
+ Only supported in --transient mode, run a checkpoint.
+**--debug-ebics** *log_dir*
+ Log EBICS transactions steps and payload at log_dir.
+**-h** \| **--help**
+ Print short help on options.
+
+.. include:: ../frags/common-config-cli.rst
+
+SEE ALSO
+========
+
+libeufin-ebisync.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.
diff --git a/manpages/libeufin-ebisync.conf.5.rst b/manpages/libeufin-ebisync.conf.5.rst
@@ -0,0 +1,106 @@
+libeufin-ebisync.conf(5)
+########################
+
+.. only:: html
+
+ Name
+ ====
+
+ **libeufin-ebisync.conf** - LibEuFin EbiSync configuration file
+
+
+Description
+===========
+
+.. include:: ../frags/common-conf-syntax.rst
+
+Files containing default values for many of the options described below
+are installed under ``$LIBEUFIN_EBISYNC_PREFIX/share/libeufin-ebisync/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``.
+
+
+GLOBAL OPTIONS
+--------------
+
+The following options are from the “[ebisync]” section.
+
+HOST_BASE_URL
+ URL of the EBICS server
+
+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 EbiSync should store the bank public keys.
+
+CLIENT_PRIVATE_KEYS_FILE
+ Filesystem location where EbiSync should store the subscriber private keys.
+
+SETUP OPTIONS
+-------------
+
+The following configuration value(s) belong to the “[ebisync-setup]” section.
+
+BANK_ENCRYPTION_PUB_KEY_HASH
+ Bank encryption public key hash.
+
+BANK_AUTHENTICATION_PUB_KEY_HASH
+ Bank authentication public key hash.
+
+FETCH OPTIONS
+-------------
+
+The following configuration value(s) belong to the “[ebisync-fetch]” section.
+
+FREQUENCY
+ Duration value to instruct the ``fetch`` subcommand how often it should
+ download from the bank.
+
+CHECKPOINT_TIME_OF_DAY
+ At what time HH:MM of day should ``fetch`` perform a checkpoint.
+
+DESTINATION
+ Where should the ebics file be stored? This can only be azure-blob-storage.
+
+AZURE_API_URL
+ Azure API account base url
+
+AZURE_ACCOUNT_NAME
+ Azure API account name
+
+AZURE_ACCOUNT_KEY
+ Azure API account key
+
+AZURE_COUNTAINER
+ Which Azure Blob Storage container to use
+
+DATABASE OPTIONS
+----------------
+
+Setting the database belongs to the “[ebisyncdb-postgres]” section and the following value.
+
+.. include:: frags/common-db-options.rs
+
+SEE ALSO
+========
+
+libeufin-ebisync(1)
+
+BUGS
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
