diff options
author | Christian Grothoff <christian@grothoff.org> | 2023-09-08 20:11:25 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2023-09-08 20:11:30 +0200 |
commit | a24b27c8bc1716822bfa83f8edd5015f4c173fac (patch) | |
tree | 7773316dbcf674925147bd479032c034ad704f2c | |
parent | 225dd9e88a2a708fa324995f5188ca37a475c1da (diff) | |
download | anastasis-a24b27c8bc1716822bfa83f8edd5015f4c173fac.tar.gz anastasis-a24b27c8bc1716822bfa83f8edd5015f4c173fac.tar.bz2 anastasis-a24b27c8bc1716822bfa83f8edd5015f4c173fac.zip |
add db-tool man pages
-rw-r--r-- | debian/anastasis-httpd.install | 4 | ||||
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/anastasis-dbconfig.1 | 87 | ||||
-rw-r--r-- | doc/anastasis-dbinit.1 | 89 |
4 files changed, 181 insertions, 1 deletions
diff --git a/debian/anastasis-httpd.install b/debian/anastasis-httpd.install index 8f58c4b..2d3604b 100644 --- a/debian/anastasis-httpd.install +++ b/debian/anastasis-httpd.install @@ -3,7 +3,9 @@ usr/lib/*/anastasis/ usr/lib/*/libanastasisauthorization.* usr/lib/*/libanastasisdb.* usr/lib/*/libanastasiseufin.so.* -usr/share/man/man5/* +usr/share/man/man5/anastasis-* +usr/share/man/man1/anastasis-dbconfig.1 +usr/share/man/man1/anastasis-dbinit.1 usr/share/man/man1/anastasis-httpd.1 usr/share/man/man1/anastasis-helper-authorization-iban.1 usr/share/man/man1/anastasis-config.1 diff --git a/doc/Makefile.am b/doc/Makefile.am index 1bdb6d1..aa8ee42 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,6 +3,8 @@ # SUBDIRS = . doxygen man_MANS = \ + anastasis-dbconfig.1 \ + anastasis-dbinit.1 \ anastasis-httpd.1 \ anastasis-helper-authorization-iban.1 \ anastasis-reducer.1 \ diff --git a/doc/anastasis-dbconfig.1 b/doc/anastasis-dbconfig.1 new file mode 100644 index 0000000..a739c7d --- /dev/null +++ b/doc/anastasis-dbconfig.1 @@ -0,0 +1,87 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANASTASIS-DBCONFIG" "1" "Sep 08, 2023" "0.0" "Anastasis" +.SH NAME +anastasis-dbconfig \- configure Anastasis database +.SH SYNOPSIS +.sp +\fBanastasis\-dbconfig\fP +[\fB\-c\fP\ \fIFILENAME\fP\ \fI] +[*\fP\-h**] +[\fB\-n\fP\ \fINAME\fP\ \fI] +[*\fP\-r**] +[\fB\-s\fP] +[\fB\-u\fP\ \fIUSER\fP\ +.nf +* +.fi +] +.SH DESCRIPTION +.sp +\fBanastasis\-dbconfig\fP is a simple shell script that configures +a Postgresql database for use by the GNU Anastasis servers. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP +Write the database configuration to FILENAME. The tool +will append the required \fBCONFIG\fP option for the +Postgresql access to the respective file. +.TP +\fB\-h\fP +Print short help on options. +.TP +\fB\-n\fP \fIDBNAME\fP +Use DBNAME for the name of the created database. +.TP +\fB\-r\fP +Reset any existing database. Looses all existing data. DANGEROUS. +.TP +\fB\-s\fP +Skip database initialization. Useful if you want to run +\fBanastasis\-dbinit\fP manually. +.TP +\fB\-u\fP \fIUSER\fP +Specifies the (main) Anastasis user that will access the database. +.UNINDENT +.SH SEE ALSO +.sp +anastassis\-dbinit(1), anastasis.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +Anastasis SARL +.SH COPYRIGHT +2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/doc/anastasis-dbinit.1 b/doc/anastasis-dbinit.1 new file mode 100644 index 0000000..9791f08 --- /dev/null +++ b/doc/anastasis-dbinit.1 @@ -0,0 +1,89 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ANASTASIS-DBINIT" "1" "Sep 08, 2023" "0.0" "Anastasis" +.SH NAME +anastasis-dbinit \- initialize Anastasis database +.SH SYNOPSIS +.sp +\fBanastasis\-dbinit\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-g\fP\ |\ \fB\-\-gc\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-r\fP\ |\ \fB\-\-reset\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBanastasis\-dbinit\fP is a command\-line tool to initialize the GNU +Anastasis database. It creates the necessary tables and indices for +an Anastasis server to operate. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the exchange to operate +from \fIFILENAME\fP\&. +.TP +\fB\-g\fP | \fB\-\-gc\fP +Garbage collect database. Deletes all unnecessary data in the +database. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, +\fBWARNING\fP, \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-r\fP | \fB\-\-reset\fP +Drop tables. Dangerous, will delete all existing data in the database +before creating the tables. +.TP +\fB\-v\fP | \fB–version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +anastasis\-httpd(1), anastasis.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +Anastasis SARL +.SH COPYRIGHT +2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. |