summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2021-01-19 04:30:59 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2021-01-19 04:30:59 -0500
commit36eac508926cebb64bc4a90d1472f77c92a08345 (patch)
tree9ac6a0fda23d189076612e47cb297942f4796c75 /manpages
parent9b8eda8d8f4b531ac0456c40cbc0de85cea0c9af (diff)
downloaddocs-36eac508926cebb64bc4a90d1472f77c92a08345.tar.gz
docs-36eac508926cebb64bc4a90d1472f77c92a08345.tar.bz2
docs-36eac508926cebb64bc4a90d1472f77c92a08345.zip
taler-auditor-httpd(1): new manpage
* conf.py (man_pages): Add taler-auditor-httpd(1). * manpages/taler-auditor-httpd.1.rst: New file.
Diffstat (limited to 'manpages')
-rw-r--r--manpages/taler-auditor-httpd.1.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/manpages/taler-auditor-httpd.1.rst b/manpages/taler-auditor-httpd.1.rst
new file mode 100644
index 0000000..c698c13
--- /dev/null
+++ b/manpages/taler-auditor-httpd.1.rst
@@ -0,0 +1,81 @@
+taler-auditor-httpd(1)
+######################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-auditor-httpd** - HTTP server providing a RESTful API to access a Taler auditor
+
+
+Synopsis
+========
+
+**taler-auditor-httpd**
+[**-C** | **––connection-close**]
+[**-c** *FILENAME* | **––config=**\ \ *FILENAME*]
+[**-h** | **––help**]
+[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
+[**-t** *SECONDS* | **––timeout**\ \ *SECONDS*]
+[**-v** | **––version**]
+
+
+Description
+===========
+
+**taler-auditor-httpd** is a command-line tool to run the Taler auditor
+(HTTP backend). The required configuration and database must exist
+before running this command.
+
+
+Options
+=======
+
+**-C** \| **––connection-close**
+ Force each HTTP connection to be closed after each request
+ (useful in combination with -f to avoid having to wait for nc to
+ time out).
+
+**-c** *FILENAME* \| **––config=**\ \ *FILENAME*
+ Use the configuration and other resources for the auditor to
+ operate from FILENAME.
+
+**-h** \| **––help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
+ Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+ ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
+ Send logging output to *FILENAME*.
+
+**-t** *SECONDS* \| **––timeout=**\ \ *SECONDS*
+ Specifies the number of *SECONDS* after which the HTTPD should close
+ (idle) HTTP connections.
+
+**-v** \| **––version**
+ Print version information.
+
+
+Signals
+=======
+
+SIGTERM
+ Sending a SIGTERM to the process will cause it to shutdown
+ cleanly.
+
+
+See Also
+========
+
+taler-auditor-dbinit(1), taler-auditor(1), taler.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using Mantis https://bugs.taler.net/ or by sending
+electronic mail to <taler@gnu.org>