From 78af7e54e68ea3be40853e36df258db3fb4ee920 Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Thu, 4 Jun 2020 00:24:08 +0000 Subject: [PATCH] Text edits to manual paages This commit updates the wording in following man pages: * ddns-confgen.rst * delv.rst * dig.rst * dnssec-dsfromkey.rst * dnssec-importkey.rst * dnssec-keyfromlabel.rst * dnssec-keygen.rst * dnssec-revoke.rst * dnssec-settime.rst * dnssec-signzone.rst * dnssec-verify.rst * dnstap-read.rst * filter-aaaa.rst * host.rst * mdig.rst * named-checkconf.rst * named-checkzone.rst * named-nzd2nzf.rst * named.conf.rst * named.rst * nsec3hash.rst * nsupdate.rst * pkcs11-destroy.rst * pkcs11-keygen.rst * pkcs11-list.rst * pkcs11-tokens.rst * rndc-confgen.rst * rndc.rst --- bin/check/named-checkconf.rst | 52 ++-- bin/check/named-checkzone.rst | 213 +++++++-------- bin/confgen/ddns-confgen.rst | 42 +-- bin/confgen/rndc-confgen.rst | 72 +++--- bin/delv/delv.rst | 178 ++++++------- bin/dig/dig.rst | 398 ++++++++++++++--------------- bin/dig/host.rst | 134 +++++----- bin/dig/nslookup.rst | 146 +++++------ bin/dnssec/dnssec-dsfromkey.rst | 76 +++--- bin/dnssec/dnssec-importkey.rst | 74 +++--- bin/dnssec/dnssec-keyfromlabel.rst | 2 +- bin/dnssec/dnssec-keygen.rst | 2 +- bin/dnssec/dnssec-settime.rst | 174 ++++++------- bin/dnssec/dnssec-signzone.rst | 333 ++++++++++++------------ bin/dnssec/dnssec-verify.rst | 78 +++--- bin/named/named.conf.rst | 6 +- bin/named/named.rst | 150 +++++------ bin/nsupdate/nsupdate.rst | 258 +++++++++---------- bin/pkcs11/pkcs11-destroy.rst | 34 +-- bin/pkcs11/pkcs11-keygen.rst | 58 ++--- bin/pkcs11/pkcs11-list.rst | 34 +-- bin/pkcs11/pkcs11-tokens.rst | 12 +- bin/plugins/filter-aaaa.rst | 22 +- bin/rndc/rndc.rst | 100 ++++---- bin/tools/dnstap-read.rst | 4 +- 25 files changed, 1319 insertions(+), 1333 deletions(-) diff --git a/bin/check/named-checkconf.rst b/bin/check/named-checkconf.rst index 36a8c1daa5..7b49f2a324 100644 --- a/bin/check/named-checkconf.rst +++ b/bin/check/named-checkconf.rst @@ -35,62 +35,62 @@ Description ~~~~~~~~~~~ ``named-checkconf`` checks the syntax, but not the semantics, of a -``named`` configuration file. The file is parsed and checked for syntax -errors, along with all files included by it. If no file is specified, +``named`` configuration file. The file, along with all files included by it, is parsed and checked for syntax +errors. If no file is specified, ``/etc/named.conf`` is read by default. Note: files that ``named`` reads in separate parser contexts, such as ``rndc.key`` and ``bind.keys``, are not automatically read by ``named-checkconf``. Configuration errors in these files may cause ``named`` to fail to run, even if ``named-checkconf`` was successful. -``named-checkconf`` can be run on these files explicitly, however. +However, ``named-checkconf`` can be run on these files explicitly. Options ~~~~~~~ -**-h** - Print the usage summary and exit. +``-h`` + This option prints the usage summary and exits. -**-j** - When loading a zonefile read the journal if it exists. +``-j`` + When loading a zonefile, this option instructs ``named`` to read the journal if it exists. -**-l** - List all the configured zones. Each line of output contains the zone +``-l`` + This option lists all the configured zones. Each line of output contains the zone name, class (e.g. IN), view, and type (e.g. primary or secondary). -**-c** - Check "core" configuration only. This suppresses the loading of +``-c`` + This option specifies that only the "core" configuration should be checked. This suppresses the loading of plugin modules, and causes all parameters to ``plugin`` statements to be ignored. -**-i** - Ignore warnings on deprecated options. +``-i`` + This option ignores warnings on deprecated options. -**-p** - Print out the ``named.conf`` and included files in canonical form if +``-p`` + This option prints out the ``named.conf`` and included files in canonical form if no errors were detected. See also the ``-x`` option. -**-t** directory - Chroot to ``directory`` so that include directives in the +``-t directory`` + This option instructs ``named`` to chroot to ``directory``, so that ``include`` directives in the configuration file are processed as if run by a similarly chrooted ``named``. -**-v** - Print the version of the ``named-checkconf`` program and exit. +``-v`` + This option prints the version of the ``named-checkconf`` program and exits. -**-x** - When printing the configuration files in canonical form, obscure +``-x`` + When printing the configuration files in canonical form, this option obscures shared secrets by replacing them with strings of question marks - ('?'). This allows the contents of ``named.conf`` and related files + (``?``). This allows the contents of ``named.conf`` and related files to be shared - for example, when submitting bug reports - without compromising private data. This option cannot be used without ``-p``. -**-z** - Perform a test load of all zones of type ``primary`` found in ``named.conf``. +``-z`` + This option performs a test load of all zones of type ``primary`` found in ``named.conf``. -filename - The name of the configuration file to be checked. If not specified, +``filename`` + This indicates the name of the configuration file to be checked. If not specified, it defaults to ``/etc/named.conf``. Return Values diff --git a/bin/check/named-checkzone.rst b/bin/check/named-checkzone.rst index ee39e5e991..7b0e74e1f7 100644 --- a/bin/check/named-checkzone.rst +++ b/bin/check/named-checkzone.rst @@ -43,163 +43,164 @@ configuring them into a name server. ``named-compilezone`` is similar to ``named-checkzone``, but it always dumps the zone contents to a specified file in a specified format. -Additionally, it applies stricter check levels by default, since the -dump output will be used as an actual zone file loaded by ``named``. +It also applies stricter check levels by default, since the +dump output is used as an actual zone file loaded by ``named``. When manually specified otherwise, the check levels must at least be as strict as those specified in the ``named`` configuration file. Options ~~~~~~~ -**-d** - Enable debugging. +``-d`` + This option enables debugging. -**-h** - Print the usage summary and exit. +``-h`` + This option prints the usage summary and exits. -**-q** - Quiet mode - exit code only. +``-q`` + This option sets quiet mode, which only sets an exit code to indicate + successful or failed completion. -**-v** - Print the version of the ``named-checkzone`` program and exit. +``-v`` + This option prints the version of the ``named-checkzone`` program and exits. -**-j** - When loading a zone file, read the journal if it exists. The journal - file name is assumed to be the zone file name appended with the - string ``.jnl``. +``-j`` + When loading a zone file, this option tells ``named`` to read the journal if it exists. The journal + file name is assumed to be the zone file name with the + string ``.jnl`` appended. -**-J** filename - When loading the zone file read the journal from the given file, if - it exists. (Implies -j.) +``-J filename`` + When loading the zone file, this option tells ``named`` to read the journal from the given file, if + it exists. This implies ``-j``. -**-c** class - Specify the class of the zone. If not specified, "IN" is assumed. +``-c class`` + This option specifies the class of the zone. If not specified, ``IN`` is assumed. -**-i** mode - Perform post-load zone integrity checks. Possible modes are - ``"full"`` (default), ``"full-sibling"``, ``"local"``, - ``"local-sibling"`` and ``"none"``. +``-i mode`` + This option performs post-load zone integrity checks. Possible modes are + ``full`` (the default), ``full-sibling``, ``local``, + ``local-sibling``, and ``none``. - Mode ``"full"`` checks that MX records refer to A or AAAA record - (both in-zone and out-of-zone hostnames). Mode ``"local"`` only + Mode ``full`` checks that MX records refer to A or AAAA records + (both in-zone and out-of-zone hostnames). Mode ``local`` only checks MX records which refer to in-zone hostnames. - Mode ``"full"`` checks that SRV records refer to A or AAAA record - (both in-zone and out-of-zone hostnames). Mode ``"local"`` only + Mode ``full`` checks that SRV records refer to A or AAAA records + (both in-zone and out-of-zone hostnames). Mode ``local`` only checks SRV records which refer to in-zone hostnames. - Mode ``"full"`` checks that delegation NS records refer to A or AAAA - record (both in-zone and out-of-zone hostnames). It also checks that + Mode ``full`` checks that delegation NS records refer to A or AAAA + records (both in-zone and out-of-zone hostnames). It also checks that glue address records in the zone match those advertised by the child. - Mode ``"local"`` only checks NS records which refer to in-zone - hostnames or that some required glue exists, that is when the - nameserver is in a child zone. + Mode ``local`` only checks NS records which refer to in-zone + hostnames or verifies that some required glue exists, i.e., when the + name server is in a child zone. - Mode ``"full-sibling"`` and ``"local-sibling"`` disable sibling glue - checks but are otherwise the same as ``"full"`` and ``"local"`` + Modes ``full-sibling`` and ``local-sibling`` disable sibling glue + checks, but are otherwise the same as ``full`` and ``local``, respectively. - Mode ``"none"`` disables the checks. + Mode ``none`` disables the checks. -**-f** format - Specify the format of the zone file. Possible formats are ``"text"`` - (default), ``"raw"``, and ``"map"``. +``-f format`` + This option specifies the format of the zone file. Possible formats are ``text`` + (the default), ``raw``, and ``map``. -**-F** format - Specify the format of the output file specified. For - ``named-checkzone``, this does not cause any effects unless it dumps +``-F format`` + This option specifies the format of the output file specified. For + ``named-checkzone``, this does not have any effect unless it dumps the zone contents. - Possible formats are ``"text"`` (default), which is the standard - textual representation of the zone, and ``"map"``, ``"raw"``, and - ``"raw=N"``, which store the zone in a binary format for rapid - loading by ``named``. ``"raw=N"`` specifies the format version of the - raw zone file: if N is 0, the raw file can be read by any version of - ``named``; if N is 1, the file can be read by release 9.9.0 or - higher; the default is 1. + Possible formats are ``text`` (the default), which is the standard + textual representation of the zone, and ``map``, ``raw``, and + ``raw=N``, which store the zone in a binary format for rapid + loading by ``named``. ``raw=N`` specifies the format version of the + raw zone file: if ``N`` is 0, the raw file can be read by any version of + ``named``; if N is 1, the file can only be read by release 9.9.0 or + higher. The default is 1. -**-k** mode - Perform ``"check-names"`` checks with the specified failure mode. - Possible modes are ``"fail"`` (default for ``named-compilezone``), - ``"warn"`` (default for ``named-checkzone``) and ``"ignore"``. +``-k mode`` + This option performs ``check-names`` checks with the specified failure mode. + Possible modes are ``fail`` (the default for ``named-compilezone``), + ``warn`` (the default for ``named-checkzone``), and ``ignore``. -**-l** ttl - Sets a maximum permissible TTL for the input file. Any record with a - TTL higher than this value will cause the zone to be rejected. This +``-l ttl`` + This option sets a maximum permissible TTL for the input file. Any record with a + TTL higher than this value causes the zone to be rejected. This is similar to using the ``max-zone-ttl`` option in ``named.conf``. -**-L** serial - When compiling a zone to "raw" or "map" format, set the "source - serial" value in the header to the specified serial number. (This is - expected to be used primarily for testing purposes.) +``-L serial`` + When compiling a zone to ``raw`` or ``map`` format, this option sets the "source + serial" value in the header to the specified serial number. This is + expected to be used primarily for testing purposes. -**-m** mode - Specify whether MX records should be checked to see if they are - addresses. Possible modes are ``"fail"``, ``"warn"`` (default) and - ``"ignore"``. +``-m mode`` + This option specifies whether MX records should be checked to see if they are + addresses. Possible modes are ``fail``, ``warn`` (the default), and + ``ignore``. -**-M** mode - Check if a MX record refers to a CNAME. Possible modes are - ``"fail"``, ``"warn"`` (default) and ``"ignore"``. +``-M mode`` + This option checks whether a MX record refers to a CNAME. Possible modes are + ``fail``, ``warn`` (the default), and ``ignore``. -**-n** mode - Specify whether NS records should be checked to see if they are - addresses. Possible modes are ``"fail"`` (default for - ``named-compilezone``), ``"warn"`` (default for ``named-checkzone``) - and ``"ignore"``. +``-n mode`` + This option specifies whether NS records should be checked to see if they are + addresses. Possible modes are ``fail`` (the default for + ``named-compilezone``), ``warn`` (the default for ``named-checkzone``), + and ``ignore``. -**-o** filename - Write zone output to ``filename``. If ``filename`` is ``-`` then - write to standard out. This is mandatory for ``named-compilezone``. +``-o filename`` + This option writes the zone output to ``filename``. If ``filename`` is ``-``, then + the zone output is written to standard output. This is mandatory for ``named-compilezone``. -**-r** mode - Check for records that are treated as different by DNSSEC but are - semantically equal in plain DNS. Possible modes are ``"fail"``, - ``"warn"`` (default) and ``"ignore"``. +``-r mode`` + This option checks for records that are treated as different by DNSSEC but are + semantically equal in plain DNS. Possible modes are ``fail``, + ``warn`` (the default), and ``ignore``. -**-s** style - Specify the style of the dumped zone file. Possible styles are - ``"full"`` (default) and ``"relative"``. The full format is most - suitable for processing automatically by a separate script. On the - other hand, the relative format is more human-readable and is thus - suitable for editing by hand. For ``named-checkzone`` this does not - cause any effects unless it dumps the zone contents. It also does not +``-s style`` + This option specifies the style of the dumped zone file. Possible styles are + ``full`` (the default) and ``relative``. The ``full`` format is most + suitable for processing automatically by a separate script. + The relative format is more human-readable and is thus + suitable for editing by hand. For ``named-checkzone``, this does not + have any effect unless it dumps the zone contents. It also does not have any meaning if the output format is not text. -**-S** mode - Check if a SRV record refers to a CNAME. Possible modes are - ``"fail"``, ``"warn"`` (default) and ``"ignore"``. +``-S mode`` + This option checks whether an SRV record refers to a CNAME. Possible modes are + ``fail``, ``warn`` (the default), and ``ignore``. -**-t** directory - Chroot to ``directory`` so that include directives in the +``-t directory`` + This option tells ``named`` to chroot to ``directory``, so that ``include`` directives in the configuration file are processed as if run by a similarly chrooted ``named``. -**-T** mode - Check if Sender Policy Framework (SPF) records exist and issues a +``-T mode`` + This option checks whether Sender Policy Framework (SPF) records exist and issues a warning if an SPF-formatted TXT record is not also present. Possible - modes are ``"warn"`` (default), ``"ignore"``. + modes are ``warn`` (the default) and ``ignore``. -**-w** directory - chdir to ``directory`` so that relative filenames in master file - $INCLUDE directives work. This is similar to the directory clause in +``-w directory`` + This option instructs ``named`` to chdir to ``directory``, so that relative filenames in master file + ``$INCLUDE`` directives work. This is similar to the directory clause in ``named.conf``. -**-D** - Dump zone file in canonical format. This is always enabled for +``-D`` + This option dumps the zone file in canonical format. This is always enabled for ``named-compilezone``. -**-W** mode - Specify whether to check for non-terminal wildcards. Non-terminal +``-W mode`` + This option specifies whether to check for non-terminal wildcards. Non-terminal wildcards are almost always the result of a failure to understand the - wildcard matching algorithm (:rfc:`1034`). Possible modes are ``"warn"`` - (default) and ``"ignore"``. + wildcard matching algorithm (:rfc:`1034`). Possible modes are ``warn`` + (the default) and ``ignore``. -zonename - The domain name of the zone being checked. +``zonename`` + This indicates the domain name of the zone being checked. -filename - The name of the zone file. +``filename`` + This is the name of the zone file. Return Values ~~~~~~~~~~~~~ diff --git a/bin/confgen/ddns-confgen.rst b/bin/confgen/ddns-confgen.rst index e0033e5cb9..5380c8a714 100644 --- a/bin/confgen/ddns-confgen.rst +++ b/bin/confgen/ddns-confgen.rst @@ -41,17 +41,17 @@ can be used, for example, to secure dynamic DNS updates to a zone or for the ``rndc`` command channel. When run as ``tsig-keygen``, a domain name can be specified on the -command line which will be used as the name of the generated key. If no +command line to be used as the name of the generated key. If no name is specified, the default is ``tsig-key``. When run as ``ddns-confgen``, the generated key is accompanied by configuration text and instructions that can be used with ``nsupdate`` and ``named`` when setting up dynamic DNS, including an example -``update-policy`` statement. (This usage similar to the ``rndc-confgen`` -command for setting up command channel security.) +``update-policy`` statement. (This usage is similar to the ``rndc-confgen`` +command for setting up command-channel security.) Note that ``named`` itself can configure a local DDNS key for use with -``nsupdate -l``: it does this when a zone is configured with +``nsupdate -l``; it does this when a zone is configured with ``update-policy local;``. ``ddns-confgen`` is only needed when a more elaborate configuration is required: for instance, if ``nsupdate`` is to be used from a remote system. @@ -59,40 +59,40 @@ be used from a remote system. Options ~~~~~~~ -**-a** algorithm - Specifies the algorithm to use for the TSIG key. Available choices - are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and +``-a algorithm`` + This option specifies the algorithm to use for the TSIG key. Available choices + are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, and hmac-sha512. The default is hmac-sha256. Options are case-insensitive, and the "hmac-" prefix may be omitted. -**-h** - Prints a short summary of options and arguments. +``-h`` + This option prints a short summary of options and arguments. -**-k** keyname - Specifies the key name of the DDNS authentication key. The default is +``-k keyname`` + This option specifies the key name of the DDNS authentication key. The default is ``ddns-key`` when neither the ``-s`` nor ``-z`` option is specified; otherwise, the default is ``ddns-key`` as a separate label followed by the argument of the option, e.g., ``ddns-key.example.com.`` The key name must have the format of a valid domain name, consisting of - letters, digits, hyphens and periods. + letters, digits, hyphens, and periods. -**-q** - (``ddns-confgen`` only.) Quiet mode: Print only the key, with no - explanatory text or usage examples; This is essentially identical to +``-q`` (``ddns-confgen`` only) + This option enables quiet mode, which prints only the key, with no + explanatory text or usage examples. This is essentially identical to ``tsig-keygen``. -**-s** name - (``ddns-confgen`` only.) Generate configuration example to allow +``-s name`` (``ddns-confgen`` only) + This option generates a configuration example to allow dynamic updates of a single hostname. The example ``named.conf`` text shows how to set an update policy for the specified name using the - "name" nametype. The default key name is ddns-key.name. Note that the + "name" nametype. The default key name is ``ddns-key.name``. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the ``-z`` option. -**-z** zone - (``ddns-confgen`` only.) Generate configuration example to allow - dynamic updates of a zone: The example ``named.conf`` text shows how +``-z zone`` (``ddns-confgen`` only) + This option generates a configuration example to allow + dynamic updates of a zone. The example ``named.conf`` text shows how to set an update policy for the specified zone using the "zonesub" nametype, allowing updates to all subdomain names within that zone. This option cannot be used with the ``-s`` option. diff --git a/bin/confgen/rndc-confgen.rst b/bin/confgen/rndc-confgen.rst index c1c53b5519..e69b9f62c4 100644 --- a/bin/confgen/rndc-confgen.rst +++ b/bin/confgen/rndc-confgen.rst @@ -41,79 +41,75 @@ by hand. Alternatively, it can be run with the ``-a`` option to set up a ``rndc.key`` file and avoid the need for a ``rndc.conf`` file and a ``controls`` statement altogether. -Arguments -~~~~~~~~~ +Options +~~~~~~~ -**-a** - Do automatic ``rndc`` configuration. This creates a file ``rndc.key`` - in ``/etc`` (or whatever ``sysconfdir`` was specified as when BIND +``-a`` + This option sets automatic ``rndc`` configuration, which creates a file ``rndc.key`` + in ``/etc`` (or a different ``sysconfdir`` specified when BIND was built) that is read by both ``rndc`` and ``named`` on startup. The ``rndc.key`` file defines a default command channel and authentication key allowing ``rndc`` to communicate with ``named`` on the local host with no further configuration. - Running ``rndc-confgen -a`` allows BIND 9 and ``rndc`` to be used as - drop-in replacements for BIND 8 and ``ndc``, with no changes to the - existing BIND 8 ``named.conf`` file. - If a more elaborate configuration than that generated by ``rndc-confgen -a`` is required, for example if rndc is to be used - remotely, you should run ``rndc-confgen`` without the ``-a`` option - and set up a ``rndc.conf`` and ``named.conf`` as directed. + remotely, run ``rndc-confgen`` without the ``-a`` option + and set up ``rndc.conf`` and ``named.conf`` as directed. -**-A** algorithm - Specifies the algorithm to use for the TSIG key. Available choices - are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384 and +``-A algorithm`` + This option specifies the algorithm to use for the TSIG key. Available choices + are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, and hmac-sha512. The default is hmac-sha256. -**-b** keysize - Specifies the size of the authentication key in bits. Must be between +``-b keysize`` + This option specifies the size of the authentication key in bits. The size must be between 1 and 512 bits; the default is the hash size. -**-c** keyfile - Used with the ``-a`` option to specify an alternate location for +``-c keyfile`` + This option is used with the ``-a`` option to specify an alternate location for ``rndc.key``. -**-h** - Prints a short summary of the options and arguments to +``-h`` + This option prints a short summary of the options and arguments to ``rndc-confgen``. -**-k** keyname - Specifies the key name of the rndc authentication key. This must be a +``-k keyname`` + This option specifies the key name of the ``rndc`` authentication key. This must be a valid domain name. The default is ``rndc-key``. -**-p** port - Specifies the command channel port where ``named`` listens for +``-p port`` + This option specifies the command channel port where ``named`` listens for connections from ``rndc``. The default is 953. -**-q** - Omits printing written path in automatic configuration mode. +``-q`` + This option prevets printing the written path in automatic configuration mode. -**-s** address - Specifies the IP address where ``named`` listens for command channel +``-s address`` + This option specifies the IP address where ``named`` listens for command-channel connections from ``rndc``. The default is the loopback address 127.0.0.1. -**-t** chrootdir - Used with the ``-a`` option to specify a directory where ``named`` - will run chrooted. An additional copy of the ``rndc.key`` will be - written relative to this directory so that it will be found by the +``-t chrootdir`` + This option is used with the ``-a`` option to specify a directory where ``named`` + runs chrooted. An additional copy of the ``rndc.key`` is + written relative to this directory, so that it is found by the chrooted ``named``. -**-u** user - Used with the ``-a`` option to set the owner of the ``rndc.key`` file - generated. If ``-t`` is also specified only the file in the chroot +``-u user`` + This option is used with the ``-a`` option to set the owner of the generated ``rndc.key`` file. + If ``-t`` is also specified, only the file in the chroot area has its owner changed. Examples ~~~~~~~~ -To allow ``rndc`` to be used with no manual configuration, run +To allow ``rndc`` to be used with no manual configuration, run: ``rndc-confgen -a`` -To print a sample ``rndc.conf`` file and corresponding ``controls`` and -``key`` statements to be manually inserted into ``named.conf``, run +To print a sample ``rndc.conf`` file and the corresponding ``controls`` and +``key`` statements to be manually inserted into ``named.conf``, run: ``rndc-confgen`` diff --git a/bin/delv/delv.rst b/bin/delv/delv.rst index e1b10dce6e..5b4374b2fa 100644 --- a/bin/delv/delv.rst +++ b/bin/delv/delv.rst @@ -43,15 +43,15 @@ Description ``delv`` is a tool for sending DNS queries and validating the results, using the same internal resolver and validator logic as ``named``. -``delv`` will send to a specified name server all queries needed to +``delv`` sends to a specified name server all queries needed to fetch and validate the requested data; this includes the original -requested query, subsequent queries to follow CNAME or DNAME chains, and +requested query, subsequent queries to follow CNAME or DNAME chains, queries for DNSKEY, and DS records to establish a chain of trust for DNSSEC validation. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding. -By default, responses are validated using built-in DNSSEC trust anchor +By default, responses are validated using the built-in DNSSEC trust anchor for the root zone ("."). Records returned by ``delv`` are either fully validated or were not signed. If validation fails, an explanation of the failure is included in the output; the validation process can be traced @@ -59,13 +59,13 @@ in detail. Because ``delv`` does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy. -Unless it is told to query a specific name server, ``delv`` will try +Unless it is told to query a specific name server, ``delv`` tries each of the servers listed in ``/etc/resolv.conf``. If no usable server -addresses are found, ``delv`` will send queries to the localhost +addresses are found, ``delv`` sends queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6). -When no command line arguments or options are given, ``delv`` will -perform an NS query for "." (the root zone). +When no command-line arguments or options are given, ``delv`` +performs an NS query for "." (the root zone). Simple Usage ~~~~~~~~~~~~ @@ -89,109 +89,109 @@ where: If no ``server`` argument is provided, ``delv`` consults ``/etc/resolv.conf``; if an address is found there, it queries the name server at that address. If either of the ``-4`` or ``-6`` - options are in use, then only addresses for the corresponding - transport will be tried. If no usable addresses are found, ``delv`` - will send queries to the localhost addresses (127.0.0.1 for IPv4, ::1 + options is in use, then only addresses for the corresponding + transport are tried. If no usable addresses are found, ``delv`` + sends queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6). ``name`` is the domain name to be looked up. ``type`` - indicates what type of query is required MDASH ANY, A, MX, etc. + indicates what type of query is required - ANY, A, MX, etc. ``type`` can be any valid query type. If no ``type`` argument is - supplied, ``delv`` will perform a lookup for an A record. + supplied, ``delv`` performs a lookup for an A record. Options ~~~~~~~ -**-a** anchor-file - Specifies a file from which to read DNSSEC trust anchors. The default +``-a anchor-file`` + This option specifies a file from which to read DNSSEC trust anchors. The default is ``/etc/bind.keys``, which is included with BIND 9 and contains one or more trust anchors for the root zone ("."). Keys that do not match the root zone name are ignored. An alternate key name can be specified using the ``+root=NAME`` options. - Note: When reading the trust anchor file, ``delv`` treat ``trust-anchors`` - ``initial-key`` and ``static-key`` identically. That is, for a managed key, + Note: When reading the trust anchor file, ``delv`` treats ``trust-anchors``, + ``initial-key``, and ``static-key`` identically. That is, for a managed key, it is the *initial* key that is trusted; :rfc:`5011` key management is not - supported. ``delv`` will not consult the managed-keys database maintained by - ``named``. This means that if either of the keys in ``/etc/bind.keys`` is - revoked and rolled over, it will be necessary to update ``/etc/bind.keys`` to + supported. ``delv`` does not consult the managed-keys database maintained by + ``named``, which means that if either of the keys in ``/etc/bind.keys`` is + revoked and rolled over, ``/etc/bind.keys`` must be updated to use DNSSEC validation in ``delv``. -**-b** address - Sets the source IP address of the query to ``address``. This must be - a valid address on one of the host's network interfaces or "0.0.0.0" - or "::". An optional source port may be specified by appending - "#" +``-b address`` + This option sets the source IP address of the query to ``address``. This must be + a valid address on one of the host's network interfaces, or ``0.0.0.0``, + or ``::``. An optional source port may be specified by appending + ``#`` -**-c** class - Sets the query class for the requested data. Currently, only class +``-c class`` + This option sets the query class for the requested data. Currently, only class "IN" is supported in ``delv`` and any other value is ignored. -**-d** level - Set the systemwide debug level to ``level``. The allowed range is +``-d level`` + This option sets the systemwide debug level to ``level``. The allowed range is from 0 to 99. The default is 0 (no debugging). Debugging traces from ``delv`` become more verbose as the debug level increases. See the ``+mtrace``, ``+rtrace``, and ``+vtrace`` options below for additional debugging details. -**-h** - Display the ``delv`` help usage output and exit. +``-h`` + This option displays the ``delv`` help usage output and exits. -**-i** - Insecure mode. This disables internal DNSSEC validation. (Note, - however, this does not set the CD bit on upstream queries. If the - server being queried is performing DNSSEC validation, then it will +``-i`` + This option sets insecure mode, which disables internal DNSSEC validation. (Note, + however, that this does not set the CD bit on upstream queries. If the + server being queried is performing DNSSEC validation, then it does not return invalid data; this can cause ``delv`` to time out. When it is necessary to examine invalid data to debug a DNSSEC problem, use ``dig +cd``.) -**-m** - Enables memory usage debugging. +``-m`` + This option enables memory usage debugging. -**-p** port# - Specifies a destination port to use for queries instead of the - standard DNS port number 53. This option would be used with a name +``-p port#`` + This option specifies a destination port to use for queries, instead of the + standard DNS port number 53. This option is used with a name server that has been configured to listen for queries on a non-standard port number. -**-q** name - Sets the query name to ``name``. While the query name can be - specified without using the ``-q``, it is sometimes necessary to +``-q name`` + This option sets the query name to ``name``. While the query name can be + specified without using the ``-q`` option, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH). -**-t** type - Sets the query type to ``type``, which can be any valid query type +``-t type`` + This option sets the query type to ``type``, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR. As - with ``-q``, this is useful to distinguish query name type or class - when they are ambiguous. it is sometimes necessary to disambiguate + with ``-q``, this is useful to distinguish query-name types or classes + when they are ambiguous. It is sometimes necessary to disambiguate names from types. The default query type is "A", unless the ``-x`` option is supplied to indicate a reverse lookup, in which case it is "PTR". -**-v** - Print the ``delv`` version and exit. +``-v`` + This option prints the ``delv`` version and exits. -**-x** addr - Performs a reverse lookup, mapping an addresses to a name. ``addr`` +``-x addr`` + This option performs a reverse lookup, mapping an address to a name. ``addr`` is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 address. When ``-x`` is used, there is no need to provide the - ``name`` or ``type`` arguments. ``delv`` automatically performs a + ``name`` or ``type`` arguments; ``delv`` automatically performs a lookup for a name like ``11.12.13.10.in-addr.arpa`` and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -**-4** - Forces ``delv`` to only use IPv4. +``-4`` + This option forces ``delv`` to only use IPv4. -**-6** - Forces ``delv`` to only use IPv6. +``-6`` + This option forces ``delv`` to only use IPv6. Query Options ~~~~~~~~~~~~~ @@ -206,122 +206,122 @@ assign values to options like the timeout interval. They have the form ``+keyword=value``. The query options are: ``+[no]cdflag`` - Controls whether to set the CD (checking disabled) bit in queries + This option controls whether to set the CD (checking disabled) bit in queries sent by ``delv``. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver. A validating resolver - will block invalid responses, making it difficult to retrieve them - for analysis. Setting the CD flag on queries will cause the resolver + blocks invalid responses, making it difficult to retrieve them + for analysis. Setting the CD flag on queries causes the resolver to return invalid responses, which ``delv`` can then validate internally and report the errors in detail. ``+[no]class`` - Controls whether to display the CLASS when printing a record. The + This option controls whether to display the CLASS when printing a record. The default is to display the CLASS. ``+[no]ttl`` - Controls whether to display the TTL when printing a record. The + This option controls whether to display the TTL when printing a record. The default is to display the TTL. ``+[no]rtrace`` - Toggle resolver fetch logging. This reports the name and type of each + This option toggles resolver fetch logging. This reports the name and type of each query sent by ``delv`` in the process of carrying out the resolution - and validation process: this includes including the original query + and validation process, including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation. This is equivalent to setting the debug level to 1 in the "resolver" logging category. Setting the systemwide debug level to 1 using the - ``-d`` option will product the same output (but will affect other - logging categories as well). + ``-d`` option produces the same output, but affects other + logging categories as well. ``+[no]mtrace`` - Toggle message logging. This produces a detailed dump of the + This option toggles message logging. This produces a detailed dump of the responses received by ``delv`` in the process of carrying out the resolution and validation process. This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category. Setting the systemwide - debug level to 10 using the ``-d`` option will produce the same - output (but will affect other logging categories as well). + debug level to 10 using the ``-d`` option produces the same + output, but affects other logging categories as well. ``+[no]vtrace`` - Toggle validation logging. This shows the internal process of the + This option toggles validation logging. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid. This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category. Setting the - systemwide debug level to 3 using the ``-d`` option will produce the - same output (but will affect other logging categories as well). + systemwide debug level to 3 using the ``-d`` option produces the + same output, but affects other logging categories as well. ``+[no]short`` - Provide a terse answer. The default is to print the answer in a + This option toggles between verbose and terse answers. The default is to print the answer in a verbose form. ``+[no]comments`` - Toggle the display of comment lines in the output. The default is to + This option toggles the display of comment lines in the output. The default is to print comments. ``+[no]rrcomments`` - Toggle the display of per-record comments in the output (for example, + This option toggles the display of per-record comments in the output (for example, human-readable key information about DNSKEY records). The default is to print per-record comments. ``+[no]crypto`` - Toggle the display of cryptographic fields in DNSSEC records. The - contents of these field are unnecessary to debug most DNSSEC + This option toggles the display of cryptographic fields in DNSSEC records. The + contents of these fields are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the - common failures. The default is to display the fields. When omitted - they are replaced by the string "[omitted]" or in the DNSKEY case the - key id is displayed as the replacement, e.g. "[ key id = value ]". + common failures. The default is to display the fields. When omitted, + they are replaced by the string ``[omitted]`` or, in the DNSKEY case, the + key ID is displayed as the replacement, e.g. ``[ key id = value ]``. ``+[no]trust`` - Controls whether to display the trust level when printing a record. + This option controls whether to display the trust level when printing a record. The default is to display the trust level. ``+[no]split[=W]`` - Split long hex- or base64-formatted fields in resource records into + This option splits long hex- or base64-formatted fields in resource records into chunks of ``W`` characters (where ``W`` is rounded up to the nearest multiple of 4). ``+nosplit`` or ``+split=0`` causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. ``+[no]all`` - Set or clear the display options ``+[no]comments``, + This option sets or clears the display options ``+[no]comments``, ``+[no]rrcomments``, and ``+[no]trust`` as a group. ``+[no]multiline`` - Print long records (such as RRSIG, DNSKEY, and SOA records) in a + This option prints long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi-line format with human-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the ``delv`` output. ``+[no]dnssec`` - Indicates whether to display RRSIG records in the ``delv`` output. + This option indicates whether to display RRSIG records in the ``delv`` output. The default is to do so. Note that (unlike in ``dig``) this does - *not* control whether to request DNSSEC records or whether to + *not* control whether to request DNSSEC records or to validate them. DNSSEC records are always requested, and validation - will always occur unless suppressed by the use of ``-i`` or + always occurs unless suppressed by the use of ``-i`` or ``+noroot``. ``+[no]root[=ROOT]`` - Indicates whether to perform conventional DNSSEC validation, and if so, + This option indicates whether to perform conventional DNSSEC validation, and if so, specifies the name of a trust anchor. The default is to validate using a trust anchor of "." (the root zone), for which there is a built-in key. If specifying a different trust anchor, then ``-a`` must be used to specify a file containing the key. ``+[no]tcp`` - Controls whether to use TCP when sending queries. The default is to + This option controls whether to use TCP when sending queries. The default is to use UDP unless a truncated response has been received. ``+[no]unknownformat`` - Print all RDATA in unknown RR type presentation format (:rfc:`3597`). + This option prints all RDATA in unknown RR-type presentation format (:rfc:`3597`). The default is to print RDATA for known types in the type's presentation format. ``+[no]yaml`` - Print response data in YAML format. + This option prints response data in YAML format. Files ~~~~~ diff --git a/bin/dig/dig.rst b/bin/dig/dig.rst index 5dc5b651e6..27cb641f3a 100644 --- a/bin/dig/dig.rst +++ b/bin/dig/dig.rst @@ -40,33 +40,33 @@ Description ``dig`` is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that were queried. Most DNS administrators use ``dig`` to -troubleshoot DNS problems because of its flexibility, ease of use and +troubleshoot DNS problems because of its flexibility, ease of use, and clarity of output. Other lookup tools tend to have less functionality than ``dig``. Although ``dig`` is normally used with command-line arguments, it also has a batch mode of operation for reading lookup requests from a file. A brief summary of its command-line arguments and options is printed when -the ``-h`` option is given. Unlike earlier versions, the BIND 9 +the ``-h`` option is given. The BIND 9 implementation of ``dig`` allows multiple lookups to be issued from the command line. -Unless it is told to query a specific name server, ``dig`` will try each +Unless it is told to query a specific name server, ``dig`` tries each of the servers listed in ``/etc/resolv.conf``. If no usable server -addresses are found, ``dig`` will send the query to the local host. +addresses are found, ``dig`` sends the query to the local host. -When no command line arguments or options are given, ``dig`` will -perform an NS query for "." (the root). +When no command-line arguments or options are given, ``dig`` +performs an NS query for "." (the root). It is possible to set per-user defaults for ``dig`` via ``${HOME}/.digrc``. This file is read and any options in it are applied -before the command line arguments. The ``-r`` option disables this -feature, for scripts that need predictable behaviour. +before the command-line arguments. The ``-r`` option disables this +feature, for scripts that need predictable behavior. -The IN and CH class names overlap with the IN and CH top level domain +The IN and CH class names overlap with the IN and CH top-level domain names. Either use the ``-t`` and ``-c`` options to specify the type and -class, use the ``-q`` the specify the domain name, or use "IN." and -"CH." when looking up these top level domains. +class, use the ``-q`` to specify the domain name, or use "IN." and +"CH." when looking up these top-level domains. Simple Usage ~~~~~~~~~~~~ @@ -90,110 +90,110 @@ where: ``/etc/resolv.conf``; if an address is found there, it queries the name server at that address. If either of the ``-4`` or ``-6`` options are in use, then only addresses for the corresponding - transport will be tried. If no usable addresses are found, ``dig`` - will send the query to the local host. The reply from the name server + transport are tried. If no usable addresses are found, ``dig`` + sends the query to the local host. The reply from the name server that responds is displayed. ``name`` is the name of the resource record that is to be looked up. ``type`` - indicates what type of query is required MDASH ANY, A, MX, SIG, etc. + indicates what type of query is required - ANY, A, MX, SIG, etc. ``type`` can be any valid query type. If no ``type`` argument is - supplied, ``dig`` will perform a lookup for an A record. + supplied, ``dig`` performs a lookup for an A record. Options ~~~~~~~ -**-4** - Use IPv4 only. +``-4`` + This option indicates that only IPv4 should be used. -**-6** - Use IPv6 only. +``-6`` + This option indicates that only IPv6 should be used. -**-b** address[#port] - Set the source IP address of the query. The ``address`` must be a +``-b address[#port]`` + This option sets the source IP address of the query. The ``address`` must be a valid address on one of the host's network interfaces, or "0.0.0.0" - or "::". An optional port may be specified by appending "#" + or "::". An optional port may be specified by appending ``#port``. -**-c** class - Set the query class. The default ``class`` is IN; other classes are +``-c class`` + This option sets the query class. The default ``class`` is IN; other classes are HS for Hesiod records or CH for Chaosnet records. -**-f** file - Batch mode: ``dig`` reads a list of lookup requests to process from +``-f file`` + This option sets batch mode, in which ``dig`` reads a list of lookup requests to process from the given ``file``. Each line in the file should be organized in the - same way they would be presented as queries to ``dig`` using the + same way it would be presented as a query to ``dig`` using the command-line interface. -**-k** keyfile - Sign queries using TSIG using a key read from the given file. Key - files can be generated using tsig-keygen8. When using TSIG +``-k keyfile`` + This option tells ``named`` to sign queries using TSIG using a key read from the given file. Key + files can be generated using ``tsig-keygen``. When using TSIG authentication with ``dig``, the name server that is queried needs to know the key and algorithm that is being used. In BIND, this is done by providing appropriate ``key`` and ``server`` statements in ``named.conf``. -**-m** - Enable memory usage debugging. +``-m`` + This option enables memory usage debugging. -**-p** port - Send the query to a non-standard port on the server, instead of the - default port 53. This option would be used to test a name server that +``-p port`` + This option sends the query to a non-standard port on the server, instead of the + default port 53. This option is used to test a name server that has been configured to listen for queries on a non-standard port number. -**-q** name - The domain name to query. This is useful to distinguish the ``name`` +``-q name`` + This option specifies the domain name to query. This is useful to distinguish the ``name`` from other arguments. -**-r** - Do not read options from ``${HOME}/.digrc``. This is useful for - scripts that need predictable behaviour. +``-r`` + This option indicates that options from ``${HOME}/.digrc`` should not be read. This is useful for + scripts that need predictable behavior. -**-t** type - The resource record type to query. It can be any valid query type. If +``-t type`` + This option indicates the resource record type to query, which can be any valid query type. If it is a resource record type supported in BIND 9, it can be given by - the type mnemonic (such as "NS" or "AAAA"). The default query type is - "A", unless the ``-x`` option is supplied to indicate a reverse + the type mnemonic (such as ``NS`` or ``AAAA``). The default query type is + ``A``, unless the ``-x`` option is supplied to indicate a reverse lookup. A zone transfer can be requested by specifying a type of AXFR. When an incremental zone transfer (IXFR) is required, set the - ``type`` to ``ixfr=N``. The incremental zone transfer will contain - the changes made to the zone since the serial number in the zone's + ``type`` to ``ixfr=N``. The incremental zone transfer contains + all changes made to the zone since the serial number in the zone's SOA record was ``N``. - All resource record types can be expressed as "TYPEnn", where "nn" is + All resource record types can be expressed as ``TYPEnn``, where ``nn`` is the number of the type. If the resource record type is not supported - in BIND 9, the result will be displayed as described in :rfc:`3597`. + in BIND 9, the result is displayed as described in :rfc:`3597`. -**-u** - Print query times in microseconds instead of milliseconds. +``-u`` + This option indicates that print query times should be provided in microseconds instead of milliseconds. -**-v** - Print the version number and exit. +``-v`` + This option prints the version number and exits. -**-x** addr - Simplified reverse lookups, for mapping addresses to names. The +``-x addr`` + This option sets simplified reverse lookups, for mapping addresses to names. The ``addr`` is an IPv4 address in dotted-decimal notation, or a - colon-delimited IPv6 address. When the ``-x`` is used, there is no - need to provide the ``name``, ``class`` and ``type`` arguments. + colon-delimited IPv6 address. When the ``-x`` option is used, there is no + need to provide the ``name``, ``class``, and ``type`` arguments. ``dig`` automatically performs a lookup for a name like ``94.2.0.192.in-addr.arpa`` and sets the query type and class to PTR and IN respectively. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -**-y** [hmac:]keyname:secret - Sign queries using TSIG with the given authentication key. - ``keyname`` is the name of the key, and ``secret`` is the base64 - encoded shared secret. ``hmac`` is the name of the key algorithm; +``-y [hmac:]keyname:secret`` + This option signs queries using TSIG with the given authentication key. + ``keyname`` is the name of the key, and ``secret`` is the + base64-encoded shared secret. ``hmac`` is the name of the key algorithm; valid choices are ``hmac-md5``, ``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``, ``hmac-sha384``, or ``hmac-sha512``. If ``hmac`` is - not specified, the default is ``hmac-md5`` or if MD5 was disabled + not specified, the default is ``hmac-md5``; if MD5 was disabled, the default is ``hmac-sha256``. -.. note:: You should use the ``-k`` option and avoid the ``-y`` option, - because with ``-y`` the shared secret is supplied as a command line - argument in clear text. This may be visible in the output from ps1 or +.. note:: Only the ``-k`` option should be used, rather than the ``-y`` option, + because with ``-y`` the shared secret is supplied as a command-line + argument in clear text. This may be visible in the output from ``ps1`` or in a history file maintained by the user's shell. Query Options @@ -206,297 +206,296 @@ answer get printed, and others determine the timeout and retry strategies. Each query option is identified by a keyword preceded by a plus sign -(``+``). Some keywords set or reset an option. These may be preceded by +(``+``). Some keywords set or reset an option; these may be preceded by the string ``no`` to negate the meaning of that keyword. Other keywords -assign values to options like the timeout interval. They have the form +assign values to options, like the timeout interval. They have the form ``+keyword=value``. Keywords may be abbreviated, provided the abbreviation is unambiguous; for example, ``+cd`` is equivalent to ``+cdflag``. The query options are: ``+[no]aaflag`` - A synonym for ``+[no]aaonly``. + This option is a synonym for ``+[no]aaonly``. ``+[no]aaonly`` - Sets the "aa" flag in the query. + This option sets the ``aa`` flag in the query. ``+[no]additional`` - Display [do not display] the additional section of a reply. The + This option displays [or does not display] the additional section of a reply. The default is to display it. ``+[no]adflag`` - Set [do not set] the AD (authentic data) bit in the query. This + This option sets [or does not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority - sections have all been validated as secure according to the security - policy of the server. AD=1 indicates that all records have been - validated as secure and the answer is not from a OPT-OUT range. AD=0 - indicate that some part of the answer was insecure or not validated. + sections have been validated as secure, according to the security + policy of the server. ``AD=1`` indicates that all records have been + validated as secure and the answer is not from a OPT-OUT range. ``AD=0`` + indicates that some part of the answer was insecure or not validated. This bit is set by default. ``+[no]all`` - Set or clear all display flags. + This option sets or clears all display flags. ``+[no]answer`` - Display [do not display] the answer section of a reply. The default + This option displays [or does not display] the answer section of a reply. The default is to display it. ``+[no]authority`` - Display [do not display] the authority section of a reply. The + This option displays [or does not display] the authority section of a reply. The default is to display it. ``+[no]badcookie`` - Retry lookup with the new server cookie if a BADCOOKIE response is + This option retries the lookup with a new server cookie if a BADCOOKIE response is received. ``+[no]besteffort`` - Attempt to display the contents of messages which are malformed. The + This option attempts to display the contents of messages which are malformed. The default is to not display malformed answers. ``+bufsize=B`` - Set the UDP message buffer size advertised using EDNS0 to ``B`` - bytes. The maximum and minimum sizes of this buffer are 65535 and 0 + This option sets the UDP message buffer size advertised using EDNS0 to ``B`` + bytes. The maximum and minimum sizes of this buffer are 65535 and 0, respectively. Values outside this range are rounded up or down - appropriately. Values other than zero will cause a EDNS query to be + appropriately. Values other than zero cause an EDNS query to be sent. ``+[no]cdflag`` - Set [do not set] the CD (checking disabled) bit in the query. This + This option sets [or does not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses. ``+[no]class`` - Display [do not display] the CLASS when printing the record. + This option displays [or does not display] the CLASS when printing the record. ``+[no]cmd`` - Toggles the printing of the initial comment in the output, identifying the - version of ``dig`` and the query options that have been applied. This option - always has global effect; it cannot be set globally and then overridden on a - per-lookup basis. The default is to print this comment. + This option toggles the printing of the initial comment in the output, identifying the + version of ``dig`` and the query options that have been applied. This option + always has a global effect; it cannot be set globally and then overridden on a + per-lookup basis. The default is to print this comment. ``+[no]comments`` - Toggles the display of some comment lines in the output, containing + This option toggles the display of some comment lines in the output, with information about the packet header and OPT pseudosection, and the names of - the response section. The default is to print these comments. + the response section. The default is to print these comments. Other types of comments in the output are not affected by this option, but - can be controlled using other command line switches. These include + can be controlled using other command-line switches. These include ``+[no]cmd``, ``+[no]question``, ``+[no]stats``, and ``+[no]rrcomments``. ``+[no]cookie=####`` - Send a COOKIE EDNS option, with optional value. Replaying a COOKIE - from a previous response will allow the server to identify a previous + This option sends [or does not send] a COOKIE EDNS option, with an optional value. Replaying a COOKIE + from a previous response allows the server to identify a previous client. The default is ``+cookie``. - ``+cookie`` is also set when +trace is set to better emulate the + ``+cookie`` is also set when ``+trace`` is set to better emulate the default queries from a nameserver. ``+[no]crypto`` - Toggle the display of cryptographic fields in DNSSEC records. The - contents of these field are unnecessary to debug most DNSSEC + This option toggles the display of cryptographic fields in DNSSEC records. The + contents of these fields are unnecessary for debugging most DNSSEC validation failures and removing them makes it easier to see the - common failures. The default is to display the fields. When omitted - they are replaced by the string "[omitted]" or in the DNSKEY case the - key id is displayed as the replacement, e.g. "[ key id = value ]". + common failures. The default is to display the fields. When omitted, + they are replaced by the string ``[omitted]`` or, in the DNSKEY case, the + key ID is displayed as the replacement, e.g. ``[ key id = value ]``. ``+[no]defname`` - Deprecated, treated as a synonym for ``+[no]search`` + This option, which is deprecated, is treated as a synonym for ``+[no]search``. ``+[no]dnssec`` - Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in + This option requests that DNSSEC records be sent by setting the DNSSEC OK (DO) bit in the OPT record in the additional section of the query. ``+domain=somename`` - Set the search list to contain the single domain ``somename``, as if + This option sets the search list to contain the single domain ``somename``, as if specified in a ``domain`` directive in ``/etc/resolv.conf``, and - enable search list processing as if the ``+search`` option were + enables search list processing as if the ``+search`` option were given. ``+dscp=value`` - Set the DSCP code point to be used when sending the query. Valid DSCP - code points are in the range [0..63]. By default no code point is + This option sets the DSCP code point to be used when sending the query. Valid DSCP + code points are in the range [0...63]. By default no code point is explicitly set. ``+[no]edns[=#]`` - Specify the EDNS version to query with. Valid values are 0 to 255. - Setting the EDNS version will cause a EDNS query to be sent. + This option specifies the EDNS version to query with. Valid values are 0 to 255. + Setting the EDNS version causes an EDNS query to be sent. ``+noedns`` clears the remembered EDNS version. EDNS is set to 0 by default. ``+[no]ednsflags[=#]`` - Set the must-be-zero EDNS flags bits (Z bits) to the specified value. - Decimal, hex and octal encodings are accepted. Setting a named flag - (e.g. DO) will silently be ignored. By default, no Z bits are set. + This option sets the must-be-zero EDNS flags bits (Z bits) to the specified value. + Decimal, hex, and octal encodings are accepted. Setting a named flag + (e.g., DO) is silently ignored. By default, no Z bits are set. ``+[no]ednsnegotiation`` - Enable / disable EDNS version negotiation. By default EDNS version + This option enables/disables EDNS version negotiation. By default, EDNS version negotiation is enabled. ``+[no]ednsopt[=code[:value]]`` - Specify EDNS option with code point ``code`` and optionally payload + This option specifies the EDNS option with code point ``code`` and an optional payload of ``value`` as a hexadecimal string. ``code`` can be either an EDNS - option name (for example, ``NSID`` or ``ECS``), or an arbitrary + option name (for example, ``NSID`` or ``ECS``) or an arbitrary numeric value. ``+noednsopt`` clears the EDNS options to be sent. ``+[no]expire`` - Send an EDNS Expire option. + This option sends an EDNS Expire option. ``+[no]fail`` - Do not try the next server if you receive a SERVFAIL. The default is - to not try the next server which is the reverse of normal stub + This option indicates that ``named`` should try [or not try] the next server if a SERVFAIL is received. The default is + to not try the next server, which is the reverse of normal stub resolver behavior. ``+[no]header-only`` - Send a query with a DNS header without a question section. The + This option sends a query with a DNS header without a question section. The default is to add a question section. The query type and query name are ignored when this is set. ``+[no]identify`` - Show [or do not show] the IP address and port number that supplied - the answer when the ``+short`` option is enabled. If short form + This option shows [or does not show] the IP address and port number that supplied + the answer, when the ``+short`` option is enabled. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer. ``+[no]idnin`` - Process [do not process] IDN domain names on input. This requires IDN - SUPPORT to have been enabled at compile time. + This option processes [or does not process] IDN domain names on input. This requires + ``IDN SUPPORT`` to have been enabled at compile time. The default is to process IDN input when standard output is a tty. - The IDN processing on input is disabled when dig output is redirected + The IDN processing on input is disabled when ``dig`` output is redirected to files, pipes, and other non-tty file descriptors. ``+[no]idnout`` - Convert [do not convert] puny code on output. This requires IDN - SUPPORT to have been enabled at compile time. + This option converts [or does not convert] puny code on output. This requires + ``IDN SUPPORT`` to have been enabled at compile time. The default is to process puny code on output when standard output is - a tty. The puny code processing on output is disabled when dig output + a tty. The puny code processing on output is disabled when ``dig`` output is redirected to files, pipes, and other non-tty file descriptors. ``+[no]ignore`` - Ignore truncation in UDP responses instead of retrying with TCP. By + This option ignores [or does not ignore] truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. ``+[no]keepalive`` - Send [or do not send] an EDNS Keepalive option. + This option sends [or does not send] an EDNS Keepalive option. ``+[no]keepopen`` - Keep the TCP socket open between queries and reuse it rather than + This option keeps [or does not keep] the TCP socket open between queries, and reuses it rather than creating a new TCP socket for each lookup. The default is ``+nokeepopen``. ``+[no]mapped`` - Allow mapped IPv4 over IPv6 addresses to be used. The default is + This option allows [or does not allow] mapped IPv4-over-IPv6 addresses to be used. The default is ``+mapped``. ``+[no]multiline`` - Print records like the SOA records in a verbose multi-line format + This option prints [or does not print] records, like the SOA records, in a verbose multi-line format with human-readable comments. The default is to print each record on - a single line, to facilitate machine parsing of the ``dig`` output. + a single line to facilitate machine parsing of the ``dig`` output. ``+ndots=D`` - Set the number of dots that have to appear in ``name`` to ``D`` for + This option sets the number of dots (``D``) that must appear in ``name`` for it to be considered absolute. The default value is that defined using - the ndots statement in ``/etc/resolv.conf``, or 1 if no ndots + the ``ndots`` statement in ``/etc/resolv.conf``, or 1 if no ``ndots`` statement is present. Names with fewer dots are interpreted as - relative names and will be searched for in the domains listed in the + relative names, and are searched for in the domains listed in the ``search`` or ``domain`` directive in ``/etc/resolv.conf`` if ``+search`` is set. ``+[no]nsid`` - Include an EDNS name server ID request when sending a query. + When enabled, this option includes an EDNS name server ID request when sending a query. ``+[no]nssearch`` When this option is set, ``dig`` attempts to find the authoritative - name servers for the zone containing the name being looked up and + name servers for the zone containing the name being looked up, and display the SOA record that each name server has for the zone. - Addresses of servers that that did not respond are also printed. + Addresses of servers that did not respond are also printed. ``+[no]onesoa`` - Print only one (starting) SOA record when performing an AXFR. The + When enabled, this option prints only one (starting) SOA record when performing an AXFR. The default is to print both the starting and ending SOA records. ``+[no]opcode=value`` - Set [restore] the DNS message opcode to the specified value. The + When enabled, this option sets (restores) the DNS message opcode to the specified value. The default value is QUERY (0). ``+padding=value`` - Pad the size of the query packet using the EDNS Padding option to - blocks of ``value`` bytes. For example, ``+padding=32`` would cause a + This option pads the size of the query packet using the EDNS Padding option to + blocks of ``value`` bytes. For example, ``+padding=32`` causes a 48-byte query to be padded to 64 bytes. The default block size is 0, - which disables padding. The maximum is 512. Values are ordinarily + which disables padding; the maximum is 512. Values are ordinarily expected to be powers of two, such as 128; however, this is not mandatory. Responses to padded queries may also be padded, but only if the query uses TCP or DNS COOKIE. ``+qid=value`` - - Specify the query ID to use when sending queries. + This option specifies the query ID to use when sending queries. ``+[no]qr`` - Toggles the display of the query message as it is sent. By default, the query + This option toggles the display of the query message as it is sent. By default, the query is not printed. ``+[no]question`` - Toggles the display of the question section of a query when an answer is - returned. The default is to print the question section as a comment. + This option toggles the display of the question section of a query when an answer is + returned. The default is to print the question section as a comment. ``+[no]raflag`` - Set [do not set] the RA (Recursion Available) bit in the query. The - default is +noraflag. This bit should be ignored by the server for + This option sets [or does not set] the RA (Recursion Available) bit in the query. The + default is ``+noraflag``. This bit is ignored by the server for QUERY. ``+[no]rdflag`` - A synonym for ``+[no]recurse``. + This option is a synonym for ``+[no]recurse``. ``+[no]recurse`` - Toggle the setting of the RD (recursion desired) bit in the query. + This option toggles the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means ``dig`` normally sends recursive queries. Recursion is automatically disabled when the - ``+nssearch`` or ``+trace`` query options are used. + ``+nssearch`` or ``+trace`` query option is used. ``+retry=T`` - Sets the number of times to retry UDP queries to server to ``T`` + This option sets the number of times to retry UDP queries to server to ``T`` instead of the default, 2. Unlike ``+tries``, this does not include the initial query. ``+[no]rrcomments`` - Toggle the display of per-record comments in the output (for example, + This option toggles the display of per-record comments in the output (for example, human-readable key information about DNSKEY records). The default is not to print record comments unless multiline mode is active. ``+[no]search`` - Use [do not use] the search list defined by the searchlist or domain - directive in ``resolv.conf`` (if any). The search list is not used by + This option uses [or does not use] the search list defined by the searchlist or domain + directive in ``resolv.conf``, if any. The search list is not used by default. - 'ndots' from ``resolv.conf`` (default 1) which may be overridden by - ``+ndots`` determines if the name will be treated as relative or not - and hence whether a search is eventually performed or not. + ``ndots`` from ``resolv.conf`` (default 1), which may be overridden by + ``+ndots``, determines whether the name is treated as relative + and hence whether a search is eventually performed. ``+[no]short`` - Provide a terse answer. The default is to print the answer in a verbose - form. This option always has global effect; it cannot be set globally and + This option toggles whether a terse answer is provided. The default is to print the answer in a verbose + form. This option always has a global effect; it cannot be set globally and then overridden on a per-lookup basis. ``+[no]showsearch`` - Perform [do not perform] a search showing intermediate results. + This option performs [or does not perform] a search showing intermediate results. ``+[no]sigchase`` This feature is now obsolete and has been removed; use ``delv`` instead. ``+split=W`` - Split long hex- or base64-formatted fields in resource records into + This option splits long hex- or base64-formatted fields in resource records into chunks of ``W`` characters (where ``W`` is rounded up to the nearest multiple of 4). ``+nosplit`` or ``+split=0`` causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. ``+[no]stats`` - Toggles the printing of statistics: when the query was made, the size of the - reply and so on. The default behavior is to print the query statistics as a + This option toggles the printing of statistics: when the query was made, the size of the + reply, etc. The default behavior is to print the query statistics as a comment after each lookup. ``+[no]subnet=addr[/prefix-length]`` - Send (don't send) an EDNS Client Subnet option with the specified IP + This option sends [or does not send] an EDNS CLIENT-SUBNET option with the specified IP address or network prefix. ``dig +subnet=0.0.0.0/0``, or simply ``dig +subnet=0`` for short, @@ -505,75 +504,74 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to address information must *not* be used when resolving this query. ``+[no]tcflag`` - Set [do not set] the TC (TrunCation) bit in the query. The default is - +notcflag. This bit should be ignored by the server for QUERY. + This option sets [or does not set] the TC (TrunCation) bit in the query. The default is + ``+notcflag``. This bit is ignored by the server for QUERY. ``+[no]tcp`` - Use [do not use] TCP when querying name servers. The default behavior + This option uses [or does not use] TCP when querying name servers. The default behavior is to use UDP unless a type ``any`` or ``ixfr=N`` query is requested, in which case the default is TCP. AXFR queries always use TCP. ``+timeout=T`` - Sets the timeout for a query to ``T`` seconds. The default timeout is - 5 seconds. An attempt to set ``T`` to less than 1 will result in a - query timeout of 1 second being applied. + This option sets the timeout for a query to ``T`` seconds. The default timeout is + 5 seconds. An attempt to set ``T`` to less than 1 is silently set to 1. ``+[no]topdown`` This feature is related to ``dig +sigchase``, which is obsolete and has been removed. Use ``delv`` instead. ``+[no]trace`` - Toggle tracing of the delegation path from the root name servers for + This option toggles tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled, ``dig`` makes iterative queries to resolve the - name being looked up. It will follow referrals from the root servers, + name being looked up. It follows referrals from the root servers, showing the answer from each server that was used to resolve the lookup. - If @server is also specified, it affects only the initial query for + If ``@server`` is also specified, it affects only the initial query for the root zone name servers. - ``+dnssec`` is also set when +trace is set to better emulate the - default queries from a nameserver. + ``+dnssec`` is also set when ``+trace`` is set, to better emulate the + default queries from a name server. ``+tries=T`` - Sets the number of times to try UDP queries to server to ``T`` + This option sets the number of times to try UDP queries to server to ``T`` instead of the default, 3. If ``T`` is less than or equal to zero, the number of tries is silently rounded up to 1. ``+trusted-key=####`` - Formerly specified trusted keys for use with ``dig +sigchase``. This + This option formerly specified trusted keys for use with ``dig +sigchase``. This feature is now obsolete and has been removed; use ``delv`` instead. ``+[no]ttlid`` - Display [do not display] the TTL when printing the record. + This option displays [or does not display] the TTL when printing the record. ``+[no]ttlunits`` - Display [do not display] the TTL in friendly human-readable time - units of "s", "m", "h", "d", and "w", representing seconds, minutes, - hours, days and weeks. Implies +ttlid. + This option displays [or does not display] the TTL in friendly human-readable time + units of ``s``, ``m``, ``h``, ``d``, and ``w``, representing seconds, minutes, + hours, days, and weeks. This implies ``+ttlid``. ``+[no]unexpected`` - Accept [do not accept] answers from unexpected sources. By default, ``dig`` - won't accept a reply from a source other than the one to which it sent the + This option accepts [or does not accept] answers from unexpected sources. By default, ``dig`` + will not accept a reply from a source other than the one to which it sent the query. ``+[no]unknownformat`` - Print all RDATA in unknown RR type presentation format (:rfc:`3597`). + This option prints all RDATA in unknown RR type presentation format (:rfc:`3597`). The default is to print RDATA for known types in the type's presentation format. ``+[no]vc`` - Use [do not use] TCP when querying name servers. This alternate + This option uses [or does not use] TCP when querying name servers. This alternate syntax to ``+[no]tcp`` is provided for backwards compatibility. The - "vc" stands for "virtual circuit". + ``vc`` stands for "virtual circuit." ``+[no]yaml`` - Print the responses (and, if is in use, also the + When enabled, this option prints the responses (and, if ``+qr`` is in use, also the outgoing queries) in a detailed YAML format. ``+[no]zflag`` - Set [do not set] the last unassigned DNS header flag in a DNS query. + This option sets [or does not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. Multiple Queries @@ -582,12 +580,12 @@ Multiple Queries The BIND 9 implementation of ``dig`` supports specifying multiple queries on the command line (in addition to supporting the ``-f`` batch file option). Each of those queries can be supplied with its own set of -flags, options and query options. +flags, options, and query options. -In this case, each ``query`` argument represent an individual query in +In this case, each ``query`` argument represents an individual query in the command-line syntax described above. Each consists of any of the standard options and flags, the name to be looked up, an optional query -type and class and any query options that should be applied to that +type and class, and any query options that should be applied to that query. A global set of query options, which should be applied to all queries, @@ -601,12 +599,12 @@ query options. For example: dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr -shows how ``dig`` could be used from the command line to make three -lookups: an ANY query for ``www.isc.org``, a reverse lookup of 127.0.0.1 +shows how ``dig`` can be used from the command line to make three +lookups: an ANY query for ``www.isc.org``, a reverse lookup of 127.0.0.1, and a query for the NS records of ``isc.org``. A global query option of ``+qr`` is applied, so that ``dig`` shows the initial query it made for each lookup. The final query has a local query option of ``+noqr`` which -means that ``dig`` will not print the initial query when it looks up the +means that ``dig`` does not print the initial query when it looks up the NS records for ``isc.org``. IDN Support @@ -614,10 +612,10 @@ IDN Support If ``dig`` has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. ``dig`` -appropriately converts character encoding of domain name before sending -a request to DNS server or displaying a reply from the server. If you'd -like to turn off the IDN support for some reason, use parameters -``+noidnin`` and ``+noidnout`` or define the IDN_DISABLE environment +appropriately converts character encoding of a domain name before sending +a request to a DNS server or displaying a reply from the server. +To turn off IDN support, use the parameters +``+noidnin`` and ``+noidnout``, or define the ``IDN_DISABLE`` environment variable. Files diff --git a/bin/dig/host.rst b/bin/dig/host.rst index 0b4de7d252..9887c3cea6 100644 --- a/bin/dig/host.rst +++ b/bin/dig/host.rst @@ -36,12 +36,12 @@ Description ``host`` is a simple utility for performing DNS lookups. It is normally used to convert names to IP addresses and vice versa. When no arguments -or options are given, ``host`` prints a short summary of its command -line arguments and options. +or options are given, ``host`` prints a short summary of its +command-line arguments and options. ``name`` is the domain name that is to be looked up. It can also be a dotted-decimal IPv4 address or a colon-delimited IPv6 address, in which -case ``host`` will by default perform a reverse lookup for that address. +case ``host`` by default performs a reverse lookup for that address. ``server`` is an optional argument which is either the name or IP address of the name server that ``host`` should query instead of the server or servers listed in ``/etc/resolv.conf``. @@ -49,111 +49,111 @@ server or servers listed in ``/etc/resolv.conf``. Options ~~~~~~~ -**-4** - Use IPv4 only for query transport. See also the ``-6`` option. +``-4`` + This option specifies that only IPv4 should be used for query transport. See also the ``-6`` option. -**-6** - Use IPv6 only for query transport. See also the ``-4`` option. +``-6`` + This option specifies that only IPv6 should be used for query transport. See also the ``-4`` option. -**-a** - "All". The ``-a`` option is normally equivalent to ``-v -t ANY``. It - also affects the behaviour of the ``-l`` list zone option. +``-a`` + The ``-a`` ("all") option is normally equivalent to ``-v -t ANY``. It + also affects the behavior of the ``-l`` list zone option. -**-A** - "Almost all". The ``-A`` option is equivalent to ``-a`` except RRSIG, +``-A`` + The ``-A`` ("almost all") option is equivalent to ``-a``, except that RRSIG, NSEC, and NSEC3 records are omitted from the output. -**-c** class - Query class: This can be used to lookup HS (Hesiod) or CH (Chaosnet) +``-c class`` + This option specifies the query class, which can be used to lookup HS (Hesiod) or CH (Chaosnet) class resource records. The default class is IN (Internet). -**-C** - Check consistency: ``host`` will query the SOA records for zone +``-C`` + This option indicates that ``named`` should check consistency, meaning that ``host`` queries the SOA records for zone ``name`` from all the listed authoritative name servers for that zone. The list of name servers is defined by the NS records that are found for the zone. -**-d** - Print debugging traces. Equivalent to the ``-v`` verbose option. +``-d`` + This option prints debugging traces, and is equivalent to the ``-v`` verbose option. -**-l** - List zone: The ``host`` command performs a zone transfer of zone - ``name`` and prints out the NS, PTR and address records (A/AAAA). +``-l`` + This option tells ``named` to list the zone, meaning the ``host`` command performs a zone transfer of zone + ``name`` and prints out the NS, PTR, and address records (A/AAAA). Together, the ``-l -a`` options print all records in the zone. -**-N** ndots - The number of dots that have to be in ``name`` for it to be +``-N ndots`` + This option specifies the number of dots (``ndots``) that have to be in ``name`` for it to be considered absolute. The default value is that defined using the - ndots statement in ``/etc/resolv.conf``, or 1 if no ndots statement - is present. Names with fewer dots are interpreted as relative names - and will be searched for in the domains listed in the ``search`` or + ``ndots`` statement in ``/etc/resolv.conf``, or 1 if no ``ndots`` statement + is present. Names with fewer dots are interpreted as relative names, + and are searched for in the domains listed in the ``search`` or ``domain`` directive in ``/etc/resolv.conf``. -**-p** port - Specify the port on the server to query. The default is 53. +``-p port`` + This option specifies the port to query on the server. The default is 53. -**-r** - Non-recursive query: Setting this option clears the RD (recursion - desired) bit in the query. This should mean that the name server - receiving the query will not attempt to resolve ``name``. The ``-r`` +``-r`` + This option specifies a non-recursive query; setting this option clears the RD (recursion + desired) bit in the query. This means that the name server + receiving the query does not attempt to resolve ``name``. The ``-r`` option enables ``host`` to mimic the behavior of a name server by - making non-recursive queries and expecting to receive answers to + making non-recursive queries, and expecting to receive answers to those queries that can be referrals to other name servers. -**-R** number - Number of retries for UDP queries: If ``number`` is negative or zero, - the number of retries will default to 1. The default value is 1, or +``-R number`` + This option specifies the number of retries for UDP queries. If ``number`` is negative or zero, + the number of retries is silently set to 1. The default value is 1, or the value of the ``attempts`` option in ``/etc/resolv.conf``, if set. -**-s** - Do *not* send the query to the next nameserver if any server responds +``-s`` + This option tells ``named`` *not* to send the query to the next nameserver if any server responds with a SERVFAIL response, which is the reverse of normal stub resolver behavior. -**-t** type - Query type: The ``type`` argument can be any recognized query type: +``-t type`` + This option specifies the query type. The ``type`` argument can be any recognized query type: CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc. When no query type is specified, ``host`` automatically selects an appropriate query type. By default, it looks for A, AAAA, and MX - records. If the ``-C`` option is given, queries will be made for SOA + records. If the ``-C`` option is given, queries are made for SOA records. If ``name`` is a dotted-decimal IPv4 address or - colon-delimited IPv6 address, ``host`` will query for PTR records. + colon-delimited IPv6 address, ``host`` queries for PTR records. - If a query type of IXFR is chosen the starting serial number can be - specified by appending an equal followed by the starting serial - number (like ``-t IXFR=12345678``). + If a query type of IXFR is chosen, the starting serial number can be + specified by appending an equals sign (=), followed by the starting serial + number, e.g., ``-t IXFR=12345678``. -**-T**; **-U** - TCP/UDP: By default, ``host`` uses UDP when making queries. The +``-T``; ``-U`` + This option specifies TCP or UDP. By default, ``host`` uses UDP when making queries; the ``-T`` option makes it use a TCP connection when querying the name - server. TCP will be automatically selected for queries that require - it, such as zone transfer (AXFR) requests. Type ANY queries default - to TCP but can be forced to UDP initially using ``-U``. + server. TCP is automatically selected for queries that require + it, such as zone transfer (AXFR) requests. Type ``ANY`` queries default + to TCP, but can be forced to use UDP initially via ``-U``. -**-m** flag - Memory usage debugging: the flag can be ``record``, ``usage``, or - ``trace``. You can specify the ``-m`` option more than once to set +``-m flag`` + This option sets memory usage debugging: the flag can be ``record``, ``usage``, or + ``trace``. The ``-m`` option can be specified more than once to set multiple flags. -**-v** - Verbose output. Equivalent to the ``-d`` debug option. Verbose output +``-v`` + This option sets verbose output, and is equivalent to the ``-d`` debug option. Verbose output can also be enabled by setting the ``debug`` option in ``/etc/resolv.conf``. -**-V** - Print the version number and exit. +``-V`` + This option prints the version number and exits. -**-w** - Wait forever: The query timeout is set to the maximum possible. See +``-w`` + This option sets "wait forever": the query timeout is set to the maximum possible. See also the ``-W`` option. -**-W** wait - Timeout: Wait for up to ``wait`` seconds for a reply. If ``wait`` is - less than one, the wait interval is set to one second. +``-W wait`` + This options sets the length of the wait timeout, indicating that ``named`` should wait for up to ``wait`` seconds for a reply. If ``wait`` is + less than 1, the wait interval is set to 1 second. - By default, ``host`` will wait for 5 seconds for UDP responses and 10 + By default, ``host`` waits for 5 seconds for UDP responses and 10 seconds for TCP connections. These defaults can be overridden by the ``timeout`` option in ``/etc/resolv.conf``. @@ -164,10 +164,10 @@ IDN Support If ``host`` has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. ``host`` -appropriately converts character encoding of domain name before sending -a request to DNS server or displaying a reply from the server. If you'd -like to turn off the IDN support for some reason, define the IDN_DISABLE -environment variable. The IDN support is disabled if the variable is set +appropriately converts character encoding of a domain name before sending +a request to a DNS server or displaying a reply from the server. +To turn off IDN support, define the ``IDN_DISABLE`` +environment variable. IDN support is disabled if the variable is set when ``host`` runs. Files diff --git a/bin/dig/nslookup.rst b/bin/dig/nslookup.rst index 49e715a717..b2146f5663 100644 --- a/bin/dig/nslookup.rst +++ b/bin/dig/nslookup.rst @@ -34,11 +34,11 @@ Synopsis Description ~~~~~~~~~~~ -``Nslookup`` is a program to query Internet domain name servers. -``Nslookup`` has two modes: interactive and non-interactive. Interactive +``nslookup`` is a program to query Internet domain name servers. +``nslookup`` has two modes: interactive and non-interactive. Interactive mode allows the user to query name servers for information about various hosts and domains or to print a list of hosts in a domain. -Non-interactive mode is used to print just the name and requested +Non-interactive mode prints just the name and requested information for a host or domain. Arguments @@ -46,7 +46,7 @@ Arguments Interactive mode is entered in the following cases: -a. when no arguments are given (the default name server will be used) +a. when no arguments are given (the default name server is used); b. when the first argument is a hyphen (-) and the second argument is the host name or Internet address of a name server. @@ -57,7 +57,7 @@ argument specifies the host name or address of a name server. Options can also be specified on the command line if they precede the arguments and are prefixed with a hyphen. For example, to change the -default query type to host information, and the initial timeout to 10 +default query type to host information, with an initial timeout of 10 seconds, type: :: @@ -65,59 +65,59 @@ seconds, type: nslookup -query=hinfo -timeout=10 The ``-version`` option causes ``nslookup`` to print the version number -and immediately exits. +and immediately exit. Interactive Commands ~~~~~~~~~~~~~~~~~~~~ -``host`` [server] - Look up information for host using the current default server or - using server, if specified. If host is an Internet address and the - query type is A or PTR, the name of the host is returned. If host is - a name and does not have a trailing period, the search list is used +``host [server]`` + This command looks up information for ``host`` using the current default server or + using ``server``, if specified. If ``host`` is an Internet address and the + query type is A or PTR, the name of the host is returned. If ``host`` is + a name and does not have a trailing period (``.``), the search list is used to qualify the name. To look up a host not in the current domain, append a period to the name. -``server`` domain | ``lserver`` domain - Change the default server to domain; ``lserver`` uses the initial - server to look up information about domain, while ``server`` uses the - current default server. If an authoritative answer can't be found, +``server domain`` | ``lserver domain`` + These commands change the default server to ``domain``; ``lserver`` uses the initial + server to look up information about ``domain``, while ``server`` uses the + current default server. If an authoritative answer cannot be found, the names of servers that might have the answer are returned. ``root`` - not implemented + This command is not implemented. ``finger`` - not implemented + This command is not implemented. ``ls`` - not implemented + This command is not implemented. ``view`` - not implemented + This command is not implemented. ``help`` - not implemented + This command is not implemented. ``?`` - not implemented + This command is not implemented. ``exit`` - Exits the program. + This command exits the program. -``set`` keyword[=value] +``set keyword[=value]`` This command is used to change state information that affects the lookups. Valid keywords are: ``all`` - Prints the current values of the frequently used options to + This keyword prints the current values of the frequently used options to ``set``. Information about the current default server and host is also printed. - ``class=``\ value - Change the query class to one of: + ``class=value`` + This keyword changes the query class to one of: ``IN`` the Internet class @@ -131,72 +131,62 @@ Interactive Commands ``ANY`` wildcard - The class specifies the protocol group of the information. - - (Default = IN; abbreviation = cl) + The class specifies the protocol group of the information. The default + is ``IN``; the abbreviation for this keyword is ``cl``. ``nodebug`` - Turn on or off the display of the full response packet and any - intermediate response packets when searching. - - (Default = nodebug; abbreviation = [no]deb) + This keyword turns on or off the display of the full response packet, and any + intermediate response packets, when searching. The default for this keyword is + ``nodebug``; the abbreviation for this keyword is ``[no]deb``. ``nod2`` - Turn debugging mode on or off. This displays more about what - nslookup is doing. + This keyword turns debugging mode on or off. This displays more about what + nslookup is doing. The default is ``nod2``. - (Default = nod2) - - ``domain=``\ name - Sets the search list to name. + ``domain=name`` + This keyword sets the search list to ``name``. ``nosearch`` - If the lookup request contains at least one period but doesn't end - with a trailing period, append the domain names in the domain - search list to the request until an answer is received. + If the lookup request contains at least one period, but does not end + with a trailing period, this keyword appends the domain names in the domain + search list to the request until an answer is received. The default is ``search``. - (Default = search) + ``port=value`` + This keyword changes the default TCP/UDP name server port to ``value`` from + its default, port 53. The abbreviation for this keyword is ``po``. - ``port=``\ value - Change the default TCP/UDP name server port to value. + ``querytype=value`` | ``type=value`` + This keyword changes the type of the information query to ``value``. The + defaults are A and then AAAA; the abbreviations for these keywords are + ``q`` and ``ty``. - (Default = 53; abbreviation = po) - - ``querytype=``\ value | ``type=``\ value - Change the type of the information query. - - (Default = A and then AAAA; abbreviations = q, ty) - - **Note:** It is only possible to specify one query type, only the default - behavior looks up both when an alternative is not specified. + Please note that it is only possible to specify one query type. Only the default + behavior looks up both when an alternative is not specified. ``norecurse`` - Tell the name server to query other servers if it does not have - the information. + This keyword tells the name server to query other servers if it does not have + the information. The default is ``recurse``; the abbreviation for this + keyword is ``[no]rec``. - (Default = recurse; abbreviation = [no]rec) + ``ndots=number`` + This keyword sets the number of dots (label separators) in a domain that + disables searching. Absolute names always stop searching. - ``ndots=``\ number - Set the number of dots (label separators) in a domain that will - disable searching. Absolute names always stop searching. + ``retry=number`` + This keyword sets the number of retries to ``number``. - ``retry=``\ number - Set the number of retries to number. - - ``timeout=``\ number - Change the initial timeout interval for waiting for a reply to - number seconds. + ``timeout=number`` + This keyword changes the initial timeout interval to wait for a reply to + ``number``, in seconds. ``novc`` - Always use a virtual circuit when sending requests to the server. - - (Default = novc) + This keyword indicates that a virtual circuit should always be used when sending requests to the server. + ``novc`` is the default. ``nofail`` - Try the next nameserver if a nameserver responds with SERVFAIL or - a referral (nofail) or terminate query (fail) on such a response. - - (Default = nofail) + This keyword tries the next nameserver if a nameserver responds with SERVFAIL or + a referral (nofail), or terminates the query (fail) on such a response. The + default is ``nofail``. Return Values ~~~~~~~~~~~~~ @@ -209,11 +199,11 @@ IDN Support If ``nslookup`` has been built with IDN (internationalized domain name) support, it can accept and display non-ASCII domain names. ``nslookup`` -appropriately converts character encoding of domain name before sending -a request to DNS server or displaying a reply from the server. If you'd -like to turn off the IDN support for some reason, define the IDN_DISABLE -environment variable. The IDN support is disabled if the variable is set -when ``nslookup`` runs or when the standard output is not a tty. +appropriately converts character encoding of a domain name before sending +a request to a DNS server or displaying a reply from the server. +To turn off IDN support, define the ``IDN_DISABLE`` +environment variable. IDN support is disabled if the variable is set +when ``nslookup`` runs, or when the standard output is not a tty. Files ~~~~~ diff --git a/bin/dnssec/dnssec-dsfromkey.rst b/bin/dnssec/dnssec-dsfromkey.rst index 0388afc945..a6120dcf7d 100644 --- a/bin/dnssec/dnssec-dsfromkey.rst +++ b/bin/dnssec/dnssec-dsfromkey.rst @@ -45,7 +45,7 @@ The ``dnssec-dsfromkey`` command outputs DS (Delegation Signer) resource records The input keys can be specified in a number of ways: -By default, ``dnssec-dsfromkey`` reads a key file named like +By default, ``dnssec-dsfromkey`` reads a key file named in the format ``Knnnn.+aaa+iiiii.key``, as generated by ``dnssec-keygen``. With the ``-f file`` option, ``dnssec-dsfromkey`` reads keys from a zone @@ -57,73 +57,73 @@ as generated by ``dnssec-keygen`` ``-C``. Options ~~~~~~~ -**-1** - An abbreviation for ``-a SHA1`` +``-1`` + This option is an abbreviation for ``-a SHA1``. -**-2** - An abbreviation for ``-a SHA-256`` +``-2`` + This option is an abbreviation for ``-a SHA-256``. -**-a** algorithm - Specify a digest algorithm to use when converting DNSKEY records to +``-a algorithm`` + This option specifies a digest algorithm to use when converting DNSKEY records to DS records. This option can be repeated, so that multiple DS records are created for each DNSKEY record. The algorithm must be one of SHA-1, SHA-256, or SHA-384. These values - are case insensitive, and the hyphen may be omitted. If no algorithm + are case-insensitive, and the hyphen may be omitted. If no algorithm is specified, the default is SHA-256. -**-A** - Include ZSKs when generating DS records. Without this option, only - keys which have the KSK flag set will be converted to DS records and - printed. Useful only in ``-f`` zone file mode. +``-A`` + This option indicates that ZSKs are to be included when generating DS records. Without this option, only + keys which have the KSK flag set are converted to DS records and + printed. This option is only useful in ``-f`` zone file mode. -**-c** class - Specifies the DNS class (default is IN). Useful only in ``-s`` keyset +``-c class`` + This option specifies the DNS class; the default is IN. This option is only useful in ``-s`` keyset or ``-f`` zone file mode. -**-C** - Generate CDS records rather than DS records. +``-C`` + This option generates CDS records rather than DS records. -**-f** file - Zone file mode: ``dnssec-dsfromkey``'s final dnsname argument is the +``-f file`` + This option sets zone file mode, in which the final dnsname argument of ``dnssec-dsfromkey`` is the DNS domain name of a zone whose master file can be read from ``file``. If the zone name is the same as ``file``, then it may be omitted. - If file is ``"-"``, then the zone data is read from the standard + If ``file`` is ``-``, then the zone data is read from the standard input. This makes it possible to use the output of the ``dig`` command as input, as in: ``dig dnskey example.com | dnssec-dsfromkey -f - example.com`` -**-h** - Prints usage information. +``-h`` + This option prints usage information. -**-K** directory - Look for key files or ``keyset-`` files in ``directory``. +``-K directory`` + This option tells BIND 9 to look for key files or ``keyset-`` files in ``directory``. -**-s** - Keyset mode: ``dnssec-dsfromkey``'s final dnsname argument is the DNS +``-s`` + This option enables keyset mode, in which the final dnsname argument from ``dnssec-dsfromkey`` is the DNS domain name used to locate a ``keyset-`` file. -**-T** TTL - Specifies the TTL of the DS records. By default the TTL is omitted. +``-T TTL`` + This option specifies the TTL of the DS records. By default the TTL is omitted. -**-v** level - Sets the debugging level. +``-v level`` + This option sets the debugging level. -**-V** - Prints version information. +``-V`` + This option prints version information. Example ~~~~~~~ -To build the SHA-256 DS RR from the ``Kexample.com.+003+26160`` keyfile -name, you can issue the following command: +To build the SHA-256 DS RR from the ``Kexample.com.+003+26160`` keyfile, +issue the following command: ``dnssec-dsfromkey -2 Kexample.com.+003+26160`` -The command would print something like: +The command returns something similar to: ``example.com. IN DS 26160 5 2 3A1EADA7A74B8D0BA86726B0C227AA85AB8BBD2B2004F41A868A54F0C5EA0B94`` @@ -131,16 +131,16 @@ Files ~~~~~ The keyfile can be designated by the key identification -``Knnnn.+aaa+iiiii`` or the full file name ``Knnnn.+aaa+iiiii.key`` as -generated by dnssec-keygen8. +``Knnnn.+aaa+iiiii`` or the full file name ``Knnnn.+aaa+iiiii.key``, as +generated by ``dnssec-keygen``. The keyset file name is built from the ``directory``, the string -``keyset-`` and the ``dnsname``. +``keyset-``, and the ``dnsname``. Caveat ~~~~~~ -A keyfile error can give a "file not found" even if the file exists. +A keyfile error may return "file not found," even if the file exists. See Also ~~~~~~~~ diff --git a/bin/dnssec/dnssec-importkey.rst b/bin/dnssec/dnssec-importkey.rst index 439387e2c8..366cf5e541 100644 --- a/bin/dnssec/dnssec-importkey.rst +++ b/bin/dnssec/dnssec-importkey.rst @@ -38,11 +38,11 @@ Description ``dnssec-importkey`` reads a public DNSKEY record and generates a pair of .key/.private files. The DNSKEY record may be read from an existing -.key file, in which case a corresponding .private file will be +.key file, in which case a corresponding .private file is generated, or it may be read from any other file or from the standard -input, in which case both .key and .private files will be generated. +input, in which case both .key and .private files are generated. -The newly-created .private file does *not* contain private key data, and +The newly created .private file does *not* contain private key data, and cannot be used for signing. However, having a .private file makes it possible to set publication (``-P``) and deletion (``-D``) times for the key, which means the public key can be added to and removed from the @@ -51,70 +51,70 @@ DNSKEY RRset on schedule even if the true private key is stored offline. Options ~~~~~~~ -**-f** filename - Zone file mode: instead of a public keyfile name, the argument is the +``-f filename`` + This option indicates the zone file mode. Instead of a public keyfile name, the argument is the DNS domain name of a zone master file, which can be read from - ``file``. If the domain name is the same as ``file``, then it may be + ``filename``. If the domain name is the same as ``filename``, then it may be omitted. - If ``file`` is set to ``"-"``, then the zone data is read from the + If ``filename`` is set to ``"-"``, then the zone data is read from the standard input. -**-K** directory - Sets the directory in which the key files are to reside. +``-K directory`` + This option sets the directory in which the key files are to reside. -**-L** ttl - Sets the default TTL to use for this key when it is converted into a - DNSKEY RR. If the key is imported into a zone, this is the TTL that - will be used for it, unless there was already a DNSKEY RRset in - place, in which case the existing TTL would take precedence. Setting - the default TTL to ``0`` or ``none`` removes it. +``-L ttl`` + This option sets the default TTL to use for this key when it is converted into a + DNSKEY RR. This is the TTL used when the key is imported into a zone, + unless there was already a DNSKEY RRset in + place, in which case the existing TTL takes precedence. Setting the default TTL to ``0`` or ``none`` + removes it from the key. -**-h** - Emit usage message and exit. +``-h`` + This option emits a usage message and exits. -**-v** level - Sets the debugging level. +``-v level`` + This option sets the debugging level. -**-V** - Prints version information. +``-V`` + This option prints version information. Timing Options ~~~~~~~~~~~~~~ Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the -argument begins with a '+' or '-', it is interpreted as an offset from +argument begins with a ``+`` or ``-``, it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one -of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is +of the suffixes ``y``, ``mo``, ``w``, ``d``, ``h``, or ``mi``, then the offset is computed in years (defined as 365 24-hour days, ignoring leap years), months (defined as 30 24-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To -explicitly prevent a date from being set, use 'none' or 'never'. +explicitly prevent a date from being set, use ``none`` or ``never``. -**-P** date/offset - Sets the date on which a key is to be published to the zone. After - that date, the key will be included in the zone but will not be used +``-P date/offset`` + This option sets the date on which a key is to be published to the zone. After + that date, the key is included in the zone but is not used to sign it. -**-P** sync date/offset - Sets the date on which CDS and CDNSKEY records that match this key +``-P sync date/offset`` + This option sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -**-D** date/offset - Sets the date on which the key is to be deleted. After that date, the - key will no longer be included in the zone. (It may remain in the key - repository, however.) +``-D date/offset`` + This option sets the date on which the key is to be deleted. After that date, the + key is no longer included in the zone. (However, it may remain in the key + repository.) -**-D** sync date/offset - Sets the date on which the CDS and CDNSKEY records that match this +``-D sync date/offset`` + This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. Files ~~~~~ A keyfile can be designed by the key identification ``Knnnn.+aaa+iiiii`` -or the full file name ``Knnnn.+aaa+iiiii.key`` as generated by -dnssec-keygen8. +or the full file name ``Knnnn.+aaa+iiiii.key``, as generated by +``dnssec-keygen``. See Also ~~~~~~~~ diff --git a/bin/dnssec/dnssec-keyfromlabel.rst b/bin/dnssec/dnssec-keyfromlabel.rst index d226c8ff5b..b63a5d87ca 100644 --- a/bin/dnssec/dnssec-keyfromlabel.rst +++ b/bin/dnssec/dnssec-keyfromlabel.rst @@ -104,7 +104,7 @@ Options operations without any need for an operator to manually enter a PIN. Note: Making the HSM's PIN accessible in this manner may reduce the security advantage of using an HSM; use caution - when using this feature. + with this feature. ``-n nametype`` This option specifies the owner type of the key. The value of ``nametype`` must diff --git a/bin/dnssec/dnssec-keygen.rst b/bin/dnssec/dnssec-keygen.rst index cdf9a1a24b..a3b576b5b1 100644 --- a/bin/dnssec/dnssec-keygen.rst +++ b/bin/dnssec/dnssec-keygen.rst @@ -94,7 +94,7 @@ Options This option indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -``-d`` bits +``-d bits`` This option specifies the key size in bits. For the algorithms RSASHA1, NSEC3RSASA1, RSASHA256, and RSASHA512 the key size must be between 1024 and 4096 bits; DH size is between 128 and 4096 bits. This option is ignored for algorithms ECDSAP256SHA256, diff --git a/bin/dnssec/dnssec-settime.rst b/bin/dnssec/dnssec-settime.rst index e09947e3d0..0be2c3b499 100644 --- a/bin/dnssec/dnssec-settime.rst +++ b/bin/dnssec/dnssec-settime.rst @@ -40,7 +40,7 @@ timing metadata as specified by the ``-P``, ``-A``, ``-R``, ``-I``, and other signing software to determine when a key is to be published, whether it should be used for signing a zone, etc. -If none of these options is set on the command line, then +If none of these options is set on the command line, ``dnssec-settime`` simply prints the key timing metadata already stored in the key. @@ -54,155 +54,157 @@ the key file. The private file's permissions are always set to be inaccessible to anyone other than the owner (mode 0600). When working with state files, it is possible to update the timing metadata in -those files as well with ``-s``. If this option is used you can also update key +those files as well with ``-s``. With this option, it is also possible to update key states with ``-d`` (DS), ``-k`` (DNSKEY), ``-r`` (RRSIG of KSK), or ``-z`` (RRSIG of ZSK). Allowed states are HIDDEN, RUMOURED, OMNIPRESENT, and UNRETENTIVE. -You can also set the goal state of the key with ``-g``. This should be either -HIDDEN or OMNIPRESENT (representing whether the key should be removed from the -zone, or published). +The goal state of the key can also be set with ``-g``. This should be either +HIDDEN or OMNIPRESENT, representing whether the key should be removed from the +zone or published. -It is NOT RECOMMENDED to manipulate state files manually except for testing +It is NOT RECOMMENDED to manipulate state files manually, except for testing purposes. Options ~~~~~~~ -**-f** - Force an update of an old-format key with no metadata fields. Without - this option, ``dnssec-settime`` will fail when attempting to update a - legacy key. With this option, the key will be recreated in the new +``-f`` + This option forces an update of an old-format key with no metadata fields. Without + this option, ``dnssec-settime`` fails when attempting to update a + legacy key. With this option, the key is recreated in the new format, but with the original key data retained. The key's creation - date will be set to the present time. If no other values are - specified, then the key's publication and activation dates will also - be set to the present time. + date is set to the present time. If no other values are + specified, then the key's publication and activation dates are also + set to the present time. -**-K** directory - Sets the directory in which the key files are to reside. +``-K directory`` + This option sets the directory in which the key files are to reside. -**-L** ttl - Sets the default TTL to use for this key when it is converted into a - DNSKEY RR. If the key is imported into a zone, this is the TTL that - will be used for it, unless there was already a DNSKEY RRset in - place, in which case the existing TTL would take precedence. If this - value is not set and there is no existing DNSKEY RRset, the TTL will - default to the SOA TTL. Setting the default TTL to ``0`` or ``none`` +``-L ttl`` + This option sets the default TTL to use for this key when it is converted into a + DNSKEY RR. This is the TTL used when the key is imported into a zone, + unless there was already a DNSKEY RRset in + place, in which case the existing TTL takes precedence. If this + value is not set and there is no existing DNSKEY RRset, the TTL + defaults to the SOA TTL. Setting the default TTL to ``0`` or ``none`` removes it from the key. -**-h** - Emit usage message and exit. +``-h`` + This option emits a usage message and exits. -**-V** - Prints version information. +``-V`` + This option prints version information. -**-v** level - Sets the debugging level. +``-v level`` + This option sets the debugging level. -**-E** engine - Specifies the cryptographic hardware to use, when applicable. +``-E engine`` + This option specifies the cryptographic hardware to use, when applicable. When BIND is built with OpenSSL PKCS#11 support, this defaults to the - string "pkcs11", which identifies an OpenSSL engine that can drive a + string ``pkcs11``, which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is - built with native PKCS#11 cryptography (--enable-native-pkcs11), it + built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it defaults to the path of the PKCS#11 provider library specified via - "--with-pkcs11". + ``--with-pkcs11``. Timing Options ~~~~~~~~~~~~~~ Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the -argument begins with a '+' or '-', it is interpreted as an offset from +argument begins with a ``+`` or ``-``, it is interpreted as an offset from the present time. For convenience, if such an offset is followed by one -of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is +of the suffixes ``y``, ``mo``, ``w``, ``d``, ``h``, or ``mi``, then the offset is computed in years (defined as 365 24-hour days, ignoring leap years), months (defined as 30 24-hour days), weeks, days, hours, or minutes, respectively. Without a suffix, the offset is computed in seconds. To -unset a date, use 'none' or 'never'. +explicitly prevent a date from being set, use ``none`` or ``never``. -**-P** date/offset - Sets the date on which a key is to be published to the zone. After - that date, the key will be included in the zone but will not be used +``-P date/offset`` + This option sets the date on which a key is to be published to the zone. After + that date, the key is included in the zone but is not used to sign it. -**-P** sync date/offset - Sets the date on which CDS and CDNSKEY records that match this key +``-P sync date/offset`` + This option sets the date on which CDS and CDNSKEY records that match this key are to be published to the zone. -**-A** date/offset - Sets the date on which the key is to be activated. After that date, - the key will be included in the zone and used to sign it. +``-A date/offset`` + This option sets the date on which the key is to be activated. After that date, + the key is included in the zone and used to sign it. -**-R** date/offset - Sets the date on which the key is to be revoked. After that date, the - key will be flagged as revoked. It will be included in the zone and - will be used to sign it. +``-R date/offset`` + This option sets the date on which the key is to be revoked. After that date, the + key is flagged as revoked. It is included in the zone and + is used to sign it. -**-I** date/offset - Sets the date on which the key is to be retired. After that date, the - key will still be included in the zone, but it will not be used to +``-I date/offset`` + This option sets the date on which the key is to be retired. After that date, the + key is still included in the zone, but it is not used to sign it. -**-D** date/offset - Sets the date on which the key is to be deleted. After that date, the - key will no longer be included in the zone. (It may remain in the key - repository, however.) +``-D date/offset`` + This option sets the date on which the key is to be deleted. After that date, the + key is no longer included in the zone. (However, it may remain in the key + repository.) -**-D** sync date/offset - Sets the date on which the CDS and CDNSKEY records that match this +``-D sync date/offset`` + This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -**-S** predecessor key - Select a key for which the key being modified will be an explicit +``-S predecessor key`` + This option selects a key for which the key being modified is an explicit successor. The name, algorithm, size, and type of the predecessor key must exactly match those of the key being modified. The activation - date of the successor key will be set to the inactivation date of the - predecessor. The publication date will be set to the activation date + date of the successor key is set to the inactivation date of the + predecessor. The publication date is set to the activation date minus the prepublication interval, which defaults to 30 days. -**-i** interval - Sets the prepublication interval for a key. If set, then the +``-i interval`` + This option sets the prepublication interval for a key. If set, then the publication and activation dates must be separated by at least this much time. If the activation date is specified but the publication - date isn't, then the publication date will default to this much time + date is not, the publication date defaults to this much time before the activation date; conversely, if the publication date is - specified but activation date isn't, then activation will be set to + specified but not the activation date, activation is set to this much time after publication. - If the key is being set to be an explicit successor to another key, + If the key is being created as an explicit successor to another key, then the default prepublication interval is 30 days; otherwise it is zero. As with date offsets, if the argument is followed by one of the - suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is + suffixes ``y``, ``mo``, ``w``, ``d``, ``h``, or ``mi``, the interval is measured in years, months, weeks, days, hours, or minutes, respectively. Without a suffix, the interval is measured in seconds. Key State Options ~~~~~~~~~~~~~~~~~ -Known key states are HIDDEN, RUMOURED, OMNIPRESENT and UNRETENTIVE. These should -not be set manually except for testing purposes. +To test dnssec-policy it may be necessary to construct keys with artificial +state information; these options are used by the testing framework for that +purpose, but should never be used in production. + +Known key states are HIDDEN, RUMOURED, OMNIPRESENT, and UNRETENTIVE. ``-s`` - When setting key timing data, also update the state file. + This option indicates that when setting key timing data, the state file should also be updated. -``-g`` - Set the goal state for this key. Must be HIDDEN or OMNIPRESENT. +``-g state`` + This option sets the goal state for this key. Must be HIDDEN or OMNIPRESENT. -``-d`` - Set the DS state for this key, and when it was last changed. +``-d state date/offset`` + This option sets the DS state for this key as of the specified date, offset from the current date. -``-k`` - Set the DNSKEY state for this key, and when it was last changed. +``-k state date/offset`` + This option sets the DNSKEY state for this key as of the specified date, offset from the current date. -``-r`` - Set the RRSIG (KSK) state for this key, and when it was last changed. +``-r state date/offset`` + This option sets the RRSIG (KSK) state for this key as of the specified date, offset from the current date. -``-z`` - - Set the RRSIG (ZSK) state for this key, and when it was last changed. +``-z state date/offset`` + This option sets the RRSIG (ZSK) state for this key as of the specified date, offset from the current date. Printing Options ~~~~~~~~~~~~~~~~ @@ -210,18 +212,18 @@ Printing Options ``dnssec-settime`` can also be used to print the timing metadata associated with a key. -**-u** - Print times in UNIX epoch format. +``-u`` + This option indicates that times should be printed in Unix epoch format. -**-p** C/P/Psync/A/R/I/D/Dsync/all - Print a specific metadata value or set of metadata values. The ``-p`` +``-p C/P/Psync/A/R/I/D/Dsync/all`` + This option prints a specific metadata value or set of metadata values. The ``-p`` option may be followed by one or more of the following letters or strings to indicate which value or values to print: ``C`` for the creation date, ``P`` for the publication date, ``Psync`` for the CDS and CDNSKEY publication date, ``A`` for the activation date, ``R`` for the revocation date, ``I`` for the inactivation date, ``D`` for the deletion date, and ``Dsync`` for the CDS and CDNSKEY deletion - date To print all of the metadata, use ``-p all``. + date. To print all of the metadata, use ``all``. See Also ~~~~~~~~ diff --git a/bin/dnssec/dnssec-signzone.rst b/bin/dnssec/dnssec-signzone.rst index de3a0315ea..869321bb98 100644 --- a/bin/dnssec/dnssec-signzone.rst +++ b/bin/dnssec/dnssec-signzone.rst @@ -34,233 +34,232 @@ Synopsis Description ~~~~~~~~~~~ -``dnssec-signzone`` signs a zone. It generates NSEC and RRSIG records +``dnssec-signzone`` signs a zone; it generates NSEC and RRSIG records and produces a signed version of the zone. The security status of delegations from the signed zone (that is, whether the child zones are -secure or not) is determined by the presence or absence of a ``keyset`` +secure) is determined by the presence or absence of a ``keyset`` file for each child zone. Options ~~~~~~~ -**-a** - Verify all generated signatures. +``-a`` + This option verifies all generated signatures. -**-c** class - Specifies the DNS class of the zone. +``-c class`` + This option specifies the DNS class of the zone. -**-C** - Compatibility mode: Generate a ``keyset-zonename`` file in addition +``-C`` + This option sets compatibility mode, in which a ``keyset-zonename`` file is generated in addition to ``dsset-zonename`` when signing a zone, for use by older versions of ``dnssec-signzone``. -**-d** directory - Look for ``dsset-`` or ``keyset-`` files in ``directory``. +``-d directory`` + This option indicates the directory where BIND 9 should look for ``dsset-`` or ``keyset-`` files. -**-D** - Output only those record types automatically managed by - ``dnssec-signzone``, i.e. RRSIG, NSEC, NSEC3 and NSEC3PARAM records. +``-D`` + This option indicates that only those record types automatically managed by + ``dnssec-signzone``, i.e., RRSIG, NSEC, NSEC3 and NSEC3PARAM records, should be included in the output. If smart signing (``-S``) is used, DNSKEY records are also included. The resulting file can be included in the original zone file with ``$INCLUDE``. This option cannot be combined with ``-O raw``, - ``-O map``, or serial number updating. + ``-O map``, or serial-number updating. -**-E** engine - When applicable, specifies the hardware to use for cryptographic - operations, such as a secure key store used for signing. +``-E engine`` + This option specifies the hardware to use for cryptographic + operations, such as a secure key store used for signing, when applicable. When BIND is built with OpenSSL PKCS#11 support, this defaults to the - string "pkcs11", which identifies an OpenSSL engine that can drive a + string ``pkcs11``, which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is - built with native PKCS#11 cryptography (--enable-native-pkcs11), it + built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it defaults to the path of the PKCS#11 provider library specified via - "--with-pkcs11". + ``--with-pkcs11``. -**-g** - Generate DS records for child zones from ``dsset-`` or ``keyset-`` - file. Existing DS records will be removed. +``-g`` + This option indicates that DS records for child zones should be generated from a ``dsset-`` or ``keyset-`` + file. Existing DS records are removed. -**-K** directory - Key repository: Specify a directory to search for DNSSEC keys. If not - specified, defaults to the current directory. +``-K directory`` + This option specifies the directory to search for DNSSEC keys. If not + specified, it defaults to the current directory. -**-k** key - Treat specified key as a key signing key ignoring any key flags. This +``-k key`` + This option tells BIND 9 to treat the specified key as a key-signing key, ignoring any key flags. This option may be specified multiple times. -**-M** maxttl - Sets the maximum TTL for the signed zone. Any TTL higher than maxttl - in the input zone will be reduced to maxttl in the output. This +``-M maxttl`` + This option sets the maximum TTL for the signed zone. Any TTL higher than ``maxttl`` + in the input zone is reduced to ``maxttl`` in the output. This provides certainty as to the largest possible TTL in the signed zone, - which is useful to know when rolling keys because it is the longest + which is useful to know when rolling keys. The maxttl is the longest possible time before signatures that have been retrieved by resolvers - will expire from resolver caches. Zones that are signed with this + expire from resolver caches. Zones that are signed with this option should be configured to use a matching ``max-zone-ttl`` in ``named.conf``. (Note: This option is incompatible with ``-D``, because it modifies non-DNSSEC data in the output zone.) -**-s** start-time - Specify the date and time when the generated RRSIG records become +``-s start-time`` + This option specifies the date and time when the generated RRSIG records become valid. This can be either an absolute or relative time. An absolute start time is indicated by a number in YYYYMMDDHHMMSS notation; 20000530144500 denotes 14:45:00 UTC on May 30th, 2000. A relative - start time is indicated by +N, which is N seconds from the current + start time is indicated by ``+N``, which is N seconds from the current time. If no ``start-time`` is specified, the current time minus 1 hour (to allow for clock skew) is used. -**-e** end-time - Specify the date and time when the generated RRSIG records expire. As +``-e end-time`` + This option specifies the date and time when the generated RRSIG records expire. As with ``start-time``, an absolute time is indicated in YYYYMMDDHHMMSS - notation. A time relative to the start time is indicated with +N, + notation. A time relative to the start time is indicated with ``+N``, which is N seconds from the start time. A time relative to the - current time is indicated with now+N. If no ``end-time`` is - specified, 30 days from the start time is used as a default. + current time is indicated with ``now+N``. If no ``end-time`` is + specified, 30 days from the start time is the default. ``end-time`` must be later than ``start-time``. -**-X** extended end-time - Specify the date and time when the generated RRSIG records for the - DNSKEY RRset will expire. This is to be used in cases when the DNSKEY +``-X extended end-time`` + This option specifies the date and time when the generated RRSIG records for the + DNSKEY RRset expire. This is to be used in cases when the DNSKEY signatures need to persist longer than signatures on other records; e.g., when the private component of the KSK is kept offline and the KSK signature is to be refreshed manually. - As with ``start-time``, an absolute time is indicated in + As with ``end-time``, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is - indicated with +N, which is N seconds from the start time. A time - relative to the current time is indicated with now+N. If no + indicated with ``+N``, which is N seconds from the start time. A time + relative to the current time is indicated with ``now+N``. If no ``extended end-time`` is specified, the value of ``end-time`` is used as the default. (``end-time``, in turn, defaults to 30 days from the start time.) ``extended end-time`` must be later than ``start-time``. -**-f** output-file - The name of the output file containing the signed zone. The default +``-f output-file`` + This option indicates the name of the output file containing the signed zone. The default is to append ``.signed`` to the input filename. If ``output-file`` is - set to ``"-"``, then the signed zone is written to the standard - output, with a default output format of "full". + set to ``-``, then the signed zone is written to the standard + output, with a default output format of ``full``. -**-h** - Prints a short summary of the options and arguments to +``-h`` + This option prints a short summary of the options and arguments to ``dnssec-signzone``. -**-V** - Prints version information. +``-V`` + This option prints version information. -**-i** interval - When a previously-signed zone is passed as input, records may be - resigned. The ``interval`` option specifies the cycle interval as an - offset from the current time (in seconds). If a RRSIG record expires - after the cycle interval, it is retained. Otherwise, it is considered - to be expiring soon, and it will be replaced. +``-i interval`` + This option indicates that, when a previously signed zone is passed as input, records may be + re-signed. The ``interval`` option specifies the cycle interval as an + offset from the current time, in seconds. If a RRSIG record expires + after the cycle interval, it is retained; otherwise, it is considered + to be expiring soon and it is replaced. The default cycle interval is one quarter of the difference between - the signature end and start times. So if neither ``end-time`` or - ``start-time`` are specified, ``dnssec-signzone`` generates + the signature end and start times. So if neither ``end-time`` nor + ``start-time`` is specified, ``dnssec-signzone`` generates signatures that are valid for 30 days, with a cycle interval of 7.5 days. Therefore, if any existing RRSIG records are due to expire in - less than 7.5 days, they would be replaced. + less than 7.5 days, they are replaced. -**-I** input-format - The format of the input zone file. Possible formats are ``"text"`` - (default), ``"raw"``, and ``"map"``. This option is primarily - intended to be used for dynamic signed zones so that the dumped zone +``-I input-format`` + This option sets the format of the input zone file. Possible formats are ``text`` + (the default), ``raw``, and ``map``. This option is primarily + intended to be used for dynamic signed zones, so that the dumped zone file in a non-text format containing updates can be signed directly. - The use of this option does not make much sense for non-dynamic - zones. + This option is not useful for non-dynamic zones. -**-j** jitter +``-j jitter`` When signing a zone with a fixed signature lifetime, all RRSIG - records issued at the time of signing expires simultaneously. If the - zone is incrementally signed, i.e. a previously-signed zone is passed - as input to the signer, all expired signatures have to be regenerated - at about the same time. The ``jitter`` option specifies a jitter - window that will be used to randomize the signature expire time, thus + records issued at the time of signing expire simultaneously. If the + zone is incrementally signed, i.e., a previously signed zone is passed + as input to the signer, all expired signatures must be regenerated + at approximately the same time. The ``jitter`` option specifies a jitter + window that is used to randomize the signature expire time, thus spreading incremental signature regeneration over time. - Signature lifetime jitter also to some extent benefits validators and - servers by spreading out cache expiration, i.e. if large numbers of - RRSIGs don't expire at the same time from all caches there will be - less congestion than if all validators need to refetch at mostly the + Signature lifetime jitter also, to some extent, benefits validators and + servers by spreading out cache expiration, i.e., if large numbers of + RRSIGs do not expire at the same time from all caches, there is + less congestion than if all validators need to refetch at around the same time. -**-L** serial - When writing a signed zone to "raw" or "map" format, set the "source - serial" value in the header to the specified serial number. (This is +``-L serial`` + When writing a signed zone to "raw" or "map" format, this option sets the "source + serial" value in the header to the specified ``serial`` number. (This is expected to be used primarily for testing purposes.) -**-n** ncpus - Specifies the number of threads to use. By default, one thread is +``-n ncpus`` + This option specifies the number of threads to use. By default, one thread is started for each detected CPU. -**-N** soa-serial-format - The SOA serial number format of the signed zone. Possible formats are - ``"keep"`` (default), ``"increment"``, ``"unixtime"``, and - ``"date"``. +``-N soa-serial-format`` + This option sets the SOA serial number format of the signed zone. Possible formats are + ``keep`` (the default), ``increment``, ``unixtime``, and + ``date``. - ``"keep"`` - Do not modify the SOA serial number. + **keep** + This format indicates that the SOA serial number should not be modified. - ``"increment"`` - Increment the SOA serial number using :rfc:`1982` arithmetic. + **increment** + This format increments the SOA serial number using :rfc:`1982` arithmetic. - ``"unixtime"`` - Set the SOA serial number to the number of seconds since epoch. + **unixtime** + This format sets the SOA serial number to the number of seconds since the beginning of the Unix epoch. - ``"date"`` - Set the SOA serial number to today's date in YYYYMMDDNN format. + **date** + This format sets the SOA serial number to today's date, in YYYYMMDDNN format. -**-o** origin - The zone origin. If not specified, the name of the zone file is +``-o origin`` + This option sets the zone origin. If not specified, the name of the zone file is assumed to be the origin. -**-O** output-format - The format of the output file containing the signed zone. Possible - formats are ``"text"`` (default), which is the standard textual - representation of the zone; ``"full"``, which is text output in a - format suitable for processing by external scripts; and ``"map"``, - ``"raw"``, and ``"raw=N"``, which store the zone in binary formats - for rapid loading by ``named``. ``"raw=N"`` specifies the format +``-O output-format`` + This option sets the format of the output file containing the signed zone. Possible + formats are ``text`` (the default), which is the standard textual + representation of the zone; ``full``, which is text output in a + format suitable for processing by external scripts; and ``map``, + ``raw``, and ``raw=N``, which store the zone in binary formats + for rapid loading by ``named``. ``raw=N`` specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of ``named``; if N is 1, the file can be read by release - 9.9.0 or higher; the default is 1. + 9.9.0 or higher. The default is 1. -**-P** - Disable post sign verification tests. +``-P`` + This option disables post-sign verification tests. - The post sign verification test ensures that for each algorithm in - use there is at least one non revoked self signed KSK key, that all - revoked KSK keys are self signed, and that all records in the zone + The post-sign verification tests ensure that for each algorithm in + use there is at least one non-revoked self-signed KSK key, that all + revoked KSK keys are self-signed, and that all records in the zone are signed by the algorithm. This option skips these tests. -**-Q** - Remove signatures from keys that are no longer active. +``-Q`` + This option removes signatures from keys that are no longer active. - Normally, when a previously-signed zone is passed as input to the + Normally, when a previously signed zone is passed as input to the signer, and a DNSKEY record has been removed and replaced with a new one, signatures from the old key that are still within their validity period are retained. This allows the zone to continue to validate - with cached copies of the old DNSKEY RRset. The ``-Q`` forces + with cached copies of the old DNSKEY RRset. The ``-Q`` option forces ``dnssec-signzone`` to remove signatures from keys that are no longer active. This enables ZSK rollover using the procedure described in :rfc:`4641#4.2.1.1` ("Pre-Publish Key Rollover"). ``-q`` - Quiet mode: Suppresses unnecessary output. Without this option, when - ``dnssec-signzone`` is run it will print to standard output the number of - keys in use, the algorithms used to verify the zone was signed correctly and - other status information, and finally the filename containing the signed - zone. With it, that output is suppressed, leaving only the filename. + This option enables quiet mode, which suppresses unnecessary output. Without this option, when + ``dnssec-signzone`` is run it prints three pieces of information to standard output: the number of + keys in use; the algorithms used to verify the zone was signed correctly and + other status information; and the filename containing the signed + zone. With the option that output is suppressed, leaving only the filename. -**-R** - Remove signatures from keys that are no longer published. +``-R`` + This option removes signatures from keys that are no longer published. This option is similar to ``-Q``, except it forces - ``dnssec-signzone`` to signatures from keys that are no longer + ``dnssec-signzone`` to remove signatures from keys that are no longer published. This enables ZSK rollover using the procedure described in :rfc:`4641#4.2.1.2` ("Double Signature Zone Signing Key Rollover"). -**-S** - Smart signing: Instructs ``dnssec-signzone`` to search the key +``-S`` + This option enables smart signing, which instructs ``dnssec-signzone`` to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate. @@ -274,94 +273,94 @@ Options If the key's publication date is set and is in the past, the key is published in the zone. - If the key's activation date is set and in the past, the key is + If the key's activation date is set and is in the past, the key is published (regardless of publication date) and used to sign the zone. - If the key's revocation date is set and in the past, and the key + If the key's revocation date is set and is in the past, and the key is published, then the key is revoked, and the revoked key is used to sign the zone. - If either of the key's unpublication or deletion dates are set and + If either the key's unpublication or deletion date is set and in the past, the key is NOT published or used to sign the zone, regardless of any other metadata. - If key's sync publication date is set and in the past, + If the key's sync publication date is set and is in the past, synchronization records (type CDS and/or CDNSKEY) are created. - If key's sync deletion date is set and in the past, + If the key's sync deletion date is set and is in the past, synchronization records (type CDS and/or CDNSKEY) are removed. -**-T** ttl - Specifies a TTL to be used for new DNSKEY records imported into the +``-T ttl`` + This option specifies a TTL to be used for new DNSKEY records imported into the zone from the key repository. If not specified, the default is the TTL value from the zone's SOA record. This option is ignored when signing without ``-S``, since DNSKEY records are not imported from the key repository in that case. It is also ignored if there are any pre-existing DNSKEY records at the zone apex, in which case new - records' TTL values will be set to match them, or if any of the - imported DNSKEY records had a default TTL value. In the event of a a + records' TTL values are set to match them, or if any of the + imported DNSKEY records had a default TTL value. In the event of a conflict between TTL values in imported keys, the shortest one is used. -**-t** - Print statistics at completion. +``-t`` + This option prints statistics at completion. -**-u** - Update NSEC/NSEC3 chain when re-signing a previously signed zone. +``-u`` + This option updates the NSEC/NSEC3 chain when re-signing a previously signed zone. With this option, a zone signed with NSEC can be switched to NSEC3, - or a zone signed with NSEC3 can be switch to NSEC or to NSEC3 with - different parameters. Without this option, ``dnssec-signzone`` will - retain the existing chain when re-signing. + or a zone signed with NSEC3 can be switched to NSEC or to NSEC3 with + different parameters. Without this option, ``dnssec-signzone`` + retains the existing chain when re-signing. -**-v** level - Sets the debugging level. +``-v level`` + This option sets the debugging level. -**-x** - Only sign the DNSKEY, CDNSKEY, and CDS RRsets with key-signing keys, - and omit signatures from zone-signing keys. (This is similar to the +``-x`` + This option indicates that BIND 9 should only sign the DNSKEY, CDNSKEY, and CDS RRsets with key-signing keys, + and should omit signatures from zone-signing keys. (This is similar to the ``dnssec-dnskey-kskonly yes;`` zone option in ``named``.) -**-z** - Ignore KSK flag on key when determining what to sign. This causes +``-z`` + This option indicates that BIND 9 should ignore the KSK flag on keys when determining what to sign. This causes KSK-flagged keys to sign all records, not just the DNSKEY RRset. (This is similar to the ``update-check-ksk no;`` zone option in ``named``.) -**-3** salt - Generate an NSEC3 chain with the given hex encoded salt. A dash - (salt) can be used to indicate that no salt is to be used when +``-3 salt`` + This option generates an NSEC3 chain with the given hex-encoded salt. A dash + (-) can be used to indicate that no salt is to be used when generating the NSEC3 chain. -**-H** iterations - When generating an NSEC3 chain, use this many iterations. The default +``-H iterations`` + This option indicates that, when generating an NSEC3 chain, BIND 9 should use this many iterations. The default is 10. -**-A** - When generating an NSEC3 chain set the OPTOUT flag on all NSEC3 - records and do not generate NSEC3 records for insecure delegations. +``-A`` + This option indicates that, when generating an NSEC3 chain, BIND 9 should set the OPTOUT flag on all NSEC3 + records and should not generate NSEC3 records for insecure delegations. Using this option twice (i.e., ``-AA``) turns the OPTOUT flag off for all records. This is useful when using the ``-u`` option to modify an NSEC3 chain which previously had OPTOUT set. -**zonefile** - The file containing the zone to be signed. +``zonefile`` + This option sets the file containing the zone to be signed. -**key** - Specify which keys should be used to sign the zone. If no keys are - specified, then the zone will be examined for DNSKEY records at the - zone apex. If these are found and there are matching private keys, in - the current directory, then these will be used for signing. +``key`` + This option specifies which keys should be used to sign the zone. If no keys are + specified, the zone is examined for DNSKEY records at the + zone apex. If these records are found and there are matching private keys in + the current directory, they are used for signing. Example ~~~~~~~ The following command signs the ``example.com`` zone with the -ECDSAP256SHA256 key generated by key generated by ``dnssec-keygen`` +ECDSAP256SHA256 key generated by ``dnssec-keygen`` (Kexample.com.+013+17247). Because the ``-S`` option is not being used, the zone's keys must be in the master file (``db.example.com``). This -invocation looks for ``dsset`` files, in the current directory, so that +invocation looks for ``dsset`` files in the current directory, so that DS records can be imported from them (``-g``). :: @@ -373,7 +372,7 @@ DS records can be imported from them (``-g``). In the above example, ``dnssec-signzone`` creates the file ``db.example.com.signed``. This file should be referenced in a zone -statement in a ``named.conf`` file. +statement in the ``named.conf`` file. This example re-signs a previously signed zone with default parameters. The private keys are assumed to be in the current directory. diff --git a/bin/dnssec/dnssec-verify.rst b/bin/dnssec/dnssec-verify.rst index cea81e164f..a6b0a81720 100644 --- a/bin/dnssec/dnssec-verify.rst +++ b/bin/dnssec/dnssec-verify.rst @@ -35,72 +35,72 @@ Description ~~~~~~~~~~~ ``dnssec-verify`` verifies that a zone is fully signed for each -algorithm found in the DNSKEY RRset for the zone, and that the NSEC / -NSEC3 chains are complete. +algorithm found in the DNSKEY RRset for the zone, and that the +NSEC/NSEC3 chains are complete. Options ~~~~~~~ -**-c** class - Specifies the DNS class of the zone. +``-c class`` + This option specifies the DNS class of the zone. -**-E** engine - Specifies the cryptographic hardware to use, when applicable. +``-E engine`` + This option specifies the cryptographic hardware to use, when applicable. When BIND is built with OpenSSL PKCS#11 support, this defaults to the - string "pkcs11", which identifies an OpenSSL engine that can drive a + string ``pkcs11``, which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is - built with native PKCS#11 cryptography (--enable-native-pkcs11), it + built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it defaults to the path of the PKCS#11 provider library specified via - "--with-pkcs11". + ``--with-pkcs11``. -**-I** input-format - The format of the input zone file. Possible formats are ``"text"`` - (default) and ``"raw"``. This option is primarily intended to be used - for dynamic signed zones so that the dumped zone file in a non-text - format containing updates can be verified independently. The use of - this option does not make much sense for non-dynamic zones. +``-I input-format`` + This option sets the format of the input zone file. Possible formats are ``text`` + (the default) and ``raw``. This option is primarily intended to be used + for dynamic signed zones, so that the dumped zone file in a non-text + format containing updates can be verified independently. + This option is not useful for non-dynamic zones. -**-o** origin - The zone origin. If not specified, the name of the zone file is +``-o origin`` + This option indicates the zone origin. If not specified, the name of the zone file is assumed to be the origin. -**-v** level - Sets the debugging level. +``-v level`` + This option sets the debugging level. -**-V** - Prints version information. +``-V`` + This option prints version information. ``-q`` - Quiet mode: Suppresses output. Without this option, when ``dnssec-verify`` - is run it will print to standard output the number of keys in use, the - algorithms used to verify the zone was signed correctly and other status - information. With it, all non-error output is suppressed, and only the exit - code will indicate success. + This option sets quiet mode, which suppresses output. Without this option, when ``dnssec-verify`` + is run it prints to standard output the number of keys in use, the + algorithms used to verify the zone was signed correctly, and other status + information. With this option, all non-error output is suppressed, and only the exit + code indicates success. -**-x** - Only verify that the DNSKEY RRset is signed with key-signing keys. - Without this flag, it is assumed that the DNSKEY RRset will be signed - by all active keys. When this flag is set, it will not be an error if +``-x`` + This option verifies only that the DNSKEY RRset is signed with key-signing keys. + Without this flag, it is assumed that the DNSKEY RRset is signed + by all active keys. When this flag is set, it is not an error if the DNSKEY RRset is not signed by zone-signing keys. This corresponds to the ``-x`` option in ``dnssec-signzone``. -**-z** - Ignore the KSK flag on the keys when determining whether the zone if - correctly signed. Without this flag it is assumed that there will be +``-z`` + This option indicates that the KSK flag on the keys should be ignored when determining whether the zone is + correctly signed. Without this flag, it is assumed that there is a non-revoked, self-signed DNSKEY with the KSK flag set for each - algorithm and that RRsets other than DNSKEY RRset will be signed with + algorithm, and that RRsets other than DNSKEY RRset are signed with a different DNSKEY without the KSK flag set. - With this flag set, we only require that for each algorithm, there - will be at least one non-revoked, self-signed DNSKEY, regardless of - the KSK flag state, and that other RRsets will be signed by a + With this flag set, BIND 9 only requires that for each algorithm, there + be at least one non-revoked, self-signed DNSKEY, regardless of + the KSK flag state, and that other RRsets be signed by a non-revoked key for the same algorithm that includes the self-signed key; the same key may be used for both purposes. This corresponds to the ``-z`` option in ``dnssec-signzone``. -**zonefile** - The file containing the zone to be signed. +``zonefile`` + This option indicates the file containing the zone to be signed. See Also ~~~~~~~~ diff --git a/bin/named/named.conf.rst b/bin/named/named.conf.rst index 0716c1b748..9d35c4d83e 100644 --- a/bin/named/named.conf.rst +++ b/bin/named/named.conf.rst @@ -1,6 +1,6 @@ .. highlight: console -named.conf - configuration file for **named** +named.conf - configuration file for ``named`` --------------------------------------------- Synopsis @@ -12,13 +12,13 @@ Description ~~~~~~~~~~~ ``named.conf`` is the configuration file for ``named``. Statements are -enclosed in braces and terminated with a semi-colon. Clauses in the +enclosed in braces (``[ ]``) and terminated with a semi-colon (``;``). Clauses in the statements are also semi-colon terminated. The usual comment styles are supported: C style: /\* \*/ - C++ style: // to end of line +C++ style: // to end of line Unix style: # to end of line diff --git a/bin/named/named.rst b/bin/named/named.rst index 3c54a67e5c..d4b97a971f 100644 --- a/bin/named/named.rst +++ b/bin/named/named.rst @@ -38,119 +38,119 @@ Description distribution from ISC. For more information on the DNS, see :rfc:`1033`, :rfc:`1034`, and :rfc:`1035`. -When invoked without arguments, ``named`` will read the default -configuration file ``/etc/named.conf``, read any initial data, and -listen for queries. +When invoked without arguments, ``named`` reads the default +configuration file ``/etc/named.conf``, reads any initial data, and +listens for queries. Options ~~~~~~~ -**-4** - Use IPv4 only even if the host machine is capable of IPv6. ``-4`` and +``-4`` + This option tells ``named`` to use only IPv4, even if the host machine is capable of IPv6. ``-4`` and ``-6`` are mutually exclusive. -**-6** - Use IPv6 only even if the host machine is capable of IPv4. ``-4`` and +``-6`` + This option tells ``named`` to use only IPv6, even if the host machine is capable of IPv4. ``-4`` and ``-6`` are mutually exclusive. -**-c** config-file - Use config-file as the configuration file instead of the default, - ``/etc/named.conf``. To ensure that reloading the configuration file - continues to work after the server has changed its working directory +``-c config-file`` + This option tells ``named`` to use ``config-file`` as its configuration file instead of the default, + ``/etc/named.conf``. To ensure that the configuration file + can be reloaded after the server has changed its working directory due to to a possible ``directory`` option in the configuration file, - config-file should be an absolute pathname. + ``config-file`` should be an absolute pathname. -**-d** debug-level - Set the daemon's debug level to debug-level. Debugging traces from +``-d debug-level`` + This option sets the daemon's debug level to ``debug-level``. Debugging traces from ``named`` become more verbose as the debug level increases. -**-D** string - Specifies a string that is used to identify a instance of ``named`` - in a process listing. The contents of string are not examined. +``-D string`` + This option specifies a string that is used to identify a instance of ``named`` + in a process listing. The contents of ``string`` are not examined. -**-E** engine-name - When applicable, specifies the hardware to use for cryptographic +``-E engine-name`` + When applicable, this option specifies the hardware to use for cryptographic operations, such as a secure key store used for signing. When BIND is built with OpenSSL PKCS#11 support, this defaults to the - string "pkcs11", which identifies an OpenSSL engine that can drive a + string ``pkcs11``, which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module. When BIND is - built with native PKCS#11 cryptography (--enable-native-pkcs11), it + built with native PKCS#11 cryptography (``--enable-native-pkcs11``), it defaults to the path of the PKCS#11 provider library specified via - "--with-pkcs11". + ``--with-pkcs11``. -**-f** - Run the server in the foreground (i.e. do not daemonize). +``-f`` + This option runs the server in the foreground (i.e., do not daemonize). -**-g** - Run the server in the foreground and force all logging to ``stderr``. +``-g`` + This option runs the server in the foreground and forces all logging to ``stderr``. -**-L** logfile - Log to the file ``logfile`` by default instead of the system log. +``-L logfile`` + This option sets the log to the file ``logfile`` by default, instead of the system log. -**-M** option - Sets the default memory context options. If set to external, this - causes the internal memory manager to be bypassed in favor of - system-provided memory allocation functions. If set to fill, blocks - of memory will be filled with tag values when allocated or freed, to - assist debugging of memory problems. (nofill disables this behavior, +``-M option`` + This option sets the default memory context options. If set to ``external``, + the internal memory manager is bypassed in favor of + system-provided memory allocation functions. If set to ``fill``, blocks + of memory are filled with tag values when allocated or freed, to + assist debugging of memory problems. ``nofill`` disables this behavior, and is the default unless ``named`` has been compiled with developer - options.) + options. -**-m** flag - Turn on memory usage debugging flags. Possible flags are usage, - trace, record, size, and mctx. These correspond to the - ISC_MEM_DEBUGXXXX flags described in ````. +``-m flag`` + This option turns on memory usage debugging flags. Possible flags are ``usage``, + ``trace``, ``record``, ``size``, and ``mctx``. These correspond to the + ``ISC_MEM_DEBUGXXXX`` flags described in ````. -**-n** #cpus - Create #cpus worker threads to take advantage of multiple CPUs. If - not specified, ``named`` will try to determine the number of CPUs - present and create one thread per CPU. If it is unable to determine - the number of CPUs, a single worker thread will be created. +``-n #cpus`` + This option creates ``#cpus`` worker threads to take advantage of multiple CPUs. If + not specified, ``named`` tries to determine the number of CPUs + present and creates one thread per CPU. If it is unable to determine + the number of CPUs, a single worker thread is created. -**-p** port - Listen for queries on port port. If not specified, the default is +``-p port`` + This option listens for queries on ``port``. If not specified, the default is port 53. -**-s** - Write memory usage statistics to ``stdout`` on exit. +``-s`` + This option writes memory usage statistics to ``stdout`` on exit. .. note:: This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. -**-S** #max-socks - Allow ``named`` to use up to #max-socks sockets. The default value is +``-S #max-socks`` + This option allows ``named`` to use up to ``#max-socks`` sockets. The default value is 21000 on systems built with default configuration options, and 4096 - on systems built with "configure --with-tuning=small". + on systems built with ``configure --with-tuning=small``. .. warning:: This option should be unnecessary for the vast majority of users. - The use of this option could even be harmful because the specified + The use of this option could even be harmful, because the specified value may exceed the limitation of the underlying system API. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets. Note also that - the actual maximum number is normally a little fewer than the - specified value because ``named`` reserves some file descriptors + the actual maximum number is normally slightly fewer than the + specified value, because ``named`` reserves some file descriptors for its internal use. -**-t** directory - Chroot to directory after processing the command line arguments, but +``-t directory`` + This option tells ``named`` to chroot to ``directory`` after processing the command-line arguments, but before reading the configuration file. .. warning:: This option should be used in conjunction with the ``-u`` option, as chrooting a process running as root doesn't enhance security on - most systems; the way ``chroot(2)`` is defined allows a process + most systems; the way ``chroot`` is defined allows a process with root privileges to escape a chroot jail. -**-U** #listeners - Use #listeners worker threads to listen for incoming UDP packets on - each address. If not specified, ``named`` will calculate a default +``-U #listeners`` + This option tells ``named`` the number of ``#listeners`` worker threads to listen on, for incoming UDP packets on + each address. If not specified, ``named`` calculates a default value based on the number of detected CPUs: 1 for 1 CPU, and the number of detected CPUs minus one for machines with more than 1 CPU. This cannot be increased to a value higher than the number of CPUs. @@ -159,38 +159,38 @@ Options higher. On Windows, the number of UDP listeners is hardwired to 1 and this option has no effect. -**-u** user - Setuid to user after completing privileged operations, such as +``-u user`` + This option sets the setuid to ``user`` after completing privileged operations, such as creating sockets that listen on privileged ports. .. note:: On Linux, ``named`` uses the kernel's capability mechanism to drop - all root privileges except the ability to ``bind(2)`` to a + all root privileges except the ability to ``bind`` to a privileged port and set process resource limits. Unfortunately, this means that the ``-u`` option only works when ``named`` is run on kernel 2.2.18 or later, or kernel 2.3.99-pre3 or later, since previous kernels did not allow privileges to be retained after - ``setuid(2)``. + ``setuid``. -**-v** - Report the version number and exit. +``-v`` + This option reports the version number and exits. -**-V** - Report the version number and build options, and exit. +``-V`` + This option reports the version number and build options, and exits. -**-X** lock-file - Acquire a lock on the specified file at runtime; this helps to +``-X lock-file`` + This option acquires a lock on the specified file at runtime; this helps to prevent duplicate ``named`` instances from running simultaneously. Use of this option overrides the ``lock-file`` option in ``named.conf``. If set to ``none``, the lock file check is disabled. -**-x** cache-file - Load data from cache-file into the cache of the default view. +``-x cache-file`` + This option loads data from ``cache-file`` into the cache of the default view. .. warning:: - This option must not be used. It is only of interest to BIND 9 + This option must not be used in normal operations. It is only of interest to BIND 9 developers and may be removed or changed in a future release. Signals @@ -200,10 +200,10 @@ In routine operation, signals should not be used to control the nameserver; ``rndc`` should be used instead. SIGHUP - Force a reload of the server. + This signal forces a reload of the server. SIGINT, SIGTERM - Shut down the server. + These signals shut down the server. The result of sending any other signals to the server is undefined. diff --git a/bin/nsupdate/nsupdate.rst b/bin/nsupdate/nsupdate.rst index 763c12a493..55d1b26a35 100644 --- a/bin/nsupdate/nsupdate.rst +++ b/bin/nsupdate/nsupdate.rst @@ -34,8 +34,8 @@ Synopsis Description ~~~~~~~~~~~ -``nsupdate`` is used to submit Dynamic DNS Update requests as defined in -:rfc:`2136` to a name server. This allows resource records to be added or +``nsupdate`` is used to submit Dynamic DNS Update requests, as defined in +:rfc:`2136`, to a name server. This allows resource records to be added or removed from a zone without manually editing the zone file. A single update request can contain requests to add or remove more than one resource record. @@ -45,23 +45,23 @@ should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost. The resource records that are dynamically added or removed with -``nsupdate`` have to be in the same zone. Requests are sent to the -zone's primary server. This is identified by the MNAME field of the +``nsupdate`` must be in the same zone. Requests are sent to the +zone's primary server, which is identified by the MNAME field of the zone's SOA record. Transaction signatures can be used to authenticate the Dynamic DNS -updates. These use the TSIG resource record type described in :rfc:`2845` -or the SIG(0) record described in :rfc:`2535` and :rfc:`2931` or GSS-TSIG as +updates. These use the TSIG resource record type described in :rfc:`2845`, +the SIG(0) record described in :rfc:`2535` and :rfc:`2931`, or GSS-TSIG as described in :rfc:`3645`. TSIG relies on a shared secret that should only be known to ``nsupdate`` and the name server. For instance, suitable ``key`` and ``server`` -statements would be added to ``/etc/named.conf`` so that the name server +statements are added to ``/etc/named.conf`` so that the name server can associate the appropriate secret key and algorithm with the IP -address of the client application that will be using TSIG -authentication. You can use ``ddns-confgen`` to generate suitable +address of the client application that is using TSIG +authentication. ``ddns-confgen`` can generate suitable configuration fragments. ``nsupdate`` uses the ``-y`` or ``-k`` options -to provide the TSIG shared secret. These options are mutually exclusive. +to provide the TSIG shared secret; these options are mutually exclusive. SIG(0) uses public key cryptography. To use a SIG(0) key, the public key must be stored in a KEY record in a zone served by the name server. @@ -73,96 +73,96 @@ used by Windows 2000 can be switched on with the ``-o`` flag. Options ~~~~~~~ -**-4** - Use IPv4 only. +``-4`` + This option sets use of IPv4 only. -**-6** - Use IPv6 only. +``-6`` + This option sets use of IPv6 only. -**-d** - Debug mode. This provides tracing information about the update +``-d`` + This option sets debug mode, which provides tracing information about the update requests that are made and the replies received from the name server. -**-D** - Extra debug mode. +``-D`` + This option sets extra debug mode. -**-i** - Force interactive mode, even when standard input is not a terminal. +``-i`` + This option forces interactive mode, even when standard input is not a terminal. -**-k** keyfile - The file containing the TSIG authentication key. Keyfiles may be in +``-k keyfile`` + This option indicates the file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a ``named.conf``-format ``key`` - statement, which may be generated automatically by ``ddns-confgen``, + statement, which may be generated automatically by ``ddns-confgen``; or a pair of files whose names are of the format ``K{name}.+157.+{random}.key`` and ``K{name}.+157.+{random}.private``, which can be generated by - ``dnssec-keygen``. The ``-k`` may also be used to specify a SIG(0) + ``dnssec-keygen``. The ``-k`` option can also be used to specify a SIG(0) key used to authenticate Dynamic DNS update requests. In this case, the key specified is not an HMAC-MD5 key. -**-l** - Local-host only mode. This sets the server address to localhost +``-l`` + This option sets local-host only mode, which sets the server address to localhost (disabling the ``server`` so that the server address cannot be - overridden). Connections to the local server will use a TSIG key + overridden). Connections to the local server use a TSIG key found in ``/var/run/named/session.key``, which is automatically generated by ``named`` if any local ``primary`` zone has set ``update-policy`` to ``local``. The location of this key file can be overridden with the ``-k`` option. -**-L** level - Set the logging debug level. If zero, logging is disabled. +``-L level`` + This option sets the logging debug level. If zero, logging is disabled. -**-p** port - Set the port to use for connections to a name server. The default is +``-p port`` + This option sets the port to use for connections to a name server. The default is 53. -**-P** - Print the list of private BIND-specific resource record types whose +``-P`` + This option prints the list of private BIND-specific resource record types whose format is understood by ``nsupdate``. See also the ``-T`` option. -**-r** udpretries - The number of UDP retries. The default is 3. If zero, only one update - request will be made. +``-r udpretries`` + This option sets the number of UDP retries. The default is 3. If zero, only one update + request is made. -**-t** timeout - The maximum time an update request can take before it is aborted. The - default is 300 seconds. Zero can be used to disable the timeout. +``-t timeout`` + This option sets the maximum time an update request can take before it is aborted. The + default is 300 seconds. If zero, the timeout is disabled. -**-T** - Print the list of IANA standard resource record types whose format is - understood by ``nsupdate``. ``nsupdate`` will exit after the lists +``-T`` + This option prints the list of IANA standard resource record types whose format is + understood by ``nsupdate``. ``nsupdate`` exits after the lists are printed. The ``-T`` option can be combined with the ``-P`` option. - Other types can be entered using "TYPEXXXXX" where "XXXXX" is the + Other types can be entered using ``TYPEXXXXX`` where ``XXXXX`` is the decimal value of the type with no leading zeros. The rdata, if - present, will be parsed using the UNKNOWN rdata format, ( + present, is parsed using the UNKNOWN rdata format, ( ). -**-u** udptimeout - The UDP retry interval. The default is 3 seconds. If zero, the - interval will be computed from the timeout interval and number of UDP +``-u udptimeout`` + This option sets the UDP retry interval. The default is 3 seconds. If zero, the + interval is computed from the timeout interval and number of UDP retries. -**-v** - Use TCP even for small update requests. By default, ``nsupdate`` uses +``-v`` + This option specifies that TCP should be used even for small update requests. By default, ``nsupdate`` uses UDP to send update requests to the name server unless they are too - large to fit in a UDP request in which case TCP will be used. TCP may + large to fit in a UDP request, in which case TCP is used. TCP may be preferable when a batch of update requests is made. -**-V** - Print the version number and exit. +``-V`` + This option prints the version number and exits. -**-y** [hmac:]keyname:secret - Literal TSIG authentication key. ``keyname`` is the name of the key, +``-y [hmac:]keyname:secret`` + This option sets the literal TSIG authentication key. ``keyname`` is the name of the key, and ``secret`` is the base64 encoded shared secret. ``hmac`` is the name of the key algorithm; valid choices are ``hmac-md5``, ``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``, ``hmac-sha384``, or ``hmac-sha512``. If ``hmac`` is not specified, the default is - ``hmac-md5`` or if MD5 was disabled ``hmac-sha256``. + ``hmac-md5``, or if MD5 was disabled, ``hmac-sha256``. NOTE: Use of the ``-y`` option is discouraged because the shared - secret is supplied as a command line argument in clear text. This may + secret is supplied as a command-line argument in clear text. This may be visible in the output from ps1 or in a history file maintained by the user's shell. @@ -171,142 +171,142 @@ Input Format ``nsupdate`` reads input from ``filename`` or standard input. Each command is supplied on exactly one line of input. Some commands are for -administrative purposes. The others are either update instructions or +administrative purposes; others are either update instructions or prerequisite checks on the contents of the zone. These checks set conditions that some name or set of resource records (RRset) either exists or is absent from the zone. These conditions must be met if the -entire update request is to succeed. Updates will be rejected if the +entire update request is to succeed. Updates are rejected if the tests for the prerequisite conditions fail. Every update request consists of zero or more prerequisites and zero or more updates. This allows a suitably authenticated update request to -proceed if some specified resource records are present or missing from +proceed if some specified resource records are either present or missing from the zone. A blank input line (or the ``send`` command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server. -The command formats and their meaning are as follows: +The command formats and their meanings are as follows: -``server`` servername port - Sends all dynamic update requests to the name server ``servername``. - When no server statement is provided, ``nsupdate`` will send updates +``server servername port`` + This command sends all dynamic update requests to the name server ``servername``. + When no server statement is provided, ``nsupdate`` sends updates to the primary server of the correct zone. The MNAME field of that - zone's SOA record will identify the primary server for that zone. + zone's SOA record identify the primary server for that zone. ``port`` is the port number on ``servername`` where the dynamic - update requests get sent. If no port number is specified, the default + update requests are sent. If no port number is specified, the default DNS port number of 53 is used. -``local`` address port - Sends all dynamic update requests using the local ``address``. When - no local statement is provided, ``nsupdate`` will send updates using - an address and port chosen by the system. ``port`` can additionally - be used to make requests come from a specific port. If no port number - is specified, the system will assign one. +``local address port`` + This command sends all dynamic update requests using the local ``address``. When + no local statement is provided, ``nsupdate`` sends updates using + an address and port chosen by the system. ``port`` can also + be used to force requests to come from a specific port. If no port number + is specified, the system assigns one. -``zone`` zonename - Specifies that all updates are to be made to the zone ``zonename``. - If no ``zone`` statement is provided, ``nsupdate`` will attempt +``zone zonename`` + This command specifies that all updates are to be made to the zone ``zonename``. + If no ``zone`` statement is provided, ``nsupdate`` attempts to determine the correct zone to update based on the rest of the input. -``class`` classname - Specify the default class. If no ``class`` is specified, the default +``class classname`` + This command specifies the default class. If no ``class`` is specified, the default class is ``IN``. -``ttl`` seconds - Specify the default time to live for records to be added. The value - ``none`` will clear the default ttl. +``ttl seconds`` + This command specifies the default time-to-live, in seconds, for records to be added. The value + ``none`` clears the default TTL. -``key`` hmac:keyname secret - Specifies that all updates are to be TSIG-signed using the - ``keyname`` ``secret`` pair. If ``hmac`` is specified, then it sets - the signing algorithm in use; the default is ``hmac-md5`` or if MD5 - was disabled ``hmac-sha256``. The ``key`` command overrides any key +``key hmac:keyname secret`` + This command specifies that all updates are to be TSIG-signed using the + ``keyname``-``secret`` pair. If ``hmac`` is specified, it sets + the signing algorithm in use. The default is ``hmac-md5``; if MD5 + was disabled, the default is ``hmac-sha256``. The ``key`` command overrides any key specified on the command line via ``-y`` or ``-k``. ``gsstsig`` - Use GSS-TSIG to sign the updated. This is equivalent to specifying + This command uses GSS-TSIG to sign the updates. This is equivalent to specifying ``-g`` on the command line. ``oldgsstsig`` - Use the Windows 2000 version of GSS-TSIG to sign the updated. This is + This command uses the Windows 2000 version of GSS-TSIG to sign the updates. This is equivalent to specifying ``-o`` on the command line. -``realm`` [realm_name] - When using GSS-TSIG use ``realm_name`` rather than the default realm - in ``krb5.conf``. If no realm is specified the saved realm is +``realm [realm_name]`` + When using GSS-TSIG, this command specifies the use of ``realm_name`` rather than the default realm + in ``krb5.conf``. If no realm is specified, the saved realm is cleared. -``check-names`` [yes_or_no] - Turn on or off check-names processing on records to be added. +``check-names [yes_or_no]`` + This command turns on or off check-names processing on records to be added. Check-names has no effect on prerequisites or records to be deleted. By default check-names processing is on. If check-names processing - fails the record will not be added to the UPDATE message. + fails, the record is not added to the UPDATE message. -``prereq nxdomain`` domain-name - Requires that no resource record of any type exists with name +``prereq nxdomain domain-name`` + This command requires that no resource record of any type exist with the name ``domain-name``. -``prereq yxdomain`` domain-name - Requires that ``domain-name`` exists (has as at least one resource +``prereq yxdomain domain-name`` + This command requires that ``domain-name`` exist (as at least one resource record, of any type). -``prereq nxrrset`` domain-name class type - Requires that no resource record exists of the specified ``type``, - ``class`` and ``domain-name``. If ``class`` is omitted, IN (internet) +``prereq nxrrset domain-name class type`` + This command requires that no resource record exist of the specified ``type``, + ``class``, and ``domain-name``. If ``class`` is omitted, IN (Internet) is assumed. -``prereq yxrrset`` domain-name class type - This requires that a resource record of the specified ``type``, - ``class`` and ``domain-name`` must exist. If ``class`` is omitted, IN +``prereq yxrrset domain-name class type`` + This command requires that a resource record of the specified ``type``, + ``class`` and ``domain-name`` exist. If ``class`` is omitted, IN (internet) is assumed. -``prereq yxrrset`` domain-name class type data - The ``data`` from each set of prerequisites of this form sharing a +``prereq yxrrset domain-name class type data`` + With this command, the ``data`` from each set of prerequisites of this form sharing a common ``type``, ``class``, and ``domain-name`` are combined to form a set of RRs. This set of RRs must exactly match the set of RRs existing in the zone at the given ``type``, ``class``, and ``domain-name``. The ``data`` are written in the standard text representation of the resource record's RDATA. -``update delete`` domain-name ttl class type data - Deletes any resource records named ``domain-name``. If ``type`` and - ``data`` is provided, only matching resource records will be removed. - The internet class is assumed if ``class`` is not supplied. The +``update delete domain-name ttl class type data`` + This command deletes any resource records named ``domain-name``. If ``type`` and + ``data`` are provided, only matching resource records are removed. + The Internet class is assumed if ``class`` is not supplied. The ``ttl`` is ignored, and is only allowed for compatibility. -``update add`` domain-name ttl class type data - Adds a new resource record with the specified ``ttl``, ``class`` and +``update add domain-name ttl class type data`` + This command adds a new resource record with the specified ``ttl``, ``class``, and ``data``. ``show`` - Displays the current message, containing all of the prerequisites and + This command displays the current message, containing all of the prerequisites and updates specified since the last send. ``send`` - Sends the current message. This is equivalent to entering a blank + This command sends the current message. This is equivalent to entering a blank line. ``answer`` - Displays the answer. + This command displays the answer. ``debug`` - Turn on debugging. + This command turns on debugging. ``version`` - Print version number. + This command prints the version number. ``help`` - Print a list of commands. + This command prints a list of commands. -Lines beginning with a semicolon are comments and are ignored. +Lines beginning with a semicolon (;) are comments and are ignored. Examples ~~~~~~~~ -The examples below show how ``nsupdate`` could be used to insert and +The examples below show how ``nsupdate`` can be used to insert and delete resource records from the ``example.com`` zone. Notice that the -input in each example contains a trailing blank line so that a group of -commands are sent as one dynamic update request to the primary name +input in each example contains a trailing blank line, so that a group of +commands is sent as one dynamic update request to the primary name server for ``example.com``. :: @@ -316,9 +316,9 @@ server for ``example.com``. > update add newhost.example.com 86400 A 172.16.1.1 > send -Any A records for ``oldhost.example.com`` are deleted. And an A record +Any A records for ``oldhost.example.com`` are deleted, and an A record for ``newhost.example.com`` with IP address 172.16.1.1 is added. The -newly-added record has a 1 day TTL (86400 seconds). +newly added record has a TTL of 1 day (86400 seconds). :: @@ -327,29 +327,29 @@ newly-added record has a 1 day TTL (86400 seconds). > update add nickname.example.com 86400 CNAME somehost.example.com > send -The prerequisite condition gets the name server to check that there are +The prerequisite condition tells the name server to verify that there are no resource records of any type for ``nickname.example.com``. If there are, the update request fails. If this name does not exist, a CNAME for it is added. This ensures that when the CNAME is added, it cannot conflict with the long-standing rule in :rfc:`1034` that a name must not exist as any other record type if it exists as a CNAME. (The rule has been updated for DNSSEC in :rfc:`2535` to allow CNAMEs to have RRSIG, -DNSKEY and NSEC records.) +DNSKEY, and NSEC records.) Files ~~~~~ ``/etc/resolv.conf`` - used to identify default name server + Used to identify the default name server ``/var/run/named/session.key`` - sets the default TSIG key for use in local-only mode + Sets the default TSIG key for use in local-only mode ``K{name}.+157.+{random}.key`` - base-64 encoding of HMAC-MD5 key created by dnssec-keygen8. + Base-64 encoding of the HMAC-MD5 key created by ``dnssec-keygen``. ``K{name}.+157.+{random}.private`` - base-64 encoding of HMAC-MD5 key created by dnssec-keygen8. + Base-64 encoding of the HMAC-MD5 key created by ``dnssec-keygen``. See Also ~~~~~~~~ @@ -361,5 +361,5 @@ Bugs ~~~~ The TSIG key is redundantly stored in two separate files. This is a -consequence of nsupdate using the DST library for its cryptographic +consequence of ``nsupdate`` using the DST library for its cryptographic operations, and may change in future releases. diff --git a/bin/pkcs11/pkcs11-destroy.rst b/bin/pkcs11/pkcs11-destroy.rst index 5654c986d6..c543c1fddf 100644 --- a/bin/pkcs11/pkcs11-destroy.rst +++ b/bin/pkcs11/pkcs11-destroy.rst @@ -37,32 +37,32 @@ Description by their ``ID`` or ``label``. Matching keys are displayed before being destroyed. By default, there is -a five second delay to allow the user to interrupt the process before +a five-second delay to allow the user to interrupt the process before the destruction takes place. -Arguments -~~~~~~~~~ +Options +~~~~~~~ -**-m** module - Specify the PKCS#11 provider module. This must be the full path to a +``-m module`` + This option specifies the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -**-s** slot - Open the session with the given PKCS#11 slot. The default is slot 0. +``-s slot`` + This option opens the session with the given PKCS#11 slot. The default is slot 0. -**-i** ID - Destroy keys with the given object ID. +``-i ID`` + This option destroys keys with the given object ID. -**-l** label - Destroy keys with the given label. +``-l label`` + This option destroys keys with the given label. -**-p** PIN - Specify the PIN for the device. If no PIN is provided on the command - line, ``pkcs11-destroy`` will prompt for it. +``-p PIN`` + This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command + line, ``pkcs11-destroy`` prompts for it. -**-w** seconds - Specify how long to pause before carrying out key destruction. The - default is five seconds. If set to ``0``, destruction will be +``-w seconds`` + This option specifies how long, in seconds, to pause before carrying out key destruction. The + default is 5 seconds. If set to ``0``, destruction is immediate. See Also diff --git a/bin/pkcs11/pkcs11-keygen.rst b/bin/pkcs11/pkcs11-keygen.rst index 3e5e8c29ba..92a875037c 100644 --- a/bin/pkcs11/pkcs11-keygen.rst +++ b/bin/pkcs11/pkcs11-keygen.rst @@ -38,51 +38,51 @@ Description with the given ``label`` (which must be unique) and with ``keysize`` bits of prime. -Arguments -~~~~~~~~~ +Options +~~~~~~~ -**-a** algorithm - Specify the key algorithm class: Supported classes are RSA, DSA, DH, - ECC and ECX. In addition to these strings, the ``algorithm`` can be - specified as a DNSSEC signing algorithm that will be used with this +``-a algorithm`` + This option specifies the key algorithm class: supported classes are RSA, DSA, DH, + ECC, and ECX. In addition to these strings, the ``algorithm`` can be + specified as a DNSSEC signing algorithm to be used with this key; for example, NSEC3RSASHA1 maps to RSA, ECDSAP256SHA256 maps to - ECC, and ED25519 to ECX. The default class is "RSA". + ECC, and ED25519 to ECX. The default class is ``RSA``. -**-b** keysize - Create the key pair with ``keysize`` bits of prime. For ECC keys, the +``-b keysize`` + This option creates the key pair with ``keysize`` bits of prime. For ECC keys, the only valid values are 256 and 384, and the default is 256. For ECX keys, the only valid values are 256 and 456, and the default is 256. -**-e** - For RSA keys only, use a large exponent. +``-e`` + For RSA keys only, this option specifies use of a large exponent. -**-i** id - Create key objects with id. The id is either an unsigned short 2 byte - or an unsigned long 4 byte number. +``-i id`` + This option creates key objects with ``id``. The ID is either an unsigned short 2-byte + or an unsigned long 4-byte number. -**-m** module - Specify the PKCS#11 provider module. This must be the full path to a +``-m module`` + This option specifies the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -**-P** - Set the new private key to be non-sensitive and extractable. The +``-P`` + This option sets the new private key to be non-sensitive and extractable, and allows the private key data to be read from the PKCS#11 device. The default is for private keys to be sensitive and non-extractable. -**-p** PIN - Specify the PIN for the device. If no PIN is provided on the command - line, ``pkcs11-keygen`` will prompt for it. +``-p PIN`` + This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command + line, ``pkcs11-keygen`` prompts for it. -**-q** - Quiet mode: suppress unnecessary output. +``-q`` + This option sets quiet mode, which suppresses unnecessary output. -**-S** - For Diffie-Hellman (DH) keys only, use a special prime of 768, 1024 - or 1536 bit size and base (aka generator) 2. If not specified, bit - size will default to 1024. +``-S`` + For Diffie-Hellman (DH) keys only, this option specifies use of a special prime of 768-, 1024-, + or 1536-bit size and base (AKA generator) 2. If not specified, bit + size defaults to 1024. -**-s** slot - Open the session with the given PKCS#11 slot. The default is slot 0. +``-s slot`` + This option opens the session with the given PKCS#11 slot. The default is slot 0. See Also ~~~~~~~~ diff --git a/bin/pkcs11/pkcs11-list.rst b/bin/pkcs11/pkcs11-list.rst index 1a8d6ad715..55b2bda8c2 100644 --- a/bin/pkcs11/pkcs11-list.rst +++ b/bin/pkcs11/pkcs11-list.rst @@ -31,34 +31,34 @@ pkcs11-list - list PKCS#11 objects Description ~~~~~~~~~~~ -``pkcs11-list`` lists the PKCS#11 objects with ``ID`` or ``label`` or by -default all objects. The object class, label, and ID are displayed for +``pkcs11-list`` lists the PKCS#11 objects with ``ID`` or ``label`` or, by +default, all objects. The object class, label, and ID are displayed for all keys. For private or secret keys, the extractability attribute is also displayed, as either ``true``, ``false``, or ``never``. -Arguments -~~~~~~~~~ +Options +~~~~~~~ -**-P** - List only the public objects. (Note that on some PKCS#11 devices, all +``-P`` + This option lists only the public objects. (Note that on some PKCS#11 devices, all objects are private.) -**-m** module - Specify the PKCS#11 provider module. This must be the full path to a +``-m module`` + This option specifies the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -**-s** slot - Open the session with the given PKCS#11 slot. The default is slot 0. +``-s slot`` + This option opens the session with the given PKCS#11 slot. The default is slot 0. -**-i** ID - List only key objects with the given object ID. +``-i ID`` + This option lists only key objects with the given object ID. -**-l** label - List only key objects with the given label. +``-l label`` + This option lists only key objects with the given label. -**-p** PIN - Specify the PIN for the device. If no PIN is provided on the command - line, ``pkcs11-list`` will prompt for it. +``-p PIN`` + This option specifies the ``PIN`` for the device. If no ``PIN`` is provided on the command + line, ``pkcs11-list`` prompts for it. See Also ~~~~~~~~ diff --git a/bin/pkcs11/pkcs11-tokens.rst b/bin/pkcs11/pkcs11-tokens.rst index 057f14954a..0b9430c734 100644 --- a/bin/pkcs11/pkcs11-tokens.rst +++ b/bin/pkcs11/pkcs11-tokens.rst @@ -37,15 +37,15 @@ Description ``pkcs11-tokens`` lists the PKCS#11 available tokens with defaults from the slot/token scan performed at application initialization. -Arguments -~~~~~~~~~ +Options +~~~~~~~ -**-m** module - Specify the PKCS#11 provider module. This must be the full path to a +``-m module`` + This option specifies the PKCS#11 provider module. This must be the full path to a shared library object implementing the PKCS#11 API for the device. -**-v** - Make the PKCS#11 libisc initialization verbose. +``-v`` + This option makes the PKCS#11 libisc initialization verbose. See Also ~~~~~~~~ diff --git a/bin/plugins/filter-aaaa.rst b/bin/plugins/filter-aaaa.rst index 498870a50b..68390de54f 100644 --- a/bin/plugins/filter-aaaa.rst +++ b/bin/plugins/filter-aaaa.rst @@ -40,7 +40,7 @@ Description Until BIND 9.12, this feature was implemented natively in ``named`` and enabled with the ``filter-aaaa`` ACL and the ``filter-aaaa-on-v4`` and ``filter-aaaa-on-v6`` options. These options are now deprecated in -``named.conf``, but can be passed as parameters to the +``named.conf`` but can be passed as parameters to the ``filter-aaaa.so`` plugin, for example: :: @@ -60,22 +60,22 @@ necessary. Note: This mechanism can erroneously cause other servers not to give AAAA records to their clients. If a recursing server with both IPv6 and IPv4 network connections queries an authoritative server using this -mechanism via IPv4, it will be denied AAAA records even if its client is +mechanism via IPv4, it is denied AAAA records even if its client is using IPv6. Options ~~~~~~~ ``filter-aaaa`` - Specifies a list of client addresses for which AAAA filtering is to + This option specifies a list of client addresses for which AAAA filtering is to be applied. The default is ``any``. ``filter-aaaa-on-v4`` - If set to ``yes``, the DNS client is at an IPv4 address, in - ``filter-aaaa``, and if the response does not include DNSSEC + If set to ``yes``, this option indicates that the DNS client is at an IPv4 address, in + ``filter-aaaa``. If the response does not include DNSSEC signatures, then all AAAA records are deleted from the response. This - filtering applies to all responses and not only authoritative - responses. + filtering applies to all responses, not only authoritative + ones. If set to ``break-dnssec``, then AAAA records are deleted even when DNSSEC is enabled. As suggested by the name, this causes the response @@ -83,13 +83,13 @@ Options deletions. This mechanism can erroneously cause other servers not to give AAAA - records to their clients. A recursing server with both IPv6 and IPv4 - network connections that queries an authoritative server using this - mechanism via IPv4 will be denied AAAA records even if its client is + records to their clients. If a recursing server with both IPv6 and IPv4 + network connections queries an authoritative server using this + mechanism via IPv4, it is denied AAAA records even if its client is using IPv6. ``filter-aaaa-on-v6`` - Identical to ``filter-aaaa-on-v4``, except it filters AAAA responses + This option is identical to ``filter-aaaa-on-v4``, except that it filters AAAA responses to queries from IPv6 clients instead of IPv4 clients. To filter all responses, set both options to ``yes``. diff --git a/bin/rndc/rndc.rst b/bin/rndc/rndc.rst index 7c61e9158a..163786571d 100644 --- a/bin/rndc/rndc.rst +++ b/bin/rndc/rndc.rst @@ -57,22 +57,22 @@ Options ~~~~~~~ ``-4`` - This indicates use of IPv4 only. + This option indicates use of IPv4 only. ``-6`` - This indicates use of IPv6 only. + This option indicates use of IPv6 only. ``-b source-address`` - This indicates ``source-address`` as the source address for the connection to the + This option indicates ``source-address`` as the source address for the connection to the server. Multiple instances are permitted, to allow setting of both the IPv4 and IPv6 source addresses. ``-c config-file`` - This indicates ``config-file`` as the configuration file instead of the default, + This option indicates ``config-file`` as the configuration file instead of the default, ``/etc/rndc.conf``. ``-k key-file`` - This indicates ``key-file`` as the key file instead of the default, + This option indicates ``key-file`` as the key file instead of the default, ``/etc/rndc.key``. The key in ``/etc/rndc.key`` is used to authenticate commands sent to the server if the config-file does not exist. @@ -85,23 +85,23 @@ Options is used. ``-p port`` - This instructs BIND 9 to send commands to TCP port ``port`` instead of its default control + This option instructs BIND 9 to send commands to TCP port ``port`` instead of its default control channel port, 953. ``-q`` - This sets quiet mode, where message text returned by the server is not printed + This option sets quiet mode, where message text returned by the server is not printed unless there is an error. ``-r`` - This instructs ``rndc`` to print the result code returned by ``named`` + This option instructs ``rndc`` to print the result code returned by ``named`` after executing the requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc.). ``-V`` - This enables verbose logging. + This option enables verbose logging. ``-y key_id`` - This indicates use of the key ``key_id`` from the configuration file. For control message validation to succeed, ``key_id`` must be known + This option indicates use of the key ``key_id`` from the configuration file. For control message validation to succeed, ``key_id`` must be known by ``named`` with the same algorithm and secret string. If no ``key_id`` is specified, ``rndc`` first looks for a key clause in the server statement of the server being used, or if no server statement is present for that @@ -119,7 +119,7 @@ without arguments. Currently supported commands are: ``addzone`` *zone* [*class* [*view*]] *configuration* - This adds a zone while the server is running. This command requires the + This command adds a zone while the server is running. This command requires the ``allow-new-zones`` option to be set to ``yes``. The configuration string specified on the command line is the zone configuration text that would ordinarily be placed in ``named.conf``. @@ -144,7 +144,7 @@ Currently supported commands are: See also ``rndc delzone`` and ``rndc modzone``. ``delzone`` [**-clean**] *zone* [*class* [*view*]] - This deletes a zone while the server is running. + This command deletes a zone while the server is running. If the ``-clean`` argument is specified, the zone's master file (and journal file, if any) are deleted along with the zone. Without @@ -166,7 +166,7 @@ Currently supported commands are: zone to have a "dnssec-policy". ``dnstap`` ( **-reopen** | **-roll** [*number*] ) - This closes and re-opens DNSTAP output files. ``rndc dnstap -reopen`` allows + This command closes and re-opens DNSTAP output files. ``rndc dnstap -reopen`` allows the output file to be renamed externally, so that ``named`` can truncate and re-open it. ``rndc dnstap -roll`` causes the output file to be rolled automatically, similar to log files. The most recent @@ -175,25 +175,25 @@ Currently supported commands are: the number of backup log files is limited to that number. ``dumpdb`` [**-all** | **-cache** | **-zones** | **-adb** | **-bad** | **-fail**] [*view ...*] - This dumps the server's caches (default) and/or zones to the dump file for + This command dumps the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. (See the ``dump-file`` option in the BIND 9 Administrator Reference Manual.) ``flush`` - This flushes the server's cache. + This command flushes the server's cache. ``flushname`` *name* [*view*] - This flushes the given name from the view's DNS cache and, if applicable, + This command flushes the given name from the view's DNS cache and, if applicable, from the view's nameserver address database, bad server cache, and SERVFAIL cache. ``flushtree`` *name* [*view*] - This flushes the given name, and all of its subdomains, from the view's + This command flushes the given name, and all of its subdomains, from the view's DNS cache, address database, bad server cache, and SERVFAIL cache. ``freeze`` [*zone* [*class* [*view*]]] - This suspends updates to a dynamic zone. If no zone is specified, then all + This command suspends updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by dynamic update, and causes changes in the journal file to be synced into the master file. All dynamic update @@ -202,7 +202,7 @@ Currently supported commands are: See also ``rndc thaw``. ``halt`` [**-p**] - This stops the server immediately. Recent changes made through dynamic + This command stops the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but are rolled forward from the journal files when the server is restarted. If ``-p`` is specified, ``named``'s process ID is returned. This allows @@ -212,7 +212,7 @@ Currently supported commands are: See also ``rndc stop``. ``loadkeys`` [*zone* [*class* [*view*]]] - This fetches all DNSSEC keys for the given zone from the key directory. If + This command fetches all DNSSEC keys for the given zone from the key directory. If they are within their publication period, they are merged into the zone's DNSKEY RRset. Unlike ``rndc sign``, however, the zone is not immediately re-signed by the new keys, but is allowed to @@ -224,7 +224,7 @@ Currently supported commands are: the Administrator Reference Manual for more details.) ``managed-keys`` (*status* | *refresh* | *sync* | *destroy*) [*class* [*view*]] - This inspects and controls the "managed-keys" database which handles + This command inspects and controls the "managed-keys" database which handles :rfc:`5011` DNSSEC trust anchor maintenance. If a view is specified, these commands are applied to that view; otherwise, they are applied to all views. @@ -262,7 +262,7 @@ Currently supported commands are: repair for key maintenance problems. ``modzone`` *zone* [*class* [*view*]] *configuration* - This modifies the configuration of a zone while the server is running. This + This command modifies the configuration of a zone while the server is running. This command requires the ``allow-new-zones`` option to be set to ``yes``. As with ``addzone``, the configuration string specified on the command line is the zone configuration text that would ordinarily be @@ -280,15 +280,15 @@ Currently supported commands are: See also ``rndc addzone`` and ``rndc delzone``. ``notify`` *zone* [*class* [*view*]] - This resends NOTIFY messages for the zone. + This command resends NOTIFY messages for the zone. ``notrace`` - This sets the server's debugging level to 0. + This command sets the server's debugging level to 0. See also ``rndc trace``. ``nta`` [( **-class** *class* | **-dump** | **-force** | **-remove** | **-lifetime** *duration*)] *domain* [*view*] - This sets a DNSSEC negative trust anchor (NTA) for ``domain``, with a + This command sets a DNSSEC negative trust anchor (NTA) for ``domain``, with a lifetime of ``duration``. The default lifetime is configured in ``named.conf`` via the ``nta-lifetime`` option, and defaults to one hour. The lifetime cannot exceed one week. @@ -339,7 +339,7 @@ Currently supported commands are: command line to indicate the end of options. ``querylog`` [(*on* | *off*)] - This enables or disables query logging. For backward compatibility, this + This command enables or disables query logging. For backward compatibility, this command can also be used without an argument to toggle query logging on and off. @@ -349,29 +349,29 @@ Currently supported commands are: ``options`` section of ``named.conf``. ``reconfig`` - This reloads the configuration file and loads new zones, but does not reload + This command reloads the configuration file and loads new zones, but does not reload existing zone files even if they have changed. This is faster than a full ``reload`` when there is a large number of zones, because it avoids the need to examine the modification times of the zone files. ``recursing`` - This dumps the list of queries ``named`` is currently recursing on, and the + This command dumps the list of queries ``named`` is currently recursing on, and the list of domains to which iterative queries are currently being sent. The second list includes the number of fetches currently active for the given domain, and how many have been passed or dropped because of the ``fetches-per-zone`` option. ``refresh`` *zone* [*class* [*view*]] - This schedules zone maintenance for the given zone. + This command schedules zone maintenance for the given zone. ``reload`` - This reloads the configuration file and zones. + This command reloads the configuration file and zones. ``reload`` *zone* [*class* [*view*]] - This reloads the given zone. + This command reloads the given zone. ``retransfer`` *zone* [*class* [*view*]] - This retransfers the given secondary zone from the primary server. + This command retransfers the given secondary zone from the primary server. If the zone is configured to use ``inline-signing``, the signed version of the zone is discarded; after the retransfer of the @@ -379,12 +379,12 @@ Currently supported commands are: with new signatures. ``scan`` - This scans the list of available network interfaces for changes, without + This command scans the list of available network interfaces for changes, without performing a full ``reconfig`` or waiting for the ``interface-interval`` timer. ``secroots`` [**-**] [*view* ...] - This dumps the security roots (i.e., trust anchors configured via + This command dumps the security roots (i.e., trust anchors configured via ``trust-anchors``, or the ``managed-keys`` or ``trusted-keys`` statements [both deprecated], or ``dnssec-validation auto``) and negative trust anchors for the specified views. If no view is specified, all views are @@ -401,7 +401,7 @@ Currently supported commands are: See also ``rndc managed-keys``. ``serve-stale`` (**on** | **off** | **reset** | **status**) [*class* [*view*]] - This enables, disables, resets, or reports the current status of the serving + This command enables, disables, resets, or reports the current status of the serving of stale answers as configured in ``named.conf``. If serving of stale answers is disabled by ``rndc-serve-stale off``, @@ -415,12 +415,12 @@ Currently supported commands are: ``stale-answer-ttl`` and ``max-stale-ttl``. ``showzone`` *zone* [*class* [*view*]] - This prints the configuration of a running zone. + This command prints the configuration of a running zone. See also ``rndc zonestatus``. ``sign`` *zone* [*class* [*view*]] - This fetches all DNSSEC keys for the given zone from the key directory (see + This command fetches all DNSSEC keys for the given zone from the key directory (see the ``key-directory`` option in the BIND 9 Administrator Reference Manual). If they are within their publication period, they are merged into the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the @@ -435,7 +435,7 @@ Currently supported commands are: See also ``rndc loadkeys``. ``signing`` [(**-list** | **-clear** *keyid/algorithm* | **-clear** *all* | **-nsec3param** ( *parameters* | none ) | **-serial** *value* ) *zone* [*class* [*view*]] - This lists, edits, or removes the DNSSEC signing-state records for the + This command lists, edits, or removes the DNSSEC signing-state records for the specified zone. The status of ongoing DNSSEC operations, such as signing or generating NSEC3 chains, is stored in the zone in the form of DNS resource records of type ``sig-signing-type``. @@ -480,17 +480,17 @@ Currently supported commands are: signed zones. ``stats`` - This writes server statistics to the statistics file. (See the + This command writes server statistics to the statistics file. (See the ``statistics-file`` option in the BIND 9 Administrator Reference Manual.) ``status`` - This displays the status of the server. Note that the number of zones includes + This command displays the status of the server. Note that the number of zones includes the internal ``bind/CH`` zone and the default ``./IN`` hint zone, if there is no explicit root zone configured. ``stop`` **-p** - This stops the server, making sure any recent changes made through dynamic + This command stops the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. If ``-p`` is specified, ``named(8)`'s process ID is returned. This allows an external process to determine when ``named`` has @@ -499,12 +499,12 @@ Currently supported commands are: See also ``rndc halt``. ``sync`` **-clean** [*zone* [*class* [*view*]]] - This syncs changes in the journal file for a dynamic zone to the master + This command syncs changes in the journal file for a dynamic zone to the master file. If the "-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced. ``tcp-timeouts`` [*initial* *idle* *keepalive* *advertised*] - When called without arguments, this displays the current values of the + When called without arguments, this command displays the current values of the ``tcp-initial-timeout``, ``tcp-idle-timeout``, ``tcp-keepalive-timeout``, and ``tcp-advertised-timeout`` options. When called with arguments, these values are updated. This allows an @@ -513,7 +513,7 @@ Currently supported commands are: Administrator Reference Manual for details of their use. ``thaw`` [*zone* [*class* [*view*]]] - This enables updates to a frozen dynamic zone. If no zone is specified, + This command enables updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone from disk, and re-enables dynamic updates after the load has completed. After a zone is thawed, dynamic updates are no longer @@ -525,31 +525,31 @@ Currently supported commands are: See also ``rndc freeze``. ``trace`` - This increments the server's debugging level by one. + This command increments the server's debugging level by one. ``trace`` *level* - This sets the server's debugging level to an explicit value. + This command sets the server's debugging level to an explicit value. See also ``rndc notrace``. ``tsig-delete`` *keyname* [*view*] - This deletes a given TKEY-negotiated key from the server. This does not + This command deletes a given TKEY-negotiated key from the server. This does not apply to statically configured TSIG keys. ``tsig-list`` - This lists the names of all TSIG keys currently configured for use by + This command lists the names of all TSIG keys currently configured for use by ``named`` in each view. The list includes both statically configured keys and dynamic TKEY-negotiated keys. ``validation`` (**on** | **off** | **status**) [*view* ...]`` - This enables, disables, or checks the current status of DNSSEC validation. By + This command enables, disables, or checks the current status of DNSSEC validation. By default, validation is enabled. The cache is flushed when validation is turned on or off to avoid using data that might differ between states. ``zonestatus`` *zone* [*class* [*view*]] - This displays the current status of the given zone, including the master + This command displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC diff --git a/bin/tools/dnstap-read.rst b/bin/tools/dnstap-read.rst index ef689f51ee..150e198529 100644 --- a/bin/tools/dnstap-read.rst +++ b/bin/tools/dnstap-read.rst @@ -43,7 +43,7 @@ Options ~~~~~~~ ``-m`` - This indicates trace memory allocations, and is used for debugging memory leaks. + This option indicates trace memory allocations, and is used for debugging memory leaks. ``-p`` This option prints the text form of the DNS @@ -54,7 +54,7 @@ Options of the DNS message that was encapsulated in the ``dnstap`` frame, after printing the ``dnstap`` data. ``-y`` - This prints ``dnstap`` data in a detailed YAML format. + This option prints ``dnstap`` data in a detailed YAML format. See Also ~~~~~~~~