diff options
Diffstat (limited to 'doc/sphinx/manpages/anastasis-config.1.rst')
-rw-r--r-- | doc/sphinx/manpages/anastasis-config.1.rst | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/doc/sphinx/manpages/anastasis-config.1.rst b/doc/sphinx/manpages/anastasis-config.1.rst new file mode 100644 index 0000000..043a22e --- /dev/null +++ b/doc/sphinx/manpages/anastasis-config.1.rst | |||
@@ -0,0 +1,101 @@ | |||
1 | anastasis-config(1) | ||
2 | ################### | ||
3 | |||
4 | .. only:: html | ||
5 | |||
6 | Name | ||
7 | ==== | ||
8 | |||
9 | **anastasis-config** - manipulate Anastasis configuration files | ||
10 | |||
11 | Synopsis | ||
12 | ======== | ||
13 | |||
14 | **anastasis-config** | ||
15 | [**-b** *backend* | **––supported-backend=**\ \ *backend*] | ||
16 | [**-c** *filename* | **––config=**\ \ *filename*] | ||
17 | [**-f** | **––filename**] | ||
18 | [**-F** | **––full**] | ||
19 | [**-h** | **––help**] | ||
20 | [**-L** *loglevel* | **––loglevel=**\ \ *loglevel*] | ||
21 | [**-l** *filename* | **––logfile=**\ \ *filename*] | ||
22 | [**-o** *option* | **––option=**\ \ *option*] | ||
23 | [**-r** | **––rewrite**] | ||
24 | [**-S** | **––list-sections**] | ||
25 | [**-s** *section* | **––section=**\ \ *section*] | ||
26 | [**-V** *value* | **––value=**\ \ *value*] | ||
27 | [**-v** | **––version**] | ||
28 | |||
29 | |||
30 | Description | ||
31 | =========== | ||
32 | |||
33 | **anastasis-config** can be used to read or modify Anastasis configuration files. | ||
34 | |||
35 | **-b** *BACKEND* \| **––supported-backend=**\ \ *BACKEND* | ||
36 | Tests whether the specified *BACKEND* is supported by the current installation. | ||
37 | The backend must match the name of a plugin, i.e. "namestore_postgres" for | ||
38 | the Postgres database backend of the "NAMESTORE" service. If *BACKEND* is | ||
39 | supported, anastasis-config will return a status code of 0 (success), otherwise | ||
40 | 77 (unsupported). When this option is specified, no other options may be | ||
41 | specified. Specifying this option together with other options will cause | ||
42 | anastasis-config to return a status code of 1 (error). | ||
43 | |||
44 | **-c** *FILENAME* \| **––config=**\ \ *FILENAME* | ||
45 | Use the configuration file *FILENAME*. | ||
46 | |||
47 | **-f** \| **––filename** | ||
48 | Try to perform expansions as if the option values represent filenames (will | ||
49 | also be applied even if the option is not really a filename). | ||
50 | |||
51 | **-F** \| **––full** | ||
52 | Write the full configuration file, not just the differences to the defaults. | ||
53 | |||
54 | **-h** \| **––help** | ||
55 | Print short help on options. | ||
56 | |||
57 | **-L** *LOGLEVEL* \| **––loglevel=**\ \ *LOGLEVEL* | ||
58 | Use *LOGLEVEL* for logging. | ||
59 | Valid values are ``DEBUG``, ``INFO``, ``WARNING``, and ``ERROR``. | ||
60 | |||
61 | **-l** *FILENAME* \| **––logfile=**\ \ *FILENAME* | ||
62 | Send logging output to *FILENAME*. | ||
63 | |||
64 | **-o** *OPTION* \| **––option=**\ \ *OPTION* | ||
65 | Which configuration option should be accessed or edited. Required to set a | ||
66 | value. If not given, all values of a given section will be printed in the | ||
67 | format "OPTION = VALUE". | ||
68 | |||
69 | **-r** \| **––rewrite** | ||
70 | Write the configuration file even if nothing changed. Will remove all comments! | ||
71 | |||
72 | **-S** \| **––list-sections** | ||
73 | List available configuration sections for use with ``--section``. | ||
74 | |||
75 | **-s** *SECTION* \| **––section=**\ \ *SECTION* | ||
76 | Which configuration section should be accessed or edited. | ||
77 | Required option. | ||
78 | |||
79 | **-V** *VALUE* \| **––value=**\ \ *VALUE* | ||
80 | Configuration value to store in the given section under the given option. | ||
81 | Must only be given together with ``-s`` and ``-o`` options. | ||
82 | |||
83 | Note: | ||
84 | Changing the configuration file with ``-V`` will remove comments | ||
85 | and may reorder sections and remove ``@INLINE@`` directives. | ||
86 | |||
87 | **-v** \| **––version** | ||
88 | Print Anastasis version number. | ||
89 | |||
90 | |||
91 | |||
92 | See Also | ||
93 | ======== | ||
94 | |||
95 | anastasis.conf(5) | ||
96 | |||
97 | Bugs | ||
98 | ==== | ||
99 | |||
100 | Report bugs by using https://bugs.anastasis.lu or by sending electronic | ||
101 | mail to <contact@anastasis.lu>. | ||