[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: Add manpages: sync-dbinit(1), sync-h
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: Add manpages: sync-dbinit(1), sync-httpd(1) |
Date: |
Wed, 24 Nov 2021 16:03:41 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new e3cc1ff Add manpages: sync-dbinit(1), sync-httpd(1)
e3cc1ff is described below
commit e3cc1ff85bf01145b4a8e9865c5832e0dce53a16
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Wed Nov 24 10:03:13 2021 -0500
Add manpages: sync-dbinit(1), sync-httpd(1)
* manpages/sync-dbinit.1.rst: New.
* manpages/sync-httpd.1.rst: New.
* conf.py (man_pages): Add entries for new manpages.
This partially addresses <https://bugs.gnunet.org/view.php?id=7019>.
---
conf.py | 4 +++
manpages/sync-dbinit.1.rst | 65 ++++++++++++++++++++++++++++++++++++++
manpages/sync-httpd.1.rst | 78 ++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 147 insertions(+)
diff --git a/conf.py b/conf.py
index f7aa52e..5726eea 100644
--- a/conf.py
+++ b/conf.py
@@ -275,6 +275,10 @@ latex_appendices = ["fdl-1.3"]
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
+ ("manpages/sync-dbinit.1", "sync-dbinit",
+ "initialize the Sync database", "GNU Taler contributors", 1),
+ ("manpages/sync-httpd.1", "sync-httpd",
+ "provide the Sync HTTP interface", "GNU Taler contributors", 1),
("manpages/taler-auditor-exchange.1", "taler-auditor-exchange",
"add or remove exchange from auditor’s list", "GNU Taler contributors",
1),
diff --git a/manpages/sync-dbinit.1.rst b/manpages/sync-dbinit.1.rst
new file mode 100644
index 0000000..bcf061d
--- /dev/null
+++ b/manpages/sync-dbinit.1.rst
@@ -0,0 +1,65 @@
+sync-dbinit(1)
+##############
+
+.. only:: html
+
+ Name
+ ====
+
+ **sync-dbinit** - initialize the Sync database
+
+
+Synopsis
+========
+
+**sync-dbinit**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-g** | **--garbagecollect**]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-r** | **--reset**]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**sync-dbinit** is a command-line tool to initialize the Sync database.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the Sync 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
+========
+
+sync-httpd(1).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/sync-httpd.1.rst b/manpages/sync-httpd.1.rst
new file mode 100644
index 0000000..29147a3
--- /dev/null
+++ b/manpages/sync-httpd.1.rst
@@ -0,0 +1,78 @@
+sync-httpd(1)
+#############
+
+.. only:: html
+
+ Name
+ ====
+
+ **sync-httpd** - provide the Sync HTTP interface
+
+
+Synopsis
+========
+
+**sync-httpd**
+[**-A** *USERNAME:PASSWORD* | **--auth=**\ \ *USERNAME:PASSWORD*]
+[**-C** | **--connection-close**]
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-k** *KEYFILE* | **--key=**\ \ *KEYFILE*]
+[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-p** *KEYFILEPASSPHRASE* | **--pass=**\ \ *KEYFILEPASSPHRASE*]
+[**-t** *CERTTYPE* | **--type=**\ \ *CERTTYPE*]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**sync-httpd** is a command-line tool to provide the Sync HTTP interface.
+
+Its options are as follows:
+
+**-A** *USERNAME:PASSWORD* \| **--auth=**\ \ *USERNAME:PASSWORD*
+ Use the given *USERNAME* and *PASSWORD* for client authentication.
+
+**-C** \| **--connection-close**
+ Force HTTP connections to be closed after each request.
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the Sync commands
+ to operate from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-k** *KEYFILE* \| **--key=**\ \ *KEYFILE*
+ Consult *KEYFILE* for the private TLS key for TLS client authentication.
+
+**-L** *LOGLEVEL* \| **--log=**\ \ *LOGLEVEL*
+ Configure logging to use *LOGLEVEL*.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+ Configure logging to write logs to *FILENAME*.
+
+**-p** *KEYFILEPASSPHRASE* \| **--pass=**\ \ *KEYFILEPASSPHRASE*
+ Use *KEYFILEPASSPHRASE* to decrypt the TLS client private key file.
+
+**-t** *CERTTYPE* \| **--type=**\ \ *CERTTYPE*
+ Use *CERTTYPE* as the type of the TLS client certificate.
+ If unspecified, defaults to PEM.
+
+**-v** \| **–version**
+ Print version information.
+
+
+See Also
+========
+
+sync-dbinit(1)
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: Add manpages: sync-dbinit(1), sync-httpd(1),
gnunet <=