commit be6ccffcd164481090f4ac151b0c316ca92e1b1a
parent f76d4421870c2392f33ba93cbb95d2d860f7f4dd
Author: Nullptrderef <nullptrderef@proton.me>
Date: Sun, 4 Aug 2024 20:59:48 +0200
add taler-mdb-ads.sh docs
Diffstat:
3 files changed, 57 insertions(+), 1 deletion(-)
diff --git a/conf.py b/conf.py
@@ -610,6 +610,13 @@ man_pages = [
1,
),
(
+ "manpages/taler-mdb-ads.sh.1",
+ "taler-mdb-ads.sh",
+ "render ads 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-ads.sh.1.rst b/manpages/taler-mdb-ads.sh.1.rst
@@ -0,0 +1,49 @@
+taler-mdb-ads.sh(1)
+###################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-mdb-ads.sh** - Taler multi-drop bus vending machine advertisement renderer
+
+
+Synopsis
+========
+
+**taler-mdb-ads.sh**
+[**-c** *FILENAME* ]
+[**-h** | **--help**]
+
+
+Description
+===========
+
+**taler-mdb-ads.sh** is a command-line tool to render ads.
+
+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.
+
+When this script is running, it will cycle through rendering the files in *$PREFIX*/share/mdb/ on *FRAMEBUFFER_DEVICE* (as defined in the config). It will render them in a random order, reshuffling them each time it loops around. It depends on *fbi* (https://www.kraxel.org/blog/linux/fbida/) to render images.
+
+Note that, as of **taler-mdb v0.10.0**, we kill all running fbi processes when cycling between images. This behaviour may change in future releases.
+
+
+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-mdb-show.sh(1), taler-mdb-network-check.sh(1), taler.conf(5).
+taler-merchant-httpd(1), taler-mdb-show.sh(1), taler-mdb-network-check.sh(1), taler-mdb-ads.sh(1), taler.conf(5).
Bugs
