commit 0958452fda58fc0cb52417cc749cc5a9ba00f1b5
parent a262d2990eeefd377f4d8d536f6804283f5af764
Author: Nullptrderef <nullptrderef@proton.me>
Date: Sun, 4 Aug 2024 20:41:53 +0200
add taler-mdb-show and taler-mdb-net-chk docs
Diffstat:
4 files changed, 133 insertions(+), 1 deletion(-)
diff --git a/conf.py b/conf.py
@@ -596,6 +596,20 @@ man_pages = [
1,
),
(
+ "manpages/taler-mdb-show.sh.1",
+ "taler-mdb-show.sh",
+ "render informational status images on vending machines' displays",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-mdb-network-check.sh.1",
+ "taler-mdb-network-check.sh",
+ "handle network checks on vending machines",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
"manpages/taler-merchant-dbinit.1",
"taler-merchant-dbinit",
"initialize Taler merchant database",
diff --git a/manpages/taler-mdb-network-check.sh.1.rst b/manpages/taler-mdb-network-check.sh.1.rst
@@ -0,0 +1,70 @@
+taler-mdb-network-check.sh(1)
+#############################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-mdb-network-check.sh** - Taler multi-drop bus vending machine network check tool
+
+
+Synopsis
+========
+
+**taler-mdb-network-check.sh**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[*ERRORCODE*]
+
+
+Description
+===========
+
+**taler-mdb-network-check.sh** is a command-line tool to call a program when the network goes down.
+It depends on **dig**.
+
+Its options are as follows:
+
+**-c** *FILENAME*
+ Use the configuration and other resources for the command to operate from *FILENAME*.
+
+**-f** *FILENAME*
+ Overwrites the Taler config's *FAIL_HELPER* value. See taler.conf(5)
+
+**-h**
+ Print short help on options.
+
+
+When the network goes down, it will call *FAIL_HELPER* with one of the following arguments - note that we check in the order these are listed:
+
+**no-ip**
+ Network Down: Could not reach the DNS Server. (DNS Server is first **nameserver** entry in **/etc/resolv.conf**)
+
+**backend-dns-resolution-failure**
+ Name Resolution Failed: Could not resolve the Taler backend hostname. Check DNS. (**dig** picks it's own nameservers; we don't force it to use the one we pinged)
+
+**backend-unreachable**
+ Backend Unreachable: Could not reach payment backend.
+
+**backend-no-webserver**
+ Backend No Webserver: We cannot find a webserver on a backend. Ensure requests are properly routing to it. (X509 certificate is not checked against here)
+
+**backend-x509-cert-bad**
+ Bad Certificate: The Taler backend gave us a bad certificate. Check X509.
+
+**backend-auth-failure**
+ Backend Auth Failure: Taler credentials are invalid. Check machine configuration.
+
+
+See Also
+========
+
+taler-mdb(1), taler-mdb-show.sh(1), taler.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler-mdb-show.sh.1.rst b/manpages/taler-mdb-show.sh.1.rst
@@ -0,0 +1,48 @@
+taler-mdb-show.sh(1)
+####################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-mdb-show.sh** - Taler multi-drop bus vending machine display status renderer
+
+
+Synopsis
+========
+
+**taler-mdb-show.sh**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[*ERRORCODE*]
+
+
+Description
+===========
+
+**taler-mdb-show.sh** is a command-line tool to render errors.
+
+Its options are as follows:
+
+**-c** *FILENAME*
+ Use the configuration and other resources for the command
+ to operate from *FILENAME*.
+
+**-h**
+ Print short help on options.
+
+To render an error, call **taler-mdb-show.sh** with an error code.
+The error code should be the filename of one of the files in *$PREFIX*/share/mdb/.
+
+See Also
+========
+
+taler-mdb(1), taler.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler-mdb.1.rst b/manpages/taler-mdb.1.rst
@@ -63,7 +63,7 @@ Its options are as follows:
See Also
========
-taler-merchant-httpd(1), taler.conf(5).
+taler-merchant-httpd(1), taler-mdb-show.sh(1), taler-mdb-network-check.sh(1), taler.conf(5).
Bugs
