mirror of
https://github.com/isc-projects/bind9.git
synced 2026-04-26 08:39:00 -04:00
Add link anchors to statements and blocks in the ARM
All statements now use .. namedconf:statement:: or .. rndcconf:statement:: syntax provided by our Sphinx extension. This has several consequences: - It changes how statement headings are rendered - Statements are indexed and show up as separate items in doc search results (in the HTML version) - Statements can be linked to using either :any:`statement` or :namedconf:ref:`statement` syntax (not used in this commit) - Statements can be categorized and printed using .. namedconf:statatementlist:: syntax (not used in this commit)
This commit is contained in:
parent
0d4084289b
commit
e5b7022dcb
8 changed files with 1667 additions and 1142 deletions
|
|
@ -83,6 +83,7 @@ by editing the configuration file or running
|
|||
|
||||
Configuring Catalog Zones
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.. namedconf:statement:: catalog-zones
|
||||
|
||||
Catalog zones are configured with a ``catalog-zones`` statement in the
|
||||
``options`` or ``view`` section of :iscman:`named.conf`. For example:
|
||||
|
|
|
|||
|
|
@ -170,7 +170,7 @@ the :iscman:`named.conf` file has been modified as shown:
|
|||
The added statements and clauses are commented in the above file.
|
||||
|
||||
The :ref:`zone<zone_clause>` clause, and :ref:`allow-query<allow-query>`,
|
||||
:ref:`allow-query-cache<allow-query-cache>`,
|
||||
:any:`allow-query-cache`,
|
||||
:ref:`allow-transfer<allow-transfer>`, :ref:`file<file>`,
|
||||
:ref:`notify<notify_st>`, :ref:`recursion<recursion>`, and :ref:`type<type>`
|
||||
statements are described in detail in the appropriate sections.
|
||||
|
|
@ -253,7 +253,7 @@ The :iscman:`named.conf` file has been modified as shown:
|
|||
The statements and clauses added are all commented in the above file.
|
||||
|
||||
The :ref:`zone<zone_clause>` clause, and :ref:`allow-query<allow-query>`,
|
||||
:ref:`allow-query-cache<allow-query-cache>`,
|
||||
:any:`allow-query-cache`,
|
||||
:ref:`allow-transfer<allow-transfer>`, :ref:`file<file>`,
|
||||
:ref:`notify<notify_st>`, :ref:`primaries<primaries>`,
|
||||
:ref:`recursion<recursion>`, and :ref:`type<type>` statements are described in
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@ database.
|
|||
|
||||
Configuring DLZ
|
||||
~~~~~~~~~~~~~~~
|
||||
.. namedconf:statement:: dlz
|
||||
|
||||
A DLZ database is configured with a ``dlz`` statement in :iscman:`named.conf`:
|
||||
|
||||
|
|
|
|||
|
|
@ -115,14 +115,29 @@ server.
|
|||
what associate the secret keys to the servers with which they are
|
||||
meant to be shared. The order of statements is not significant.
|
||||
|
||||
.. rndcconf:statement:: options
|
||||
|
||||
The ``options`` statement has three clauses: ``default-server``,
|
||||
``default-key``, and ``default-port``. ``default-server`` takes a
|
||||
host name or address argument and represents the server that is
|
||||
contacted if no :option:`-s <rndc -s>` option is provided on the command line.
|
||||
``default-key`` takes the name of a key as its argument, as defined
|
||||
by a ``key`` statement. ``default-port`` specifies the port to which
|
||||
:iscman:`rndc` should connect if no port is given on the command line or in
|
||||
a ``server`` statement.
|
||||
``default-key``, and ``default-port``.
|
||||
|
||||
.. rndcconf:statement:: default-server
|
||||
|
||||
``default-server`` takes a
|
||||
host name or address argument and represents the server that is
|
||||
contacted if no :option:`-s <rndc -s>` option is provided on the command line.
|
||||
|
||||
.. rndcconf:statement:: default-key
|
||||
|
||||
``default-key`` takes the name of a key as its argument, as defined
|
||||
by a ``key`` statement.
|
||||
|
||||
.. rndcconf:statement:: default-port
|
||||
|
||||
``default-port`` specifies the port to which
|
||||
:iscman:`rndc` should connect if no port is given on the command line or in
|
||||
a ``server`` statement.
|
||||
|
||||
.. rndcconf:statement:: key
|
||||
|
||||
The ``key`` statement defines a key to be used by :iscman:`rndc` when
|
||||
authenticating with :iscman:`named`. Its syntax is identical to the ``key``
|
||||
|
|
@ -130,11 +145,20 @@ server.
|
|||
name, which must be a valid domain name, though it need not actually
|
||||
be hierarchical; thus, a string like ``rndc_key`` is a valid name.
|
||||
The ``key`` statement has two clauses: ``algorithm`` and ``secret``.
|
||||
While the configuration parser accepts any string as the argument
|
||||
to ``algorithm``, currently only the strings ``hmac-md5``,
|
||||
``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``,
|
||||
``hmac-sha384``, and ``hmac-sha512`` have any meaning. The secret
|
||||
is a Base64-encoded string as specified in :rfc:`3548`.
|
||||
|
||||
.. rndcconf:statement:: algorithm
|
||||
|
||||
While the configuration parser accepts any string as the argument
|
||||
to ``algorithm``, currently only the strings ``hmac-md5``,
|
||||
``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``,
|
||||
``hmac-sha384``, and ``hmac-sha512`` have any meaning.
|
||||
|
||||
.. rndcconf:statement:: secret
|
||||
|
||||
The secret
|
||||
is a Base64-encoded string as specified in :rfc:`3548`.
|
||||
|
||||
.. rndcconf:statement:: server
|
||||
|
||||
The ``server`` statement associates a key defined using the ``key``
|
||||
statement with a server. The keyword ``server`` is followed by a host
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ with the BIND source code, in the directory
|
|||
|
||||
Configuring DynDB
|
||||
~~~~~~~~~~~~~~~~~
|
||||
.. namedconf:statement:: dyndb
|
||||
|
||||
A DynDB database is configured with a ``dyndb`` statement in
|
||||
:iscman:`named.conf`:
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ functionality.
|
|||
|
||||
Configuring Plugins
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
.. namedconf:statement:: plugin
|
||||
|
||||
A plugin is configured with the ``plugin`` statement in :iscman:`named.conf`:
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -298,8 +298,6 @@ is equivalent to
|
|||
|
||||
WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM.
|
||||
|
||||
.. _include_directive:
|
||||
|
||||
The **$INCLUDE** Directive
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue