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