summaryrefslogtreecommitdiff
path: root/doc/anastasis-config.1
blob: bb1512da87283c4ca7b69fdc73c55b4addbd3226 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
.\" Man page generated from reStructuredText.
.
.TH "ANASTASIS-CONFIG" "1" "Jul 18, 2021" "0.0" "Anastasis"
.SH NAME
anastasis-config \- anastasis configuration file manipulation
.
.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
..
.SH SYNOPSIS
.sp
\fBanastasis\-config\fP
[\fB\-b\fP\ \fIbackend\fP\ |\ \fB––supported\-backend=\fP\fIbackend\fP]
[\fB\-c\fP\ \fIfilename\fP\ |\ \fB––config=\fP\fIfilename\fP]
[\fB\-f\fP\ |\ \fB––filename\fP]
[\fB\-F\fP\ |\ \fB––full\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\-o\fP\ \fIoption\fP\ |\ \fB––option=\fP\fIoption\fP]
[\fB\-r\fP\ |\ \fB––rewrite\fP]
[\fB\-S\fP\ |\ \fB––list\-sections\fP]
[\fB\-s\fP\ \fIsection\fP\ |\ \fB––section=\fP\fIsection\fP]
[\fB\-V\fP\ \fIvalue\fP\ |\ \fB––value=\fP\fIvalue\fP]
[\fB\-v\fP\ |\ \fB––version\fP]
.SH DESCRIPTION
.sp
\fBanastasis\-config\fP can be used to read or modify Anastasis configuration files.
.INDENT 0.0
.TP
\fB\-b\fP \fIBACKEND\fP | \fB––supported\-backend=\fP\fIBACKEND\fP
Tests whether the specified \fIBACKEND\fP 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 \fIBACKEND\fP is
supported, anastasis\-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
anastasis\-config to return a status code of 1 (error).
.TP
\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP\fIFILENAME\fP
Use the configuration file \fIFILENAME\fP\&.
.TP
\fB\-f\fP | \fB––filename\fP
Try to perform expansions as if the option values represent filenames (will
also be applied even if the option is not really a filename).
.TP
\fB\-F\fP | \fB––full\fP
Write the full configuration file, not just the differences to the defaults.
.TP
\fB\-h\fP | \fB––help\fP
Print short help on options.
.TP
\fB\-L\fP \fILOGLEVEL\fP | \fB––loglevel=\fP\fILOGLEVEL\fP
Use \fILOGLEVEL\fP for logging.
Valid values are \fBDEBUG\fP, \fBINFO\fP, \fBWARNING\fP, and \fBERROR\fP\&.
.TP
\fB\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP
Send logging output to \fIFILENAME\fP\&.
.TP
\fB\-o\fP \fIOPTION\fP | \fB––option=\fP\fIOPTION\fP
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”.
.TP
\fB\-r\fP | \fB––rewrite\fP
Write the configuration file even if nothing changed. Will remove all comments!
.TP
\fB\-S\fP | \fB––list\-sections\fP
List available configuration sections for use with \fB\-\-section\fP\&.
.TP
\fB\-s\fP \fISECTION\fP | \fB––section=\fP\fISECTION\fP
Which configuration section should be accessed or edited.
Required option.
.TP
\fB\-V\fP \fIVALUE\fP | \fB––value=\fP\fIVALUE\fP
Configuration value to store in the given section under the given option.
Must only be given together with \fB\-s\fP and \fB\-o\fP options.
.INDENT 7.0
.TP
.B Note:
Changing the configuration file with \fB\-V\fP will remove comments
and may reorder sections and remove \fB@INLINE@\fP directives.
.UNINDENT
.TP
\fB\-v\fP | \fB––version\fP
Print Anastasis version number.
.UNINDENT
.SH SEE ALSO
.sp
anastasis.conf(5)
.SH BUGS
.sp
Report bugs by using \fI\%https://bugs.anastasis.lu\fP or by sending electronic
mail to <\fI\%contact@anastasis.lu\fP>.
.SH AUTHOR
Anastasis SARL
.SH COPYRIGHT
2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.