Commit 309fec60 authored by Daniel Salzman's avatar Daniel Salzman

doc: unify item description order in the reference

parent f8a382b5
......@@ -154,9 +154,6 @@ A module identifier in the form of the \fBmod\-\fP prefix and module name suffix
.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
......@@ -164,6 +161,9 @@ 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
.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)
.SH SERVER SECTION
.sp
General options related to the server.
......@@ -724,14 +724,14 @@ Possible values:
\fBed25519\fP
.UNINDENT
.sp
\fIDefault:\fP ecdsap256sha256
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Ed25519 algorithm is only available when compiled with GnuTLS 3.6.0+.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP ecdsap256sha256
.SS ksk\-size
.sp
A length of newly generated KSK or
......@@ -752,14 +752,14 @@ If enabled, all zones with this policy assigned will share one KSK.
.sp
A TTL value for DNSKEY records added into zone apex.
.sp
\fIDefault:\fP zone SOA TTL
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Has infuence over ZSK key lifetime.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP zone SOA TTL
.SS zone\-max\-ttl
.sp
Maximal TTL value among all the records in zone.
......@@ -777,8 +777,6 @@ explicitly whenever possible. It\(aqs required for DNSSEC Offline KSK\&.
.sp
A period between ZSK publication and the next rollover initiation.
.sp
\fIDefault:\fP 30 days
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
......@@ -787,12 +785,12 @@ ZSK key lifetime is also infuenced by propagation\-delay and dnskey\-ttl
Zero (aka infinity) value causes no ZSK rollover as a result.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP 30 days
.SS ksk\-lifetime
.sp
A period between KSK publication and the next rollover initiation.
.sp
\fIDefault:\fP 0
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
......@@ -804,19 +802,21 @@ Zero (aka infinity) value causes no KSK rollover as a result.
This applies for CSK lifetime if single\-type\-signing is enabled.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP 0
.SS propagation\-delay
.sp
An extra delay added for each key rollover step. This value should be high
enough to cover propagation of data from the master server to all slaves.
.sp
\fIDefault:\fP 1 hour
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Has infuence over ZSK key lifetime.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP 1 hour
.SS rrsig\-lifetime
.sp
A validity period of newly issued signatures.
......@@ -1074,14 +1074,14 @@ This option is only available in the \fIdefault\fP template.
A KASP database path. Non\-absolute path is relative to
\fI\%storage\fP\&.
.sp
\fIDefault:\fP \fI\%storage\fP/keys
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option is only available in the \fIdefault\fP template.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP \fI\%storage\fP/keys
.SS max\-kasp\-db\-size
.sp
Hard limit for the KASP database maximum size.
......@@ -1320,8 +1320,6 @@ Possible values:
.sp
Policy how much space in journal DB will the zone\(aqs journal occupy.
.sp
\fIDefault:\fP 100 MiB
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
......@@ -1329,6 +1327,8 @@ Journal DB may grow far above the sum of max\-journal\-usage across
all zones, because of DB free space fragmentation.
.UNINDENT
.UNINDENT
.sp
\fIDefault:\fP 100 MiB
.SS max\-journal\-depth
.sp
Maximum history length of journal.
......
......@@ -107,13 +107,13 @@ 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.
*Default:* ``${libdir}/knot/modules-${version}``/module_name.so
(or ``${path}``/module_name.so if configured with ``--with-moduledir=path``)
.. _Server section:
Server section
......@@ -804,11 +804,11 @@ Possible values:
- ``ecdsap384sha384``
- ``ed25519``
*Default:* ecdsap256sha256
.. NOTE::
Ed25519 algorithm is only available when compiled with GnuTLS 3.6.0+.
*Default:* ecdsap256sha256
.. _policy_ksk-size:
ksk-size
......@@ -844,11 +844,11 @@ dnskey-ttl
A TTL value for DNSKEY records added into zone apex.
*Default:* zone SOA TTL
.. NOTE::
Has infuence over ZSK key lifetime.
*Default:* zone SOA TTL
.. _policy_zone-max-ttl:
zone-max-ttl
......@@ -869,13 +869,13 @@ zsk-lifetime
A period between ZSK publication and the next rollover initiation.
*Default:* 30 days
.. NOTE::
ZSK key lifetime is also infuenced by propagation-delay and dnskey-ttl
Zero (aka infinity) value causes no ZSK rollover as a result.
*Default:* 30 days
.. _policy_ksk-lifetime:
ksk-lifetime
......@@ -883,8 +883,6 @@ ksk-lifetime
A period between KSK publication and the next rollover initiation.
*Default:* 0
.. NOTE::
KSK key lifetime is also infuenced by propagation-delay, dnskey-ttl,
and KSK submission delay.
......@@ -893,6 +891,8 @@ A period between KSK publication and the next rollover initiation.
This applies for CSK lifetime if single-type-signing is enabled.
*Default:* 0
.. _policy_propagation-delay:
propagation-delay
......@@ -901,11 +901,11 @@ propagation-delay
An extra delay added for each key rollover step. This value should be high
enough to cover propagation of data from the master server to all slaves.
*Default:* 1 hour
.. NOTE::
Has infuence over ZSK key lifetime.
*Default:* 1 hour
.. _policy_rrsig-lifetime:
rrsig-lifetime
......@@ -1205,11 +1205,11 @@ kasp-db
A KASP database path. Non-absolute path is relative to
:ref:`storage<zone_storage>`.
*Default:* :ref:`storage<zone_storage>`/keys
.. NOTE::
This option is only available in the *default* template.
*Default:* :ref:`storage<zone_storage>`/keys
.. _template_max-kasp-db-size:
max-kasp-db-size
......@@ -1466,12 +1466,12 @@ max-journal-usage
Policy how much space in journal DB will the zone's journal occupy.
*Default:* 100 MiB
.. NOTE::
Journal DB may grow far above the sum of max-journal-usage across
all zones, because of DB free space fragmentation.
*Default:* 100 MiB
.. _zone_max_journal_depth:
max-journal-depth
......
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