Commit 6ff0d1ad authored by Daniel Salzman's avatar Daniel Salzman

doc: add module section into reference

parent f0099bbd
......@@ -66,11 +66,11 @@ the following symbols:
| – Choice
.UNINDENT
.sp
There are 11 main sections (\fBserver\fP, \fBcontrol\fP, \fBlog\fP, \fBstatistics\fP,
\fBkeystore\fP, \fBpolicy\fP, \fBkey\fP, \fBacl\fP, \fBremote\fP, \fBtemplate\fP, and
\fBzone\fP) and module sections with the \fBmod\-\fP prefix. Most of the sections
(excluding \fBserver\fP, \fBcontrol\fP, and \fBstatistics\fP) are sequences of
settings blocks. Each settings block begins with a unique identifier,
There are 12 main sections (\fBmodule\fP, \fBserver\fP, \fBcontrol\fP, \fBlog\fP,
\fBstatistics\fP, \fBkeystore\fP, \fBpolicy\fP, \fBkey\fP, \fBacl\fP, \fBremote\fP,
\fBtemplate\fP, and \fBzone\fP) and module sections with the \fBmod\-\fP prefix.
Most of the sections (excluding \fBserver\fP, \fBcontrol\fP, and \fBstatistics\fP)
are sequences of settings blocks. Each settings block begins with a unique identifier,
which can be used as a reference from other sections (such identifier
must be defined in advance).
.sp
......@@ -124,6 +124,46 @@ include: STR
.fi
.UNINDENT
.UNINDENT
.SH MODULE SECTION
.sp
Dynamic modules loading configuration.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If configured with non\-empty \fB\(ga\-\-with\-moduledir=path\(ga\fP parameter, all
shared modules in this directory will be automatically loaded.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
module:
\- id: STR
file: STR
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A module identifier in the form of the \fBmod\-\fP prefix and module name suffix.
.SS file
.sp
A path to a shared library file with the module implementation.
.sp
\fIDefault:\fP \fB${libdir}/knot/modules\-${version}\fP/module_name.so
(or \fB${path}\fP/module_name.so if configured with \fB\-\-with\-moduledir=path\fP)
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If the path is not absolute, the library is searched in the set of
system directories. See \fBman dlopen\fP for more details.
.UNINDENT
.UNINDENT
.SH SERVER SECTION
.sp
General options related to the server.
......
......@@ -31,11 +31,11 @@ the following symbols:
- [ ] – Optional value
- \| – Choice
There are 11 main sections (``server``, ``control``, ``log``, ``statistics``,
``keystore``, ``policy``, ``key``, ``acl``, ``remote``, ``template``, and
``zone``) and module sections with the ``mod-`` prefix. Most of the sections
(excluding ``server``, ``control``, and ``statistics``) are sequences of
settings blocks. Each settings block begins with a unique identifier,
There are 12 main sections (``module``, ``server``, ``control``, ``log``,
``statistics``, ``keystore``, ``policy``, ``key``, ``acl``, ``remote``,
``template``, and ``zone``) and module sections with the ``mod-`` prefix.
Most of the sections (excluding ``server``, ``control``, and ``statistics``)
are sequences of settings blocks. Each settings block begins with a unique identifier,
which can be used as a reference from other sections (such identifier
must be defined in advance).
......@@ -76,6 +76,44 @@ Matching files are processed in sorted order.
include: STR
.. _Module section:
Module section
==============
Dynamic modules loading configuration.
.. NOTE::
If configured with non-empty ```--with-moduledir=path``` parameter, all
shared modules in this directory will be automatically loaded.
::
module:
- id: STR
file: STR
.. _module_id:
id
--
A module identifier in the form of the ``mod-`` prefix and module name suffix.
.. _module_file:
file
----
A path to a shared library file with the module implementation.
*Default:* ``${libdir}/knot/modules-${version}``/module_name.so
(or ``${path}``/module_name.so if configured with ``--with-moduledir=path``)
.. WARNING::
If the path is not absolute, the library is searched in the set of
system directories. See ``man dlopen`` for more details.
.. _Server section:
Server section
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment