commit ec5b3b16426edcd0734db9e11104191048ad59ce
parent 158d84f09493843f8fbb009ecfe54d02c8e79325
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Thu, 7 Sep 2023 16:31:53 +0200
add challenger-dbconfig man page
Diffstat:
2 files changed, 68 insertions(+), 0 deletions(-)
diff --git a/conf.py b/conf.py
@@ -526,6 +526,13 @@ man_pages = [
1,
),
(
+ "manpages/challenger-dbconfig.1",
+ "challenger-dbconfig",
+ "configure challenger database",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
"manpages/taler-exchange-dbinit.1",
"taler-exchange-dbinit",
"initialize Taler exchange database",
diff --git a/manpages/challenger-dbconfig.1.rst b/manpages/challenger-dbconfig.1.rst
@@ -0,0 +1,61 @@
+challenger-dbconfig(1)
+######################
+
+.. only:: html
+
+ Name
+ ====
+
+ **challenger-dbconfig** - configure challenger database
+
+
+Synopsis
+========
+
+**challenger-dbconfig**
+[**-c** *FILENAME*]
+[**-h**]
+[**-n** *NAME*]
+[**-r**]
+[**-s**]
+[**-u** *USER*]
+
+Description
+===========
+
+**challenger-dbconfig** is a simple shell script that configures
+a Postgresql database for use by ``challenger-httpd``.
+
+Its options are as follows:
+
+**-c** *FILENAME*
+ Write the database configuration to FILENAME. The tool
+ will append the required ``CONFIG`` option for the
+ Postgresql access to the respective file.
+
+**-h**
+ Print short help on options.
+
+**-n** *DBNAME*
+ Use DBNAME for the name of the created database.
+
+**-r**
+ Reset any existing database. Looses all existing data. DANGEROUS.
+
+**-s**
+ Skip database initialization. Useful if you want to run
+ ``challenger-dbinit`` manually.
+
+**-u** *USER*
+ Specifies the (main) challenger user that will access the database.
+
+See Also
+========
+
+challenger-dbinit(1), challenger.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
