diff --git a/doc/conf.py b/doc/conf.py index 7b74da309e453f55e2929a81a7d4da99e32468a4..0f00e3d5b9408b5e2756fe0f7e3564f3e1705642 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -129,7 +129,7 @@ html_logo = 'logo.png' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +html_use_smartypants = False # Custom sidebar templates, maps document names to template names. #html_sidebars = {} diff --git a/doc/configuration.rst b/doc/configuration.rst index c9b8c3f5b49e1b6c98f89b6d8ca6b6fae131cc60..57166428b0cbe6b6e67ea5162988736452f23039 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -321,7 +321,7 @@ To initialize the database, run: Make sure to set the KASP database permissions correctly. For manual key management, the database must be **readable** by the server process. For 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: @@ -571,7 +571,7 @@ Query modules ============= 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 steps a *query plan*, an abstraction that groups these steps into several stages. @@ -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``) 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. You can capture either all or zone-specific queries and responses; usually @@ -611,8 +611,8 @@ a UNIX socket:: .. _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 a given prefix and subnet. @@ -702,8 +702,8 @@ Limitations since the module is hooked in the query processing plan, it will be 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 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 responded to locally. The rest of the requests will be forwarded to the 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 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: - id: 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.* * Start the server: diff --git a/doc/introduction.rst b/doc/introduction.rst index b3a784bdba7559c4a0c15cbbdfc218cab4f54d53..19f6ee76875893cce0c9c98257f4b8c90bafa01a 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -24,7 +24,7 @@ DNS features: * IN class and partially CH class * TCP/UDP protocols -* AXFR, IXFR -- master, slave +* AXFR, IXFR – master, slave * TSIG * EDNS0 * DNSSEC, including NSEC3 diff --git a/doc/man/knot.conf.5in b/doc/man/knot.conf.5in index 1a9d93cf98b124cd904394b821addf1c512c8c65..07b8976cdfb14e7584cba998ab1f892408cf09b2 100644 --- a/doc/man/knot.conf.5in +++ b/doc/man/knot.conf.5in @@ -39,31 +39,31 @@ For the description of configuration items, we have to declare a meaning of the following symbols: .INDENT 0.0 .IP \(bu 2 -\fIINT\fP \-\- Integer +\fIINT\fP – Integer .IP \(bu 2 -\fISTR\fP \-\- Textual string +\fISTR\fP – Textual string .IP \(bu 2 -\fIHEXSTR\fP \-\- Hexadecimal string (with \fB0x\fP prefix) +\fIHEXSTR\fP – Hexadecimal string (with \fB0x\fP prefix) .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 -\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) .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) .IP \(bu 2 -\fIBASE64\fP \-\- Base64 encoded string +\fIBASE64\fP – Base64 encoded string .IP \(bu 2 -\fIADDR\fP \-\- IPv4 or IPv6 address +\fIADDR\fP – IPv4 or IPv6 address .IP \(bu 2 -\fIDNAME\fP \-\- Domain name +\fIDNAME\fP – Domain name .IP \(bu 2 -\&... \-\- Multi\-valued item, order of the values is preserved +\&... – Multi\-valued item, order of the values is preserved .IP \(bu 2 -[ ] \-\- Optional value +[ ] – Optional value .IP \(bu 2 -| \-\- Choice +| – Choice .UNINDENT .sp There are 8 main sections (\fBserver\fP, \fBkey\fP, \fBacl\fP, \fBcontrol\fP, @@ -346,13 +346,13 @@ An ordered list of allowed actions. Possible values: .INDENT 0.0 .IP \(bu 2 -\fBtransfer\fP \-\- Allow zone transfer +\fBtransfer\fP – Allow zone transfer .IP \(bu 2 -\fBnotify\fP \-\- Allow incoming notify +\fBnotify\fP – Allow incoming notify .IP \(bu 2 -\fBupdate\fP \-\- Allow zone updates +\fBupdate\fP – Allow zone updates .IP \(bu 2 -\fBcontrol\fP \-\- Allow remote control +\fBcontrol\fP – Allow remote control .UNINDENT .sp Default: empty @@ -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: .INDENT 0.0 .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 DDD is corresponding decimal ASCII code). The zone name doesn\(aqt include the terminating dot, except for the root zone. .IP \(bu 2 -\fB%%\fP \-\- means the \fB%\fP character +\fB%%\fP – means the \fB%\fP character .UNINDENT .sp Default: \fI\%storage\fP/\fB%s\fP\&.zone @@ -656,9 +656,9 @@ no change is made. Possible values: .INDENT 0.0 .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 -\fBunixtime\fP \-\- The serial is set to the current unix time +\fBunixtime\fP – The serial is set to the current unix time .UNINDENT .sp \fICaution:\fP If your serial was in other than unix time format, be careful @@ -682,17 +682,17 @@ file. There are 6 logging severity levels: .INDENT 0.0 .IP \(bu 2 -\fBcritical\fP \-\- Non\-recoverable error resulting in server shutdown +\fBcritical\fP – Non\-recoverable error resulting in server shutdown .IP \(bu 2 -\fBerror\fP \-\- Recoverable error, action should be taken +\fBerror\fP – Recoverable error, action should be taken .IP \(bu 2 -\fBwarning\fP \-\- Warning that might require user action +\fBwarning\fP – Warning that might require user action .IP \(bu 2 -\fBnotice\fP \-\- Server notice or hint +\fBnotice\fP – Server notice or hint .IP \(bu 2 -\fBinfo\fP \-\- Informational message +\fBinfo\fP – Informational message .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 .sp In the case of missing log section, \fBwarning\fP or more serious messages @@ -719,13 +719,13 @@ A logging output. Possible values: .INDENT 0.0 .IP \(bu 2 -\fBstdout\fP \-\- Standard output +\fBstdout\fP – Standard output .IP \(bu 2 -\fBstderr\fP \-\- Standard error output +\fBstderr\fP – Standard error output .IP \(bu 2 -\fBsyslog\fP \-\- Syslog +\fBsyslog\fP – Syslog .IP \(bu 2 -\fIfile_name\fP \-\- File +\fIfile_name\fP – File .UNINDENT .SS server .sp @@ -800,9 +800,9 @@ The type of generated records. Possible values: .INDENT 0.0 .IP \(bu 2 -\fBforward\fP \-\- Forward records +\fBforward\fP – Forward records .IP \(bu 2 -\fBreverse\fP \-\- Reverse records +\fBreverse\fP – Reverse records .UNINDENT .sp Default: empty diff --git a/doc/man/knsec3hash.1in b/doc/man/knsec3hash.1in index 92869d9f605ac08e80a533eaf1522022f3c2fb40..9bf343a3af40227fc21a6e4d4f0e72b6b81be29a 100644 --- a/doc/man/knsec3hash.1in +++ b/doc/man/knsec3hash.1in @@ -76,7 +76,7 @@ A1RT98BS5QGC9NFI51S9HCI47ULJG6JH (salt=\-, hash=1, iterations=0) .UNINDENT .SH SEE ALSO .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 \fIknotc(8)\fP, \fIknotd(8)\fP\&. .SH AUTHOR diff --git a/doc/man_kdig.rst b/doc/man_kdig.rst index 0b2b377f7088193eac3ca388dacda48589b5ba0e..ea63e5cecaf955c47a683ccb4d5fe77ae06c4880 100644 --- a/doc/man_kdig.rst +++ b/doc/man_kdig.rst @@ -1,7 +1,7 @@ .. highlight:: console -kdig -- Advanced DNS lookup utility -=================================== +kdig – Advanced DNS lookup utility +================================== Synopsis -------- diff --git a/doc/man_keymgr.rst b/doc/man_keymgr.rst index 0dc3cf4524a652e44da11541a003c3b3f17fde5d..93af1fd447d09bf1f0c01d357b35e24b75795b84 100644 --- a/doc/man_keymgr.rst +++ b/doc/man_keymgr.rst @@ -1,7 +1,7 @@ .. highlight:: console -keymgr -- DNSSEC key management utility -======================================= +keymgr – DNSSEC key management utility +====================================== Synopsis -------- diff --git a/doc/man_khost.rst b/doc/man_khost.rst index 74e47a1ddfafc357e3cd27e101f3198eea0fbc8a..0da96d7bbdb19e884acd65f576c3fa5ecccba6a2 100644 --- a/doc/man_khost.rst +++ b/doc/man_khost.rst @@ -1,7 +1,7 @@ .. highlight:: console -khost -- Simple DNS lookup utility -================================== +khost – Simple DNS lookup utility +================================= Synopsis -------- diff --git a/doc/man_knot1to2.rst b/doc/man_knot1to2.rst index b7cc475a95e262967c8b39dd50e4d767ca6d684b..bdcd93c98815c1fd2e88a37cad6d00597413dafc 100644 --- a/doc/man_knot1to2.rst +++ b/doc/man_knot1to2.rst @@ -1,7 +1,7 @@ .. highlight:: console -knot1to2 -- Knot DNS configuration conversion utility -===================================================== +knot1to2 – Knot DNS configuration conversion utility +==================================================== Synopsis -------- diff --git a/doc/man_knotc.rst b/doc/man_knotc.rst index 1a318c3519e23fc30bcbee4572c612fe79ac44a5..9b2cfef2d29384582b75a3a2de4049175a688726 100644 --- a/doc/man_knotc.rst +++ b/doc/man_knotc.rst @@ -1,7 +1,7 @@ .. highlight:: console -knotc -- Knot DNS control utility -================================= +knotc – Knot DNS control utility +================================ Synopsis -------- diff --git a/doc/man_knotd.rst b/doc/man_knotd.rst index 0fa0ed8a59ced8135b441ec0bafeb1830755972c..86a86d8446e229efcda5ea2a847e813419bd25d4 100644 --- a/doc/man_knotd.rst +++ b/doc/man_knotd.rst @@ -1,7 +1,7 @@ .. highlight:: console -knotd -- Knot DNS server daemon -=============================== +knotd – Knot DNS server daemon +============================== Synopsis -------- diff --git a/doc/man_knsec3hash.rst b/doc/man_knsec3hash.rst index 322474ce81e9586817ae4fbe1e458016abc18088..1c2c95b5599d1ed8f14e75aff5e22be01a6bc9ec 100644 --- a/doc/man_knsec3hash.rst +++ b/doc/man_knsec3hash.rst @@ -1,7 +1,7 @@ .. highlight:: console -knsec3hash -- NSEC hash computation utility -=========================================== +knsec3hash – NSEC hash computation utility +========================================== Synopsis -------- @@ -44,6 +44,6 @@ Examples 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)`. diff --git a/doc/man_knsupdate.rst b/doc/man_knsupdate.rst index 5517096ced10490c6909e687cfd9ce8a12352862..ee70e6793ddf930f686676dfc69c100c44102192 100644 --- a/doc/man_knsupdate.rst +++ b/doc/man_knsupdate.rst @@ -1,7 +1,7 @@ .. highlight:: console -knsupdate -- Dynamic DNS update utility -======================================= +knsupdate – Dynamic DNS update utility +====================================== Synopsis -------- diff --git a/doc/reference.rst b/doc/reference.rst index dc7e227d2545ad6df8ed8ce8f7e9d46317607924..e9aca68c2bf0f4884b290aaaf4ed83a103c4aafc 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -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 the following symbols: -- *INT* -- Integer -- *STR* -- Textual string -- *HEXSTR* -- Hexadecimal string (with ``0x`` prefix) -- *BOOL* -- Boolean value (``on``/``off`` or ``true``/``false``) -- *TIME* -- Number of seconds, an integer with possible time multiplier suffix +- *INT* – Integer +- *STR* – Textual string +- *HEXSTR* – Hexadecimal string (with ``0x`` prefix) +- *BOOL* – Boolean value (``on``/``off`` or ``true``/``false``) +- *TIME* – Number of seconds, an integer with possible time multiplier suffix (``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) -- *BASE64* -- Base64 encoded string -- *ADDR* -- IPv4 or IPv6 address -- *DNAME* -- Domain name -- ... -- Multi-valued item, order of the values is preserved -- [ ] -- Optional value -- \| -- Choice +- *BASE64* – Base64 encoded string +- *ADDR* – IPv4 or IPv6 address +- *DNAME* – Domain name +- ... – Multi-valued item, order of the values is preserved +- [ ] – Optional value +- \| – Choice There are 8 main sections (``server``, ``key``, ``acl``, ``control``, ``remote``, ``template``, ``zone`` and ``log``) and module sections with the @@ -402,10 +402,10 @@ An ordered list of allowed actions. Possible values: -- ``transfer`` -- Allow zone transfer -- ``notify`` -- Allow incoming notify -- ``update`` -- Allow zone updates -- ``control`` -- Allow remote control +- ``transfer`` – Allow zone transfer +- ``notify`` – Allow incoming notify +- ``update`` – Allow zone updates +- ``control`` – Allow remote control Default: empty @@ -590,11 +590,11 @@ file 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: -- ``%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 DDD is corresponding decimal ASCII code). The zone name doesn't include the terminating dot, except for the root zone. -- ``%%`` -- means the ``%`` character +- ``%%`` – means the ``%`` character Default: :ref:`storage<zone_storage>`/``%s``\ .zone @@ -770,8 +770,8 @@ no change is made. Possible values: -- ``increment`` -- The serial is incremented according to serial number arithmetic -- ``unixtime`` -- The serial is set to the current unix time +- ``increment`` – The serial is incremented according to serial number arithmetic +- ``unixtime`` – The serial is set to the current unix time *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 @@ -801,17 +801,17 @@ file. 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 will be logged to both standard error output and syslog. The ``info`` and @@ -834,10 +834,10 @@ A logging output. Possible values: -- ``stdout`` -- Standard output -- ``stderr`` -- Standard error output -- ``syslog`` -- Syslog -- *file\_name* -- File +- ``stdout`` – Standard output +- ``stderr`` – Standard error output +- ``syslog`` – Syslog +- *file\_name* – File .. _log_server: @@ -934,8 +934,8 @@ The type of generated records. Possible values: -- ``forward`` -- Forward records -- ``reverse`` -- Reverse records +- ``forward`` – Forward records +- ``reverse`` – Reverse records Default: empty