commit 35066af0673ba833921215a4935d88aa8a872ac4
parent 2bd9fd051384d842a5215c93feaa69ec12ffe1b2
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 16 Apr 2023 16:51:55 +0200
add man pages for challenger
Diffstat:
5 files changed, 327 insertions(+), 0 deletions(-)
diff --git a/conf.py b/conf.py
@@ -307,6 +307,34 @@ latex_appendices = ["fdl-1.3"]
# (source start file, name, description, authors, manual section).
man_pages = [
(
+ "manpages/challenger-config.1",
+ "challenger-config",
+ "manipulate Challenger configuration files",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/challenger-dbinit.1",
+ "challenger-dbinit",
+ "initialize the Challenger database",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/challenger-httpd.1",
+ "challenger-httpd",
+ "provide the Challenger HTTP interface",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/challenger.conf.5",
+ "challenger.conf",
+ "Challenger configuration file",
+ "GNU Taler contributors",
+ 5,
+ ),
+ (
"manpages/sync-config.1",
"sync-config",
"manipulate Sync configuration files",
diff --git a/manpages/challenger-config.1.rst b/manpages/challenger-config.1.rst
@@ -0,0 +1,101 @@
+challenger-config(1)
+####################
+
+.. only:: html
+
+ Name
+ ====
+
+ **challenger-config** - manipulate Challenger configuration file
+
+Synopsis
+========
+
+**challenger-config**
+[**-b** *backend* | **--supported-backend=**\ \ *backend*]
+[**-c** *filename* | **--config=**\ \ *filename*]
+[**-f** | **--filename**]
+[**-F** | **--full**]
+[**-h** | **--help**]
+[**-L** *loglevel* | **--loglevel=**\ \ *loglevel*]
+[**-l** *filename* | **--logfile=**\ \ *filename*]
+[**-o** *option* | **--option=**\ \ *option*]
+[**-r** | **--rewrite**]
+[**-S** | **--list-sections**]
+[**-s** *section* | **--section=**\ \ *section*]
+[**-V** *value* | **--value=**\ \ *value*]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**challenger-config** can be used to read or modify Challenger configuration files.
+
+**-b** *BACKEND* \| **--supported-backend=**\ \ *BACKEND*
+ Tests whether the specified *BACKEND* is supported by the current installation.
+ The backend must match the name of a plugin, i.e. "namestore_postgres" for
+ the PostgreSQL database backend of the "NAMESTORE" service. If *BACKEND* is
+ supported, challenger-config will return a status code of 0 (success), otherwise
+ 77 (unsupported). When this option is specified, no other options may be
+ specified. Specifying this option together with other options will cause
+ challenger-config to return a status code of 1 (error).
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration file *FILENAME*.
+
+**-f** \| **--filename**
+ Try to perform expansions as if the option values represent filenames (will
+ also be applied even if the option is not really a filename).
+
+**-F** \| **--full**
+ Write the full configuration file, not just the differences to the defaults.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **--loglevel=**\ \ *LOGLEVEL*
+ Use *LOGLEVEL* for logging.
+ Valid values are ``DEBUG``, ``INFO``, ``WARNING``, and ``ERROR``.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+ Send logging output to *FILENAME*.
+
+**-o** *OPTION* \| **--option=**\ \ *OPTION*
+ Which configuration option should be accessed or edited. Required to set a
+ value. If not given, all values of a given section will be printed in the
+ format "OPTION = VALUE".
+
+**-r** \| **--rewrite**
+ Write the configuration file even if nothing changed. Will remove all comments!
+
+**-S** \| **--list-sections**
+ List available configuration sections for use with ``--section``.
+
+**-s** *SECTION* \| **--section=**\ \ *SECTION*
+ Which configuration section should be accessed or edited.
+ Required option.
+
+**-V** *VALUE* \| **--value=**\ \ *VALUE*
+ Configuration value to store in the given section under the given option.
+ Must only be given together with ``-s`` and ``-o`` options.
+
+ Note:
+ Changing the configuration file with ``-V`` will remove comments
+ and may reorder sections and remove ``@INLINE@`` directives.
+
+**-v** \| **--version**
+ Print GNU Taler version number.
+
+
+See Also
+========
+
+challenger-dbinit(1), challenger-httpd(1), challenger.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/challenger-dbinit.1.rst b/manpages/challenger-dbinit.1.rst
@@ -0,0 +1,65 @@
+challenger-dbinit(1)
+##############
+
+.. only:: html
+
+ Name
+ ====
+
+ **challenger-dbinit** - initialize the Challenger database
+
+
+Synopsis
+========
+
+**challenger-dbinit**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-g** | **--garbagecollect**]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-r** | **--reset**]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**challenger-dbinit** is a command-line tool to initialize the Challenger database.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the Challenger commands
+ to operate from *FILENAME*.
+
+**-g** \| **--garbagecollect**
+ Remove state data from database.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **--log=**\ \ *LOGLEVEL*
+ Configure logging to use *LOGLEVEL*.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+ Configure logging to write logs to *FILENAME*.
+
+**-r** \| **--reset**
+ Reset database. (**DANGEROUS**: All existing data is lost!)
+
+**-v** \| **–version**
+ Print version information.
+
+
+See Also
+========
+
+challenger-config(1), challenger-httpd(1), challenger.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/challenger-httpd.1.rst b/manpages/challenger-httpd.1.rst
@@ -0,0 +1,61 @@
+challenger-httpd(1)
+###################
+
+.. only:: html
+
+ Name
+ ====
+
+ **challenger-httpd** - provide the Challenger HTTP interface
+
+
+Synopsis
+========
+
+**challenger-httpd**
+[**-C** | **--connection-close**]
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**challenger-httpd** is a command-line tool to provide the Challenger HTTP interface.
+
+Its options are as follows:
+
+**-C** \| **--connection-close**
+ Force HTTP connections to be closed after each request.
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the Challenger commands
+ to operate from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **--log=**\ \ *LOGLEVEL*
+ Configure logging to use *LOGLEVEL*.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+ Configure logging to write logs to *FILENAME*.
+
+**-v** \| **–version**
+ Print version information.
+
+
+See Also
+========
+
+challenger-config(1), challenger-dbinit(1), challenger.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/challenger.conf.5.rst b/manpages/challenger.conf.5.rst
@@ -0,0 +1,72 @@
+challenger.conf(5)
+##################
+
+.. only:: html
+
+ Name
+ ====
+
+ **challenger.conf** - Challenger configuration file
+
+
+Description
+===========
+
+.. include:: ../frags/common-conf-syntax.rst
+
+Files containing default values for many of the options described below
+are installed under ``$PREFIX/share/challenger/config.d/``.
+The configuration file given with **-c** to Challenger 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``.
+
+Be extra careful when using ``challenger-config -V VALUE`` to change configuration
+values: it will destroy all uses of ``@INLINE@`` and furthermore remove all
+comments from the configuration file!
+
+
+GLOBAL OPTIONS
+--------------
+
+The following options are from the “[challenger]” section.
+This is normally the only section in a challenger.conf file.
+
+SERVE
+ This can either be ``tcp`` or ``unix``.
+
+PORT
+ Port on which the HTTP server listens, e.g. 9967.
+ Only used if ``SERVE`` is ``tcp``.
+
+BIND_TO
+ Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1``
+ for loopback. Can also be given as a hostname. We will bind to
+ the wildcard (dual-stack) if left empty.
+ Only used if ``SERVE`` is ``tcp``.
+
+UNIXPATH
+ Which unix domain path should we bind to?
+ Only used if ``SERVE`` is ``unix``.
+
+UNIXPATH_MODE = 660
+ What should be the file access permissions for ``UNIXPATH``?
+ Only used if ``SERVE`` is ``unix``.
+
+DB
+ Plugin to use for the database, e.g. “postgres”.
+
+
+SEE ALSO
+========
+
+challenger-dbinit(1), challenger-httpd(1), challenger-config(1).
+
+
+BUGS
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
