commit 2c272e1722539565b8041d8ad4fc313391c11c9d
parent 2998c5664532695d0591b25bf5b674ad22571458
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 4 Aug 2024 21:06:48 +0200
minor improvements to man pages
Diffstat:
3 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/manpages/taler-mdb-ads.sh.1.rst b/manpages/taler-mdb-ads.sh.1.rst
@@ -13,14 +13,14 @@ Synopsis
========
**taler-mdb-ads.sh**
-[**-c** *FILENAME* ]
-[**-h** | **--help**]
+[**-c** *FILENAME*]
+[**-h**]
Description
===========
-**taler-mdb-ads.sh** is a command-line tool to render ads.
+**taler-mdb-ads.sh** is a command-line tool to render advertisements.
Its options are as follows:
@@ -31,9 +31,9 @@ Its options are as follows:
**-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.
+When this script is running, it will cycle through rendering the files in *$PREFIX*/share/taler/ads/ on *FRAMEBUFFER_DEVICE* (as defined in the configuration file). It will render them in a random order, reshuffling them each time it loops around. It depends on the *fbi* tool (https://www.kraxel.org/blog/linux/fbida/) to render images on the framebuffer.
-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.
+Note that, as of **taler-mdb v0.10.0**, we kill all (via *killall*) running fbi processes when cycling between images, not just the ones we started. This behaviour may change in future releases.
See Also
diff --git a/manpages/taler-mdb-network-check.sh.1.rst b/manpages/taler-mdb-network-check.sh.1.rst
@@ -13,9 +13,9 @@ Synopsis
========
**taler-mdb-network-check.sh**
-[**-c** *FILENAME* ]
-[**-f** *FAIL_HELPER* ]
-[**-h** | **--help**]
+[**-c** *FILENAME*]
+[**-f** *FAIL_HELPER*]
+[**-h**]
[**--**]
[*PROGRAM*]
diff --git a/manpages/taler-mdb-show.sh.1.rst b/manpages/taler-mdb-show.sh.1.rst
@@ -13,8 +13,8 @@ Synopsis
========
**taler-mdb-show.sh**
-[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
-[**-h** | **--help**]
+[**-c** *FILENAME*]
+[**-h**]
[*ERRORCODE*]
@@ -33,7 +33,8 @@ Its options are as follows:
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/.
+The error code should be the filename of one of the files in "*$PREFIX*/share/taler/mdb/"
+but without the ".png" extension.
See Also
========