[taler-docs] branch master updated: Add manpage: sync-config(1)

[gnunet]

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 95a7133  Add manpage: sync-config(1)
95a7133 is described below

commit 95a7133ef140bf285ef5640ad9db250b13f16301
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Fri Nov 26 17:49:13 2021 -0500

    Add manpage: sync-config(1)
    
    * manpages/sync-config.1.rst: New.
    * conf.py (man_pages): Add entry for new manpage.
    
    This partially addresses <https://bugs.gnunet.org/view.php?id=7019>.
---
 conf.py                    |   2 +
 manpages/sync-config.1.rst | 100 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 102 insertions(+)

diff --git a/conf.py b/conf.py
index 5726eea..cd0b5d3 100644
--- a/conf.py
+++ b/conf.py
@@ -275,6 +275,8 @@ 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-config.1", "sync-config",
+     "manipulate Sync configuration files", "GNU Taler contributors", 1),
     ("manpages/sync-dbinit.1", "sync-dbinit",
      "initialize the Sync database", "GNU Taler contributors", 1),
     ("manpages/sync-httpd.1", "sync-httpd",
diff --git a/manpages/sync-config.1.rst b/manpages/sync-config.1.rst
new file mode 100644
index 0000000..2b8f563
--- /dev/null
+++ b/manpages/sync-config.1.rst
@@ -0,0 +1,100 @@
+sync-config(1)
+##############
+
+.. only:: html
+
+   Name
+   ====
+
+   **sync-config** - manipulate Sync configuration file
+
+Synopsis
+========
+
+**sync-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
+===========
+
+**sync-config** can be used to read or modify Sync 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 Postgres database backend of the "NAMESTORE" service.  If *BACKEND* is
+    supported, sync-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
+    sync-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
+========
+
+
+
+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.