Commit c1dc436f authored by Jan Včelák's avatar Jan Včelák 🚀

doc: disable smartypants, insert dashes manually

Parameter names in HTML manual pages were incorrectly replaced by
dashes. This seems to be the easiest fix.
parent ac6990cd
...@@ -129,7 +129,7 @@ html_logo = 'logo.png' ...@@ -129,7 +129,7 @@ html_logo = 'logo.png'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
#html_use_smartypants = True html_use_smartypants = False
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
#html_sidebars = {} #html_sidebars = {}
......
...@@ -321,7 +321,7 @@ To initialize the database, run: ...@@ -321,7 +321,7 @@ To initialize the database, run:
Make sure to set the KASP database permissions correctly. For manual key Make sure to set the KASP database permissions correctly. For manual key
management, the database must be **readable** by the server process. For management, the database must be **readable** by the server process. For
automatic key management, it must be **writeable**. The database also automatic key management, it must be **writeable**. The database also
contains private key material -- don't set the permissions too loose. contains private key material don't set the permissions too loose.
.. _dnssec-automatic-key-management: .. _dnssec-automatic-key-management:
...@@ -571,7 +571,7 @@ Query modules ...@@ -571,7 +571,7 @@ Query modules
============= =============
Knot DNS supports configurable query modules that can alter the way Knot DNS supports configurable query modules that can alter the way
queries are processed. The concept is quite simple -- each query queries are processed. The concept is quite simple each query
requires a finite number of steps to be resolved. We call this set of requires a finite number of steps to be resolved. We call this set of
steps a *query plan*, an abstraction that groups these steps into steps a *query plan*, an abstraction that groups these steps into
several stages. several stages.
...@@ -592,8 +592,8 @@ identified for the subsequent usage. Then the identifier is referenced ...@@ -592,8 +592,8 @@ identified for the subsequent usage. Then the identifier is referenced
through :ref:`zone_module` option (in the form of ``module_name/module_id``) through :ref:`zone_module` option (in the form of ``module_name/module_id``)
in the zone section or in the ``default`` template if it used for all queries. in the zone section or in the ``default`` template if it used for all queries.
``dnstap`` -- dnstap-enabled query logging ``dnstap`` dnstap-enabled query logging
------------------------------------------ -----------------------------------------
A module for query and response logging based on dnstap_ library. A module for query and response logging based on dnstap_ library.
You can capture either all or zone-specific queries and responses; usually You can capture either all or zone-specific queries and responses; usually
...@@ -611,8 +611,8 @@ a UNIX socket:: ...@@ -611,8 +611,8 @@ a UNIX socket::
.. _dnstap: http://dnstap.info/ .. _dnstap: http://dnstap.info/
``synth-record`` -- Automatic forward/reverse records ``synth-record`` Automatic forward/reverse records
----------------------------------------------------- ----------------------------------------------------
This module is able to synthesize either forward or reverse records for This module is able to synthesize either forward or reverse records for
a given prefix and subnet. a given prefix and subnet.
...@@ -702,8 +702,8 @@ Limitations ...@@ -702,8 +702,8 @@ Limitations
since the module is hooked in the query processing plan, it will be since the module is hooked in the query processing plan, it will be
possible to do online signing in the future. possible to do online signing in the future.
``dnsproxy`` -- Tiny DNS proxy ``dnsproxy`` Tiny DNS proxy
------------------------------ -----------------------------
The module catches all unsatisfied queries and forwards them to the The module catches all unsatisfied queries and forwards them to the
indicated server for resolution, i.e. a tiny DNS proxy. There are several indicated server for resolution, i.e. a tiny DNS proxy. There are several
...@@ -734,8 +734,8 @@ When clients query for anything in the ``local.zone``, they will be ...@@ -734,8 +734,8 @@ When clients query for anything in the ``local.zone``, they will be
responded to locally. The rest of the requests will be forwarded to the responded to locally. The rest of the requests will be forwarded to the
specified server (``10.0.1.1`` in this case). specified server (``10.0.1.1`` in this case).
``rosedb`` -- Static resource records ``rosedb`` Static resource records
------------------------------------- ------------------------------------
The module provides a mean to override responses for certain queries before The module provides a mean to override responses for certain queries before
the record is searched in the available zones. The module comes with the the record is searched in the available zones. The module comes with the
...@@ -830,7 +830,7 @@ Here is an example on how to use the module: ...@@ -830,7 +830,7 @@ Here is an example on how to use the module:
- id: default - id: default
module: mod-rosedb/default module: mod-rosedb/default
*Note: The module accepts just one parameter -- the path to the directory where *Note: The module accepts just one parameter the path to the directory where
the database will be stored.* the database will be stored.*
* Start the server: * Start the server:
......
...@@ -24,7 +24,7 @@ DNS features: ...@@ -24,7 +24,7 @@ DNS features:
* IN class and partially CH class * IN class and partially CH class
* TCP/UDP protocols * TCP/UDP protocols
* AXFR, IXFR -- master, slave * AXFR, IXFR master, slave
* TSIG * TSIG
* EDNS0 * EDNS0
* DNSSEC, including NSEC3 * DNSSEC, including NSEC3
......
...@@ -39,31 +39,31 @@ For the description of configuration items, we have to declare a meaning of ...@@ -39,31 +39,31 @@ For the description of configuration items, we have to declare a meaning of
the following symbols: the following symbols:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fIINT\fP \-\- Integer \fIINT\fP Integer
.IP \(bu 2 .IP \(bu 2
\fISTR\fP \-\- Textual string \fISTR\fP Textual string
.IP \(bu 2 .IP \(bu 2
\fIHEXSTR\fP \-\- Hexadecimal string (with \fB0x\fP prefix) \fIHEXSTR\fP Hexadecimal string (with \fB0x\fP prefix)
.IP \(bu 2 .IP \(bu 2
\fIBOOL\fP \-\- Boolean value (\fBon\fP/\fBoff\fP or \fBtrue\fP/\fBfalse\fP) \fIBOOL\fP Boolean value (\fBon\fP/\fBoff\fP or \fBtrue\fP/\fBfalse\fP)
.IP \(bu 2 .IP \(bu 2
\fITIME\fP \-\- Number of seconds, an integer with possible time multiplier suffix \fITIME\fP Number of seconds, an integer with possible time multiplier suffix
(\fBs\fP ~ 1, \fBm\fP ~ 60, \fBh\fP ~ 3600 or \fBd\fP ~ 24 * 3600) (\fBs\fP ~ 1, \fBm\fP ~ 60, \fBh\fP ~ 3600 or \fBd\fP ~ 24 * 3600)
.IP \(bu 2 .IP \(bu 2
\fISIZE\fP \-\- Number of bytes, an integer with possible size multiplier suffix \fISIZE\fP Number of bytes, an integer with possible size multiplier suffix
(\fBB\fP ~ 1, \fBK\fP ~ 1024, \fBM\fP ~ 1024^2 or \fBG\fP ~ 1024^3) (\fBB\fP ~ 1, \fBK\fP ~ 1024, \fBM\fP ~ 1024^2 or \fBG\fP ~ 1024^3)
.IP \(bu 2 .IP \(bu 2
\fIBASE64\fP \-\- Base64 encoded string \fIBASE64\fP Base64 encoded string
.IP \(bu 2 .IP \(bu 2
\fIADDR\fP \-\- IPv4 or IPv6 address \fIADDR\fP IPv4 or IPv6 address
.IP \(bu 2 .IP \(bu 2
\fIDNAME\fP \-\- Domain name \fIDNAME\fP Domain name
.IP \(bu 2 .IP \(bu 2
\&... \-\- Multi\-valued item, order of the values is preserved \&... Multi\-valued item, order of the values is preserved
.IP \(bu 2 .IP \(bu 2
[ ] \-\- Optional value [ ] Optional value
.IP \(bu 2 .IP \(bu 2
| \-\- Choice | Choice
.UNINDENT .UNINDENT
.sp .sp
There are 8 main sections (\fBserver\fP, \fBkey\fP, \fBacl\fP, \fBcontrol\fP, There are 8 main sections (\fBserver\fP, \fBkey\fP, \fBacl\fP, \fBcontrol\fP,
...@@ -346,13 +346,13 @@ An ordered list of allowed actions. ...@@ -346,13 +346,13 @@ An ordered list of allowed actions.
Possible values: Possible values:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fBtransfer\fP \-\- Allow zone transfer \fBtransfer\fP Allow zone transfer
.IP \(bu 2 .IP \(bu 2
\fBnotify\fP \-\- Allow incoming notify \fBnotify\fP Allow incoming notify
.IP \(bu 2 .IP \(bu 2
\fBupdate\fP \-\- Allow zone updates \fBupdate\fP Allow zone updates
.IP \(bu 2 .IP \(bu 2
\fBcontrol\fP \-\- Allow remote control \fBcontrol\fP Allow remote control
.UNINDENT .UNINDENT
.sp .sp
Default: empty Default: empty
...@@ -503,12 +503,12 @@ A path to the zone file. Non absolute path is relative to ...@@ -503,12 +503,12 @@ A path to the zone file. Non absolute path is relative to
\fI\%storage\fP\&. It is also possible to use the following formatters: \fI\%storage\fP\&. It is also possible to use the following formatters:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fB%s\fP \-\- means the current zone name in the textual representation (beware \fB%s\fP means the current zone name in the textual representation (beware
of special characters which are escaped or encoded in the \eDDD form where of special characters which are escaped or encoded in the \eDDD form where
DDD is corresponding decimal ASCII code). The zone name doesn\(aqt include the DDD is corresponding decimal ASCII code). The zone name doesn\(aqt include the
terminating dot, except for the root zone. terminating dot, except for the root zone.
.IP \(bu 2 .IP \(bu 2
\fB%%\fP \-\- means the \fB%\fP character \fB%%\fP means the \fB%\fP character
.UNINDENT .UNINDENT
.sp .sp
Default: \fI\%storage\fP/\fB%s\fP\&.zone Default: \fI\%storage\fP/\fB%s\fP\&.zone
...@@ -656,9 +656,9 @@ no change is made. ...@@ -656,9 +656,9 @@ no change is made.
Possible values: Possible values:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fBincrement\fP \-\- The serial is incremented according to serial number arithmetic \fBincrement\fP The serial is incremented according to serial number arithmetic
.IP \(bu 2 .IP \(bu 2
\fBunixtime\fP \-\- The serial is set to the current unix time \fBunixtime\fP The serial is set to the current unix time
.UNINDENT .UNINDENT
.sp .sp
\fICaution:\fP If your serial was in other than unix time format, be careful \fICaution:\fP If your serial was in other than unix time format, be careful
...@@ -682,17 +682,17 @@ file. ...@@ -682,17 +682,17 @@ file.
There are 6 logging severity levels: There are 6 logging severity levels:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fBcritical\fP \-\- Non\-recoverable error resulting in server shutdown \fBcritical\fP Non\-recoverable error resulting in server shutdown
.IP \(bu 2 .IP \(bu 2
\fBerror\fP \-\- Recoverable error, action should be taken \fBerror\fP Recoverable error, action should be taken
.IP \(bu 2 .IP \(bu 2
\fBwarning\fP \-\- Warning that might require user action \fBwarning\fP Warning that might require user action
.IP \(bu 2 .IP \(bu 2
\fBnotice\fP \-\- Server notice or hint \fBnotice\fP Server notice or hint
.IP \(bu 2 .IP \(bu 2
\fBinfo\fP \-\- Informational message \fBinfo\fP Informational message
.IP \(bu 2 .IP \(bu 2
\fBdebug\fP \-\- Debug messages (must be turned on at compile time) \fBdebug\fP Debug messages (must be turned on at compile time)
.UNINDENT .UNINDENT
.sp .sp
In the case of missing log section, \fBwarning\fP or more serious messages In the case of missing log section, \fBwarning\fP or more serious messages
...@@ -719,13 +719,13 @@ A logging output. ...@@ -719,13 +719,13 @@ A logging output.
Possible values: Possible values:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fBstdout\fP \-\- Standard output \fBstdout\fP Standard output
.IP \(bu 2 .IP \(bu 2
\fBstderr\fP \-\- Standard error output \fBstderr\fP Standard error output
.IP \(bu 2 .IP \(bu 2
\fBsyslog\fP \-\- Syslog \fBsyslog\fP Syslog
.IP \(bu 2 .IP \(bu 2
\fIfile_name\fP \-\- File \fIfile_name\fP File
.UNINDENT .UNINDENT
.SS server .SS server
.sp .sp
...@@ -800,9 +800,9 @@ The type of generated records. ...@@ -800,9 +800,9 @@ The type of generated records.
Possible values: Possible values:
.INDENT 0.0 .INDENT 0.0
.IP \(bu 2 .IP \(bu 2
\fBforward\fP \-\- Forward records \fBforward\fP Forward records
.IP \(bu 2 .IP \(bu 2
\fBreverse\fP \-\- Reverse records \fBreverse\fP Reverse records
.UNINDENT .UNINDENT
.sp .sp
Default: empty Default: empty
......
...@@ -76,7 +76,7 @@ A1RT98BS5QGC9NFI51S9HCI47ULJG6JH (salt=\-, hash=1, iterations=0) ...@@ -76,7 +76,7 @@ A1RT98BS5QGC9NFI51S9HCI47ULJG6JH (salt=\-, hash=1, iterations=0)
.UNINDENT .UNINDENT
.SH SEE ALSO .SH SEE ALSO
.sp .sp
\fI\%RFC 5155\fP \-\- DNS Security (DNSSEC) Hashed Authenticated Denial of Existence. \fI\%RFC 5155\fP DNS Security (DNSSEC) Hashed Authenticated Denial of Existence.
.sp .sp
\fIknotc(8)\fP, \fIknotd(8)\fP\&. \fIknotc(8)\fP, \fIknotd(8)\fP\&.
.SH AUTHOR .SH AUTHOR
......
.. highlight:: console .. highlight:: console
kdig -- Advanced DNS lookup utility kdig Advanced DNS lookup utility
=================================== ==================================
Synopsis Synopsis
-------- --------
......
.. highlight:: console .. highlight:: console
keymgr -- DNSSEC key management utility keymgr DNSSEC key management utility
======================================= ======================================
Synopsis Synopsis
-------- --------
......
.. highlight:: console .. highlight:: console
khost -- Simple DNS lookup utility khost Simple DNS lookup utility
================================== =================================
Synopsis Synopsis
-------- --------
......
.. highlight:: console .. highlight:: console
knot1to2 -- Knot DNS configuration conversion utility knot1to2 Knot DNS configuration conversion utility
===================================================== ====================================================
Synopsis Synopsis
-------- --------
......
.. highlight:: console .. highlight:: console
knotc -- Knot DNS control utility knotc Knot DNS control utility
================================= ================================
Synopsis Synopsis
-------- --------
......
.. highlight:: console .. highlight:: console
knotd -- Knot DNS server daemon knotd Knot DNS server daemon
=============================== ==============================
Synopsis Synopsis
-------- --------
......
.. highlight:: console .. highlight:: console
knsec3hash -- NSEC hash computation utility knsec3hash NSEC hash computation utility
=========================================== ==========================================
Synopsis Synopsis
-------- --------
...@@ -44,6 +44,6 @@ Examples ...@@ -44,6 +44,6 @@ Examples
See Also See Also
-------- --------
:rfc:`5155` -- DNS Security (DNSSEC) Hashed Authenticated Denial of Existence. :rfc:`5155` DNS Security (DNSSEC) Hashed Authenticated Denial of Existence.
:manpage:`knotc(8)`, :manpage:`knotd(8)`. :manpage:`knotc(8)`, :manpage:`knotd(8)`.
.. highlight:: console .. highlight:: console
knsupdate -- Dynamic DNS update utility knsupdate Dynamic DNS update utility
======================================= ======================================
Synopsis Synopsis
-------- --------
......
...@@ -16,20 +16,20 @@ that not all of the features are supported. ...@@ -16,20 +16,20 @@ that not all of the features are supported.
For the description of configuration items, we have to declare a meaning of For the description of configuration items, we have to declare a meaning of
the following symbols: the following symbols:
- *INT* -- Integer - *INT* Integer
- *STR* -- Textual string - *STR* Textual string
- *HEXSTR* -- Hexadecimal string (with ``0x`` prefix) - *HEXSTR* Hexadecimal string (with ``0x`` prefix)
- *BOOL* -- Boolean value (``on``/``off`` or ``true``/``false``) - *BOOL* Boolean value (``on``/``off`` or ``true``/``false``)
- *TIME* -- Number of seconds, an integer with possible time multiplier suffix - *TIME* Number of seconds, an integer with possible time multiplier suffix
(``s`` ~ 1, ``m`` ~ 60, ``h`` ~ 3600 or ``d`` ~ 24 * 3600) (``s`` ~ 1, ``m`` ~ 60, ``h`` ~ 3600 or ``d`` ~ 24 * 3600)
- *SIZE* -- Number of bytes, an integer with possible size multiplier suffix - *SIZE* Number of bytes, an integer with possible size multiplier suffix
(``B`` ~ 1, ``K`` ~ 1024, ``M`` ~ 1024^2 or ``G`` ~ 1024^3) (``B`` ~ 1, ``K`` ~ 1024, ``M`` ~ 1024^2 or ``G`` ~ 1024^3)
- *BASE64* -- Base64 encoded string - *BASE64* Base64 encoded string
- *ADDR* -- IPv4 or IPv6 address - *ADDR* IPv4 or IPv6 address
- *DNAME* -- Domain name - *DNAME* Domain name
- ... -- Multi-valued item, order of the values is preserved - ... Multi-valued item, order of the values is preserved
- [ ] -- Optional value - [ ] Optional value
- \| -- Choice - \| Choice
There are 8 main sections (``server``, ``key``, ``acl``, ``control``, There are 8 main sections (``server``, ``key``, ``acl``, ``control``,
``remote``, ``template``, ``zone`` and ``log``) and module sections with the ``remote``, ``template``, ``zone`` and ``log``) and module sections with the
...@@ -402,10 +402,10 @@ An ordered list of allowed actions. ...@@ -402,10 +402,10 @@ An ordered list of allowed actions.
Possible values: Possible values:
- ``transfer`` -- Allow zone transfer - ``transfer`` Allow zone transfer
- ``notify`` -- Allow incoming notify - ``notify`` Allow incoming notify
- ``update`` -- Allow zone updates - ``update`` Allow zone updates
- ``control`` -- Allow remote control - ``control`` Allow remote control
Default: empty Default: empty
...@@ -590,11 +590,11 @@ file ...@@ -590,11 +590,11 @@ file
A path to the zone file. Non absolute path is relative to A path to the zone file. Non absolute path is relative to
:ref:`storage<zone_storage>`. It is also possible to use the following formatters: :ref:`storage<zone_storage>`. It is also possible to use the following formatters:
- ``%s`` -- means the current zone name in the textual representation (beware - ``%s`` means the current zone name in the textual representation (beware
of special characters which are escaped or encoded in the \\DDD form where of special characters which are escaped or encoded in the \\DDD form where
DDD is corresponding decimal ASCII code). The zone name doesn't include the DDD is corresponding decimal ASCII code). The zone name doesn't include the
terminating dot, except for the root zone. terminating dot, except for the root zone.
- ``%%`` -- means the ``%`` character - ``%%`` means the ``%`` character
Default: :ref:`storage<zone_storage>`/``%s``\ .zone Default: :ref:`storage<zone_storage>`/``%s``\ .zone
...@@ -770,8 +770,8 @@ no change is made. ...@@ -770,8 +770,8 @@ no change is made.
Possible values: Possible values:
- ``increment`` -- The serial is incremented according to serial number arithmetic - ``increment`` The serial is incremented according to serial number arithmetic
- ``unixtime`` -- The serial is set to the current unix time - ``unixtime`` The serial is set to the current unix time
*Caution:* If your serial was in other than unix time format, be careful *Caution:* If your serial was in other than unix time format, be careful
with the transition to unix time. It may happen that the new serial will with the transition to unix time. It may happen that the new serial will
...@@ -801,17 +801,17 @@ file. ...@@ -801,17 +801,17 @@ file.
There are 6 logging severity levels: There are 6 logging severity levels:
- ``critical`` -- Non-recoverable error resulting in server shutdown - ``critical`` Non-recoverable error resulting in server shutdown
- ``error`` -- Recoverable error, action should be taken - ``error`` Recoverable error, action should be taken
- ``warning`` -- Warning that might require user action - ``warning`` Warning that might require user action
- ``notice`` -- Server notice or hint - ``notice`` Server notice or hint
- ``info`` -- Informational message - ``info`` Informational message
- ``debug`` -- Debug messages (must be turned on at compile time) - ``debug`` Debug messages (must be turned on at compile time)
In the case of missing log section, ``warning`` or more serious messages In the case of missing log section, ``warning`` or more serious messages
will be logged to both standard error output and syslog. The ``info`` and will be logged to both standard error output and syslog. The ``info`` and
...@@ -834,10 +834,10 @@ A logging output. ...@@ -834,10 +834,10 @@ A logging output.
Possible values: Possible values:
- ``stdout`` -- Standard output - ``stdout`` Standard output
- ``stderr`` -- Standard error output - ``stderr`` Standard error output
- ``syslog`` -- Syslog - ``syslog`` Syslog
- *file\_name* -- File - *file\_name* File
.. _log_server: .. _log_server:
...@@ -934,8 +934,8 @@ The type of generated records. ...@@ -934,8 +934,8 @@ The type of generated records.
Possible values: Possible values:
- ``forward`` -- Forward records - ``forward`` Forward records
- ``reverse`` -- Reverse records - ``reverse`` Reverse records
Default: empty Default: empty
......
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