gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-anastasis] branch master updated: add anastasis-db* man pages


From: gnunet
Subject: [taler-anastasis] branch master updated: add anastasis-db* man pages
Date: Fri, 11 Aug 2023 21:03:07 +0200

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository anastasis.

The following commit(s) were added to refs/heads/master by this push:
     new 8c5b9c3  add anastasis-db* man pages
8c5b9c3 is described below

commit 8c5b9c306d3a845decaeeb49ce13dd5417375064
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Fri Aug 11 21:03:03 2023 +0200

    add anastasis-db* man pages
---
 doc/sphinx/conf.py                           |  6 +++
 doc/sphinx/manpages/anastasis-dbconfig.1.rst | 61 +++++++++++++++++++++++++
 doc/sphinx/manpages/anastasis-dbinit.1.rst   | 67 ++++++++++++++++++++++++++++
 3 files changed, 134 insertions(+)

diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 932692b..40928c6 100644
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -260,6 +260,12 @@ man_pages = [
     ("manpages/anastasis-httpd.1", "anastasis-httpd",
      "anastasis HTTP backend", "Anastasis SARL",
      1),
+    ("manpages/anastasis-dbconfig.1", "anastasis-dbconfig",
+     "configure Anastasis database", "Anastasis SARL",
+     1),
+    ("manpages/anastasis-dbinit.1", "anastasis-dbinit",
+     "initialize Anastasis database", "Anastasis SARL",
+     1),
     ("manpages/anastasis.conf.5", "anastasis.conf",
      "anastasis configuration file", "Anastasis SARL",
      5),
diff --git a/doc/sphinx/manpages/anastasis-dbconfig.1.rst 
b/doc/sphinx/manpages/anastasis-dbconfig.1.rst
new file mode 100644
index 0000000..3483c36
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-dbconfig.1.rst
@@ -0,0 +1,61 @@
+anastasis-dbconfig(1)
+#####################
+
+.. only:: html
+
+   Name
+   ====
+
+   **anastasis-dbconfig** - configure Anastasis database
+
+
+Synopsis
+========
+
+**anastasis-dbconfig**
+[**-c** *FILENAME* *]
+[**-h**]
+[**-n** *NAME* *]
+[**-r**]
+[**-s**]
+[**-u** *USER* *]
+
+Description
+===========
+
+**anastasis-dbconfig** is a simple shell script that configures
+a Postgresql database for use by the GNU Anastasis servers.
+
+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
+   ``anastasis-dbinit`` manually.
+
+**-u** *USER*
+   Specifies the (main) Anastasis user that will access the database.
+
+See Also
+========
+
+anastassis-dbinit(1), anastasis.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/doc/sphinx/manpages/anastasis-dbinit.1.rst 
b/doc/sphinx/manpages/anastasis-dbinit.1.rst
new file mode 100644
index 0000000..1b0d5fa
--- /dev/null
+++ b/doc/sphinx/manpages/anastasis-dbinit.1.rst
@@ -0,0 +1,67 @@
+anastasis-dbinit(1)
+###################
+
+.. only:: html
+
+   Name
+   ====
+
+   **anastasis-dbinit** - initialize Anastasis database
+
+
+Synopsis
+========
+
+**anastasis-dbinit**
+[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-g** | **--gc**]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
+[**-r** | **--reset**]
+[**-v** | **--version**]
+
+Description
+===========
+
+**anastasis-dbinit** is a command-line tool to initialize the GNU
+Anastasis database. It creates the necessary tables and indices for
+an Anastasis server to operate.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
+   Use the configuration and other resources for the exchange to operate
+   from *FILENAME*.
+
+**-g** \| **--gc**
+   Garbage collect database. Deletes all unnecessary data in the
+   database.
+
+**-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*.
+
+**-r** \| **--reset**
+   Drop tables. Dangerous, will delete all existing data in the database
+   before creating the tables.
+
+**-v** \| **–version**
+   Print version information.
+
+See Also
+========
+
+anastasis-httpd(1), anastasis.conf(5).
+
+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.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]