taler-docs

commit fd538fb5726b9160b2f2f040c1419e20ba0b527d
parent bd80dfcaebc13a34907da688ff7b0b7601ec738b
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sun,  7 May 2023 01:42:10 +0200

add challenger-admin man page

Diffstat:
M
conf.py
 | 
7
+++++++
A
manpages/challenger-admin.1.rst
 | 
65
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 72 insertions(+), 0 deletions(-)
diff --git a/conf.py b/conf.py
@@ -321,6 +321,13 @@ man_pages = [
         1,
     ),
     (
+        "manpages/challenger-admin.1",
+        "challenger-admin",
+        "manipulate list of authorized Challenger clients",
+        "GNU Taler contributors",
+        1,
+    ),
+    (
         "manpages/challenger-httpd.1",
         "challenger-httpd",
         "provide the Challenger HTTP interface",
diff --git a/manpages/challenger-admin.1.rst b/manpages/challenger-admin.1.rst
@@ -0,0 +1,65 @@
+challenger-admin(1)
+###################
+
+.. only:: html
+
+   Name
+   ====
+
+   **challenger-admin** - manipulate clients registered in Challenger database
+
+
+Synopsis
+========
+
+**challenger-admin**
+[**-a** *CLIENT_SECRET* | **--add=**\ \ *CLIENT_SECRET*]
+[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-d** | **--delete**]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-v** | **--version**] CLIENT_URL
+
+
+Description
+===========
+
+**challenger-admin** is a command-line tool to add or delete clients from the Challenger database.
+
+Its options are as follows:
+
+**-a** *SECRET* \| **--add=**\ ‌\ *SECRET*
+   Add the client with the given *CLIENT_URL setting the client secret to *SECRET*.  Prints the CLIENT_ID of the added client.
+
+**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
+   Use the configuration and other resources for the Challenger commands
+   to operate from *FILENAME*.
+
+**-d** \| **--delete**
+   Delete the client with the given *CLIENT_URL*.
+
+**-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-httpd(1), challenger.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.