From b4e46de257f557c9ab0b78919c0900a9bb8e63ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Wed, 2 Mar 2022 15:12:17 +0100 Subject: [PATCH] Denote all command line options using semantic markup (.. option::) The markup allows referencing individual options, and also makes them more legible (no more thin red text on gray background). Most of the work was done using regexes: s/^``-\(.*\)``$/.. option:: -\1\r/ s/^``+\(.*\)``$/.. option:: +\1\r/ on bin/**/*.rst files along with visual inspection and hand-edits, mostly for positional arguments. Regex for rndc.rst: s/^``\(.*\)``/.. option:: \1\r/ + hand edits to remove extra asterisk and whitespace here and there. (cherry picked from commit ec30944aa4884b0c9e2c088485aadd4cfe743ed4) --- bin/check/named-checkconf.rst | 33 ++- bin/check/named-checkzone.rst | 81 ++++--- bin/check/named-compilezone.rst | 81 ++++--- bin/confgen/ddns-confgen.rst | 18 +- bin/confgen/rndc-confgen.rst | 33 ++- bin/confgen/tsig-keygen.rst | 6 +- bin/delv/delv.rst | 108 ++++++--- bin/dig/dig.rst | 285 ++++++++++++++-------- bin/dig/host.rst | 60 +++-- bin/dnssec/dnssec-cds.rst | 33 ++- bin/dnssec/dnssec-dsfromkey.rst | 39 ++- bin/dnssec/dnssec-importkey.rst | 30 ++- bin/dnssec/dnssec-keyfromlabel.rst | 78 ++++-- bin/dnssec/dnssec-keygen.rst | 96 +++++--- bin/dnssec/dnssec-revoke.rst | 24 +- bin/dnssec/dnssec-settime.rst | 78 ++++-- bin/dnssec/dnssec-signzone.rst | 120 ++++++--- bin/dnssec/dnssec-verify.rst | 27 ++- bin/named/named.rst | 65 +++-- bin/nsupdate/nsupdate.rst | 54 +++-- bin/rndc/rndc.rst | 158 ++++++++---- bin/tools/dnstap-read.rst | 12 +- bin/tools/mdig.rst | 156 ++++++++---- bin/tools/named-nzd2nzf.rst | 3 +- bin/tools/named-rrchecker.rst | 15 +- bin/tools/nsec3hash.rst | 15 +- doc/man/ddns-confgen.8in | 22 +- doc/man/delv.1in | 138 ++++++++--- doc/man/dig.1in | 374 +++++++++++++++++++++-------- doc/man/dnssec-cds.1in | 44 +++- doc/man/dnssec-dsfromkey.1in | 50 +++- doc/man/dnssec-importkey.1in | 36 ++- doc/man/dnssec-keyfromlabel.1in | 102 ++++++-- doc/man/dnssec-keygen.1in | 124 +++++++--- doc/man/dnssec-revoke.1in | 30 ++- doc/man/dnssec-settime.1in | 96 ++++++-- doc/man/dnssec-signzone.1in | 158 +++++++++--- doc/man/dnssec-verify.1in | 36 ++- doc/man/dnstap-read.1in | 14 +- doc/man/host.1in | 78 ++++-- doc/man/mdig.1in | 200 +++++++++++---- doc/man/named-checkconf.1in | 42 +++- doc/man/named-checkzone.1in | 106 +++++--- doc/man/named-compilezone.1in | 106 +++++--- doc/man/named-nzd2nzf.1in | 2 +- doc/man/named-rrchecker.1in | 18 +- doc/man/named.8in | 74 ++++-- doc/man/nsec3hash.1in | 18 +- doc/man/nsupdate.1in | 70 ++++-- doc/man/rndc-confgen.8in | 42 +++- doc/man/rndc.8in | 206 ++++++++++++---- doc/man/tsig-keygen.8in | 6 +- 52 files changed, 2761 insertions(+), 1139 deletions(-) diff --git a/bin/check/named-checkconf.rst b/bin/check/named-checkconf.rst index 882f818c7b..4bc2deada7 100644 --- a/bin/check/named-checkconf.rst +++ b/bin/check/named-checkconf.rst @@ -38,37 +38,46 @@ However, ``named-checkconf`` can be run on these files explicitly. Options ~~~~~~~ -``-h`` +.. option:: -h + This option prints the usage summary and exits. -``-j`` +.. option:: -j + When loading a zonefile, this option instructs ``named`` to read the journal if it exists. -``-l`` +.. option:: -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`` +.. option:: -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`` +.. option:: -i + This option ignores warnings on deprecated options. -``-p`` +.. option:: -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`` +.. option:: -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`` +.. option:: -v + This option prints the version of the ``named-checkconf`` program and exits. -``-x`` +.. option:: -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 @@ -76,10 +85,12 @@ Options without compromising private data. This option cannot be used without ``-p``. -``-z`` +.. option:: -z + This option performs a test load of all zones of type ``primary`` found in ``named.conf``. -``filename`` +.. option:: filename + This indicates the name of the configuration file to be checked. If not specified, it defaults to |named_conf|. diff --git a/bin/check/named-checkzone.rst b/bin/check/named-checkzone.rst index b8e7c3a88d..19b1d6a4cc 100644 --- a/bin/check/named-checkzone.rst +++ b/bin/check/named-checkzone.rst @@ -34,32 +34,40 @@ configuring them into a name server. Options ~~~~~~~ -``-d`` +.. option:: -d + This option enables debugging. -``-h`` +.. option:: -h + This option prints the usage summary and exits. -``-q`` +.. option:: -q + This option sets quiet mode, which only sets an exit code to indicate successful or failed completion. -``-v`` +.. option:: -v + This option prints the version of the ``named-checkzone`` program and exits. -``-j`` +.. option:: -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`` +.. option:: -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`` +.. option:: -c class + This option specifies the class of the zone. If not specified, ``IN`` is assumed. -``-i mode`` +.. option:: -i mode + This option performs post-load zone integrity checks. Possible modes are ``full`` (the default), ``full-sibling``, ``local``, ``local-sibling``, and ``none``. @@ -85,11 +93,13 @@ Options Mode ``none`` disables the checks. -``-f format`` +.. option:: -f format + This option specifies the format of the zone file. Possible formats are ``text`` (the default), and ``raw``. -``-F format`` +.. option:: -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. @@ -101,43 +111,52 @@ Options 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`` +.. option:: -k mode + This option performs ``check-names`` checks with the specified failure mode. Possible modes are ``fail``, ``warn`` (the default), and ``ignore``. -``-l ttl`` +.. option:: -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`` +.. option:: -L serial + When compiling a zone to ``raw`` 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`` +.. option:: -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`` +.. option:: -M mode + This option checks whether a MX record refers to a CNAME. Possible modes are ``fail``, ``warn`` (the default), and ``ignore``. -``-n mode`` +.. option:: -n mode + This option specifies whether NS records should be checked to see if they are addresses. Possible modes are ``fail``, ``warn`` (the default), and ``ignore``. -``-o filename`` +.. option:: -o filename + This option writes the zone output to ``filename``. If ``filename`` is ``-``, then the zone output is written to standard output. -``-r mode`` +.. option:: -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`` +.. option:: -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. @@ -146,38 +165,46 @@ Options the zone contents. It also does not have any meaning if the output format is not text. -``-S mode`` +.. option:: -S mode + This option checks whether an SRV record refers to a CNAME. Possible modes are ``fail``, ``warn`` (the default), and ``ignore``. -``-t directory`` +.. option:: -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`` +.. option:: -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`` (the default) and ``ignore``. -``-w directory`` +.. option:: -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`` +.. option:: -D + This option dumps the zone file in canonical format. -``-W mode`` +.. option:: -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:`4592`). Possible modes are ``warn`` (the default) and ``ignore``. -``zonename`` +.. option:: zonename + This indicates the domain name of the zone being checked. -``filename`` +.. option:: filename + This is the name of the zone file. Return Values diff --git a/bin/check/named-compilezone.rst b/bin/check/named-compilezone.rst index 1a2777c36c..b638cd92fd 100644 --- a/bin/check/named-compilezone.rst +++ b/bin/check/named-compilezone.rst @@ -36,32 +36,40 @@ strict as those specified in the ``named`` configuration file. Options ~~~~~~~ -``-d`` +.. option:: -d + This option enables debugging. -``-h`` +.. option:: -h + This option prints the usage summary and exits. -``-q`` +.. option:: -q + This option sets quiet mode, which only sets an exit code to indicate successful or failed completion. -``-v`` +.. option:: -v + This option prints the version of the ``named-checkzone`` program and exits. -``-j`` +.. option:: -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`` +.. option:: -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`` +.. option:: -c class + This option specifies the class of the zone. If not specified, ``IN`` is assumed. -``-i mode`` +.. option:: -i mode + This option performs post-load zone integrity checks. Possible modes are ``full`` (the default), ``full-sibling``, ``local``, ``local-sibling``, and ``none``. @@ -87,11 +95,13 @@ Options Mode ``none`` disables the checks. -``-f format`` +.. option:: -f format + This option specifies the format of the zone file. Possible formats are ``text`` (the default), and ``raw``. -``-F format`` +.. option:: -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. @@ -103,83 +113,100 @@ Options 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`` +.. option:: -k mode + This option performs ``check-names`` checks with the specified failure mode. Possible modes are ``fail`` (the default), ``warn``, and ``ignore``. -``-l ttl`` +.. option:: -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`` +.. option:: -L serial + When compiling a zone to ``raw`` 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`` +.. option:: -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`` +.. option:: -M mode + This option checks whether a MX record refers to a CNAME. Possible modes are ``fail``, ``warn`` (the default), and ``ignore``. -``-n mode`` +.. option:: -n mode + This option specifies whether NS records should be checked to see if they are addresses. Possible modes are ``fail`` (the default), ``warn``, and ``ignore``. -``-o filename`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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. -``-S mode`` +.. option:: -S mode + This option checks whether an SRV record refers to a CNAME. Possible modes are ``fail``, ``warn`` (the default), and ``ignore``. -``-t directory`` +.. option:: -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`` +.. option:: -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`` (the default) and ``ignore``. -``-w directory`` +.. option:: -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`` +.. option:: -D + This option dumps the zone file in canonical format. This is always enabled for ``named-compilezone``. -``-W mode`` +.. option:: -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:`4592`). Possible modes are ``warn`` (the default) and ``ignore``. -``zonename`` +.. option:: zonename + This indicates the domain name of the zone being checked. -``filename`` +.. option:: 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 52ae412c58..467dc82594 100644 --- a/bin/confgen/ddns-confgen.rst +++ b/bin/confgen/ddns-confgen.rst @@ -45,16 +45,19 @@ be used from a remote system. Options ~~~~~~~ -``-a algorithm`` +.. option:: -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`` +.. option:: -h + This option prints a short summary of options and arguments. -``-k keyname`` +.. option:: -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 @@ -62,12 +65,14 @@ Options The key name must have the format of a valid domain name, consisting of letters, digits, hyphens, and periods. -``-q`` +.. option:: -q + 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`` +.. option:: -s name + 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 @@ -75,7 +80,8 @@ Options 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`` +.. option:: -z zone + 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" diff --git a/bin/confgen/rndc-confgen.rst b/bin/confgen/rndc-confgen.rst index e24cbe2ac6..e689000185 100644 --- a/bin/confgen/rndc-confgen.rst +++ b/bin/confgen/rndc-confgen.rst @@ -34,7 +34,8 @@ by hand. Alternatively, it can be run with the ``-a`` option to set up a Options ~~~~~~~ -``-a`` +.. option:: -a + This option sets automatic ``rndc`` configuration, which creates a file |rndc_key| that is read by both ``rndc`` and ``named`` on startup. The ``rndc.key`` file defines a default command channel and @@ -46,46 +47,56 @@ Options remotely, run ``rndc-confgen`` without the ``-a`` option and set up ``rndc.conf`` and ``named.conf`` as directed. -``-A algorithm`` +.. option:: -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`` +.. option:: -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`` +.. option:: -c keyfile + This option is used with the ``-a`` option to specify an alternate location for ``rndc.key``. -``-h`` +.. option:: -h + This option prints a short summary of the options and arguments to ``rndc-confgen``. -``-k keyname`` +.. option:: -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`` +.. option:: -p port + This option specifies the command channel port where ``named`` listens for connections from ``rndc``. The default is 953. -``-q`` +.. option:: -q + This option prevets printing the written path in automatic configuration mode. -``-s address`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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. diff --git a/bin/confgen/tsig-keygen.rst b/bin/confgen/tsig-keygen.rst index a1274079de..3ff279ac0b 100644 --- a/bin/confgen/tsig-keygen.rst +++ b/bin/confgen/tsig-keygen.rst @@ -35,13 +35,15 @@ of the generated key. If no name is specified, the default is ``tsig-key``. Options ~~~~~~~ -``-a algorithm`` +.. option:: -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`` +.. option:: -h + This option prints a short summary of options and arguments. See Also diff --git a/bin/delv/delv.rst b/bin/delv/delv.rst index 3c1cfa38fe..6b2469b0f0 100644 --- a/bin/delv/delv.rst +++ b/bin/delv/delv.rst @@ -68,7 +68,8 @@ A typical invocation of ``delv`` looks like: where: -``server`` +.. option:: server + is the name or IP address of the name server to query. This can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied ``server`` argument is a @@ -84,10 +85,12 @@ where: sends queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6). -``name`` +.. option:: name + is the domain name to be looked up. -``type`` +.. option:: type + 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`` performs a lookup for an A record. @@ -95,7 +98,8 @@ where: Options ~~~~~~~ -``-a anchor-file`` +.. option:: -a anchor-file + This option specifies a file from which to read DNSSEC trust anchors. The default is |bind_keys|, which is included with BIND 9 and contains one or more trust anchors for the root zone ("."). @@ -111,27 +115,32 @@ Options revoked and rolled over, |bind_keys| must be updated to use DNSSEC validation in ``delv``. -``-b address`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -h + This option displays the ``delv`` help usage output and exits. -``-i`` +.. option:: -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 @@ -139,23 +148,27 @@ Options is necessary to examine invalid data to debug a DNSSEC problem, use ``dig +cd``.) -``-m`` +.. option:: -m + This option enables memory usage debugging. -``-p port#`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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 types or classes @@ -165,10 +178,12 @@ Options The default query type is "A", unless the ``-x`` option is supplied to indicate a reverse lookup, in which case it is "PTR". -``-v`` +.. option:: -v + This option prints the ``delv`` version and exits. -``-x addr`` +.. option:: -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 @@ -177,10 +192,12 @@ Options query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -``-4`` +.. option:: -4 + This option forces ``delv`` to only use IPv4. -``-6`` +.. option:: -6 + This option forces ``delv`` to only use IPv6. Query Options @@ -195,7 +212,8 @@ the string ``no`` to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form ``+keyword=value``. The query options are: -``+[no]cdflag`` +.. option:: +[no]cdflag + 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 @@ -204,15 +222,18 @@ assign values to options like the timeout interval. They have the form to return invalid responses, which ``delv`` can then validate internally and report the errors in detail. -``+[no]class`` +.. option:: +[no]class + This option controls whether to display the CLASS when printing a record. The default is to display the CLASS. -``+[no]ttl`` +.. option:: +[no]ttl + This option controls whether to display the TTL when printing a record. The default is to display the TTL. -``+[no]rtrace`` +.. option:: +[no]rtrace + 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, including the original query @@ -224,7 +245,8 @@ assign values to options like the timeout interval. They have the form ``-d`` option produces the same output, but affects other logging categories as well. -``+[no]mtrace`` +.. option:: +[no]mtrace + 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. @@ -234,7 +256,8 @@ assign values to options like the timeout interval. They have the form debug level to 10 using the ``-d`` option produces the same output, but affects other logging categories as well. -``+[no]vtrace`` +.. option:: +[no]vtrace + 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. @@ -244,20 +267,24 @@ assign values to options like the timeout interval. They have the form systemwide debug level to 3 using the ``-d`` option produces the same output, but affects other logging categories as well. -``+[no]short`` +.. option:: +[no]short + This option toggles between verbose and terse answers. The default is to print the answer in a verbose form. -``+[no]comments`` +.. option:: +[no]comments + This option toggles the display of comment lines in the output. The default is to print comments. -``+[no]rrcomments`` +.. option:: +[no]rrcomments + 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`` +.. option:: +[no]crypto + 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 @@ -265,28 +292,33 @@ assign values to options like the timeout interval. They have the form 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`` +.. option:: +[no]trust + This option controls whether to display the trust level when printing a record. The default is to display the trust level. -``+[no]split[=W]`` +.. option:: +[no]split[=W] + 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`` +.. option:: +[no]all + This option sets or clears the display options ``+[no]comments``, ``+[no]rrcomments``, and ``+[no]trust`` as a group. -``+[no]multiline`` +.. option:: +[no]multiline + 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`` +.. option:: +[no]dnssec + 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 to @@ -294,23 +326,27 @@ assign values to options like the timeout interval. They have the form always occurs unless suppressed by the use of ``-i`` or ``+noroot``. -``+[no]root[=ROOT]`` +.. option:: +[no]root[=ROOT] + 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`` +.. option:: +[no]tcp + 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`` +.. option:: +[no]unknownformat + 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`` +.. option:: +[no]yaml + This option prints response data in YAML format. Files diff --git a/bin/dig/dig.rst b/bin/dig/dig.rst index 6889ce6bb4..9fd5eec7ae 100644 --- a/bin/dig/dig.rst +++ b/bin/dig/dig.rst @@ -69,7 +69,8 @@ A typical invocation of ``dig`` looks like: where: -``server`` +.. option:: server + is the name or IP address of the name server to query. This can be an IPv4 address in dotted-decimal notation or an IPv6 address in colon-delimited notation. When the supplied ``server`` argument is a @@ -84,10 +85,12 @@ where: sends the query to the local host. The reply from the name server that responds is displayed. -``name`` +.. option:: name + is the name of the resource record that is to be looked up. -``type`` +.. option:: type + 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`` performs a lookup for an A record. @@ -95,28 +98,34 @@ where: Options ~~~~~~~ -``-4`` +.. option:: -4 + This option indicates that only IPv4 should be used. -``-6`` +.. option:: -6 + This option indicates that only IPv6 should be used. -``-b address[#port]`` +.. option:: -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 ``#port``. -``-c class`` +.. option:: -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`` +.. option:: -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 it would be presented as a query to ``dig`` using the command-line interface. -``-k keyfile`` +.. option:: -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 @@ -124,24 +133,29 @@ Options by providing appropriate ``key`` and ``server`` statements in ``named.conf``. -``-m`` +.. option:: -m + This option enables memory usage debugging. -``-p port`` +.. option:: -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`` +.. option:: -q name + This option specifies the domain name to query. This is useful to distinguish the ``name`` from other arguments. -``-r`` +.. option:: -r + This option indicates that options from ``${HOME}/.digrc`` should not be read. This is useful for scripts that need predictable behavior. -``-t type`` +.. option:: -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 @@ -156,13 +170,16 @@ Options the number of the type. If the resource record type is not supported in BIND 9, the result is displayed as described in :rfc:`3597`. -``-u`` +.. option:: -u + This option indicates that print query times should be provided in microseconds instead of milliseconds. -``-v`` +.. option:: -v + This option prints the version number and exits. -``-x addr`` +.. option:: -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`` option is used, there is no @@ -172,7 +189,8 @@ Options and IN respectively. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. -``-y [hmac:]keyname:secret`` +.. option:: -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; @@ -203,17 +221,21 @@ assign values to options, like the timeout interval. They have the form abbreviation is unambiguous; for example, ``+cd`` is equivalent to ``+cdflag``. The query options are: -``+[no]aaflag`` +.. option:: +[no]aaflag + This option is a synonym for ``+[no]aaonly``. -``+[no]aaonly`` +.. option:: +[no]aaonly + This option sets the ``aa`` flag in the query. -``+[no]additional`` +.. option:: +[no]additional + This option displays [or does not display] the additional section of a reply. The default is to display it. -``+[no]adflag`` +.. option:: +[no]adflag + 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 been validated as secure, according to the security @@ -222,44 +244,54 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to indicates that some part of the answer was insecure or not validated. This bit is set by default. -``+[no]all`` +.. option:: +[no]all + This option sets or clears all display flags. -``+[no]answer`` +.. option:: +[no]answer + This option displays [or does not display] the answer section of a reply. The default is to display it. -``+[no]authority`` +.. option:: +[no]authority + This option displays [or does not display] the authority section of a reply. The default is to display it. -``+[no]badcookie`` +.. option:: +[no]badcookie + This option retries the lookup with a new server cookie if a BADCOOKIE response is received. -``+[no]besteffort`` +.. option:: +[no]besteffort + This option attempts to display the contents of messages which are malformed. The default is to not display malformed answers. -``+bufsize[=B]`` +.. option:: +bufsize[=B] + 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. ``+bufsize`` restores the default buffer size. -``+[no]cdflag`` +.. option:: +[no]cdflag + 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`` +.. option:: +[no]class + This option displays [or does not display] the CLASS when printing the record. -``+[no]cmd`` +.. option:: +[no]cmd + 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`` +.. option:: +[no]comments + 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. @@ -268,7 +300,8 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to can be controlled using other command-line switches. These include ``+[no]cmd``, ``+[no]question``, ``+[no]stats``, and ``+[no]rrcomments``. -``+[no]cookie=####`` +.. option:: +[no]cookie=#### + 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``. @@ -276,7 +309,8 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to ``+cookie`` is also set when ``+trace`` is set to better emulate the default queries from a nameserver. -``+[no]crypto`` +.. option:: +[no]crypto + 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 @@ -284,62 +318,75 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to 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`` +.. option:: +[no]defname + This option, which is deprecated, is treated as a synonym for ``+[no]search``. -``+[no]dns64prefix`` +.. option:: +[no]dns64prefix + Lookup IPV4ONLY.ARPA AAAA and print any DNS64 prefixes found. -``+[no]dnssec`` +.. option:: +[no]dnssec + 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`` +.. option:: +domain=somename + This option sets the search list to contain the single domain ``somename``, as if specified in a ``domain`` directive in ``/etc/resolv.conf``, and enables search list processing as if the ``+search`` option were given. -``+dscp=value`` +.. option:: +dscp=value + 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[=#]`` +.. option:: +[no]edns[=#] + 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[=#]`` +.. option:: +[no]ednsflags[=#] + 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`` +.. option:: +[no]ednsnegotiation + This option enables/disables EDNS version negotiation. By default, EDNS version negotiation is enabled. -``+[no]ednsopt[=code[:value]]`` +.. option:: +[no]ednsopt[=code[:value]] + 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 numeric value. ``+noednsopt`` clears the EDNS options to be sent. -``+[no]expire`` +.. option:: +[no]expire + This option sends an EDNS Expire option. -``+[no]fail`` +.. option:: +[no]fail + 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`` +.. option:: +[no]header-only + 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]https[=value]`` +.. option:: +[no]https[=value] + This option indicates whether to use DNS over HTTPS (DoH) when querying name servers. When this option is in use, the port number defaults to 443. The HTTP POST request mode is used when sending the query. @@ -348,31 +395,38 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to query URI; the default is ``/dns-query``. So, for example, ``dig @example.com +https`` will use the URI ``https://example.com/dns-query``. -``+[no]https-get[=value]`` +.. option:: +[no]https-get[=value] + Similar to ``+https``, except that the HTTP GET request mode is used when sending the query. -``+[no]https-post[=value]`` +.. option:: +[no]https-post[=value] + Same as ``+https``. -``+[no]http-plain[=value]`` +.. option:: +[no]http-plain[=value] + Similar to ``+https``, except that HTTP queries will be sent over a non-encrypted channel. When this option is in use, the port number defaults to 80 and the HTTP request mode is POST. -``+[no]http-plain-get[=value]`` +.. option:: +[no]http-plain-get[=value] + Similar to ``+http-plain``, except that the HTTP request mode is GET. -``+[no]http-plain-post[=value]`` +.. option:: +[no]http-plain-post[=value] + Same as ``+http-plain``. -``+[no]identify`` +.. option:: +[no]identify + 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`` +.. option:: +[no]idnin + This option processes [or does not process] IDN domain names on input. This requires ``IDN SUPPORT`` to have been enabled at compile time. @@ -380,7 +434,8 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to The IDN processing on input is disabled when ``dig`` output is redirected to files, pipes, and other non-tty file descriptors. -``+[no]idnout`` +.. option:: +[no]idnout + This option converts [or does not convert] puny code on output. This requires ``IDN SUPPORT`` to have been enabled at compile time. @@ -388,24 +443,29 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to 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`` +.. option:: +[no]ignore + This option ignores [or does not ignore] truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. -``+[no]keepalive`` +.. option:: +[no]keepalive + This option sends [or does not send] an EDNS Keepalive option. -``+[no]keepopen`` +.. option:: +[no]keepopen + 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]multiline`` +.. option:: +[no]multiline + 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. -``+ndots=D`` +.. option:: +ndots=D + 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`` @@ -414,24 +474,29 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to ``search`` or ``domain`` directive in ``/etc/resolv.conf`` if ``+search`` is set. -``+[no]nsid`` +.. option:: +[no]nsid + When enabled, this option includes an EDNS name server ID request when sending a query. -``+[no]nssearch`` +.. option:: +[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 display the SOA record that each name server has for the zone. Addresses of servers that did not respond are also printed. -``+[no]onesoa`` +.. option:: +[no]onesoa + 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`` +.. option:: +[no]opcode=value + When enabled, this option sets (restores) the DNS message opcode to the specified value. The default value is QUERY (0). -``+padding=value`` +.. option:: +padding=value + 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, @@ -440,42 +505,51 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to mandatory. Responses to padded queries may also be padded, but only if the query uses TCP or DNS COOKIE. -``+qid=value`` +.. option:: +qid=value + This option specifies the query ID to use when sending queries. -``+[no]qr`` +.. option:: +[no]qr + This option toggles the display of the query message as it is sent. By default, the query is not printed. -``+[no]question`` +.. option:: +[no]question + 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`` +.. option:: +[no]raflag + 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`` +.. option:: +[no]rdflag + This option is a synonym for ``+[no]recurse``. -``+[no]recurse`` +.. option:: +[no]recurse + 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 option is used. -``+retry=T`` +.. option:: +retry=T + This option sets the number of times to retry UDP and TCP queries to server to ``T`` instead of the default, 2. Unlike ``+tries``, this does not include the initial query. -``+[no]rrcomments`` +.. option:: +[no]rrcomments + 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`` +.. option:: +[no]search + 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. @@ -484,36 +558,43 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to ``+ndots``, determines whether the name is treated as relative and hence whether a search is eventually performed. -``+[no]short`` +.. option:: +[no]short + 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]showbadcookie`` +.. option:: +[no]showbadcookie + This option toggles whether to show the message containing the BADCOOKIE rcode before retrying the request or not. The default is to not show the messages. -``+[no]showsearch`` +.. option:: +[no]showsearch + This option performs [or does not perform] a search showing intermediate results. -``+[no]sigchase`` +.. option:: +[no]sigchase + This feature is now obsolete and has been removed; use ``delv`` instead. -``+split=W`` +.. option:: +split=W + 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`` +.. option:: +[no]stats + 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]`` +.. option:: +[no]subnet=addr[/prefix-length] + This option sends [or does not send] an EDNS CLIENT-SUBNET option with the specified IP address or network prefix. @@ -522,30 +603,36 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to prefix-length of zero, which signals a resolver that the client's address information must *not* be used when resolving this query. -``+[no]tcflag`` +.. option:: +[no]tcflag + 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`` +.. option:: +[no]tcp + This option indicates whether to 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`` +.. option:: +timeout=T + 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]tls`` +.. option:: +[no]tls + This option indicates whether to use DNS over TLS (DoT) when querying name servers. When this option is in use, the port number defaults to 853. -``+[no]topdown`` +.. option:: +[no]topdown + This feature is related to ``dig +sigchase``, which is obsolete and has been removed. Use ``delv`` instead. -``+[no]trace`` +.. option:: +[no]trace + 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 @@ -559,38 +646,46 @@ abbreviation is unambiguous; for example, ``+cd`` is equivalent to ``+dnssec`` is also set when ``+trace`` is set, to better emulate the default queries from a name server. -``+tries=T`` +.. option:: +tries=T + This option sets the number of times to try UDP and TCP 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=####`` +.. option:: +trusted-key=#### + 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`` +.. option:: +[no]ttlid + This option displays [or does not display] the TTL when printing the record. -``+[no]ttlunits`` +.. option:: +[no]ttlunits + 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]unknownformat`` +.. option:: +[no]unknownformat + 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`` +.. option:: +[no]vc + 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." -``+[no]yaml`` +.. option:: +[no]yaml + When enabled, this option prints the responses (and, if ``+qr`` is in use, also the outgoing queries) in a detailed YAML format. -``+[no]zflag`` +.. option:: +[no]zflag + This option sets [or does not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. diff --git a/bin/dig/host.rst b/bin/dig/host.rst index 8e855c36fc..27058eba75 100644 --- a/bin/dig/host.rst +++ b/bin/dig/host.rst @@ -39,40 +39,49 @@ server or servers listed in ``/etc/resolv.conf``. Options ~~~~~~~ -``-4`` +.. option:: -4 + This option specifies that only IPv4 should be used for query transport. See also the ``-6`` option. -``-6`` +.. option:: -6 + This option specifies that only IPv6 should be used for query transport. See also the ``-4`` option. -``-a`` +.. 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`` +.. option:: -A + The ``-A`` ("almost all") option is equivalent to ``-a``, except that RRSIG, NSEC, and NSEC3 records are omitted from the output. -``-c class`` +.. option:: -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`` +.. option:: -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`` +.. option:: -d + This option prints debugging traces, and is equivalent to the ``-v`` verbose option. -``-l`` +.. option:: -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`` +.. option:: -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 @@ -80,10 +89,12 @@ Options and are searched for in the domains listed in the ``search`` or ``domain`` directive in ``/etc/resolv.conf``. -``-p port`` +.. option:: -p port + This option specifies the port to query on the server. The default is 53. -``-r`` +.. option:: -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`` @@ -91,17 +102,20 @@ Options making non-recursive queries, and expecting to receive answers to those queries that can be referrals to other name servers. -``-R number`` +.. option:: -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`` +.. option:: -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`` +.. option:: -t type + This option specifies the query type. The ``type`` argument can be any recognized query type: CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc. @@ -115,31 +129,37 @@ Options specified by appending an equals sign (=), followed by the starting serial number, e.g., ``-t IXFR=12345678``. -``-T``; ``-U`` +.. option:: -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 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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -V + This option prints the version number and exits. -``-w`` +.. option:: -w + This option sets "wait forever": the query timeout is set to the maximum possible. See also the ``-W`` option. -``-W wait`` +.. option:: -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. diff --git a/bin/dnssec/dnssec-cds.rst b/bin/dnssec/dnssec-cds.rst index 3eac0b520f..df471daa46 100644 --- a/bin/dnssec/dnssec-cds.rst +++ b/bin/dnssec/dnssec-cds.rst @@ -72,7 +72,8 @@ maintain a ``dsset-`` file as well as emit an ``nsupdate`` script. Options ~~~~~~~ -``-a algorithm`` +.. option:: -a algorithm + When converting CDS records to DS records, this option specifies the acceptable digest algorithms. This option can be repeated, so that multiple digest types are allowed. If none of the CDS records @@ -87,15 +88,18 @@ Options are case-insensitive, and the hyphen may be omitted. If no algorithm is specified, the default is SHA-256 only. -``-c class`` +.. option:: -c class + This option specifies the DNS class of the zones. -``-D`` +.. option:: -D + This option generates DS records from CDNSKEY records if both CDS and CDNSKEY records are present in the child zone. By default CDS records are preferred. -``-d path`` +.. option:: -d path + This specifies the location of the parent DS records. The path can be the name of a file containing the DS records; if it is a directory, ``dnssec-cds`` looks for a ``dsset-`` file for the domain inside the directory. @@ -104,14 +108,16 @@ Options were signed earlier than the modification time of the ``dsset-`` file. This can be adjusted with the ``-s`` option. -``-f child-file`` +.. option:: -f child-file + This option specifies the file containing the child's CDS and/or CDNSKEY records, plus its DNSKEY records and the covering RRSIG records, so that they can be authenticated. The examples below describe how to generate this file. -``-iextension`` +.. option:: -iextension + This option updates the ``dsset-`` file in place, instead of writing DS records to the standard output. @@ -125,7 +131,8 @@ Options child records, provided that it is later than the file's current modification time. -``-s start-time`` +.. option:: -s start-time + This option specifies the date and time after which RRSIG records become acceptable. This can be either an absolute or a relative time. An absolute start time is indicated by a number in YYYYMMDDHHMMSS @@ -137,12 +144,14 @@ Options If no start-time is specified, the modification time of the ``dsset-`` file is used. -``-T ttl`` +.. option:: -T ttl + This option specifies a TTL to be used for new DS records. If not specified, the default is the TTL of the old DS records. If they had no explicit TTL, the new DS records also have no explicit TTL. -``-u`` +.. option:: -u + This option writes an ``nsupdate`` script to the standard output, instead of printing the new DS reords. The output is empty if no change is needed. @@ -151,10 +160,12 @@ Options original ``dsset-`` file, with the ``-T`` option, or using the ``nsupdate`` ``ttl`` command. -``-V`` +.. option:: -V + This option prints version information. -``-v level`` +.. option:: -v level + This option sets the debugging level. Level 1 is intended to be usefully verbose for general users; higher levels are intended for developers. diff --git a/bin/dnssec/dnssec-dsfromkey.rst b/bin/dnssec/dnssec-dsfromkey.rst index 6396733424..a9b010ebeb 100644 --- a/bin/dnssec/dnssec-dsfromkey.rst +++ b/bin/dnssec/dnssec-dsfromkey.rst @@ -51,13 +51,16 @@ as generated by ``dnssec-keygen`` ``-C``. Options ~~~~~~~ -``-1`` +.. option:: -1 + This option is an abbreviation for ``-a SHA1``. -``-2`` +.. option:: -2 + This option is an abbreviation for ``-a SHA-256``. -``-a algorithm`` +.. option:: -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. @@ -66,19 +69,23 @@ Options are case-insensitive, and the hyphen may be omitted. If no algorithm is specified, the default is SHA-256. -``-A`` +.. option:: -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`` +.. option:: -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`` +.. option:: -C + This option generates CDS records rather than DS records. -``-f file`` +.. option:: -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 @@ -90,23 +97,29 @@ Options ``dig dnskey example.com | dnssec-dsfromkey -f - example.com`` -``-h`` +.. option:: -h + This option prints usage information. -``-K directory`` +.. option:: -K directory + This option tells BIND 9 to look for key files or ``keyset-`` files in ``directory``. -``-s`` +.. option:: -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`` +.. option:: -T TTL + This option specifies the TTL of the DS records. By default the TTL is omitted. -``-v level`` +.. option:: -v level + This option sets the debugging level. -``-V`` +.. option:: -V + This option prints version information. Example diff --git a/bin/dnssec/dnssec-importkey.rst b/bin/dnssec/dnssec-importkey.rst index 9e58fcee78..969791e139 100644 --- a/bin/dnssec/dnssec-importkey.rst +++ b/bin/dnssec/dnssec-importkey.rst @@ -41,7 +41,8 @@ DNSKEY RRset on schedule even if the true private key is stored offline. Options ~~~~~~~ -``-f filename`` +.. option:: -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 ``filename``. If the domain name is the same as ``filename``, then it may be @@ -50,23 +51,28 @@ Options If ``filename`` is set to ``"-"``, then the zone data is read from the standard input. -``-K directory`` +.. option:: -K directory + This option sets the directory in which the key files are to reside. -``-L ttl`` +.. option:: -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`` +.. option:: -h + This option emits a usage message and exits. -``-v level`` +.. option:: -v level + This option sets the debugging level. -``-V`` +.. option:: -V + This option prints version information. Timing Options @@ -81,21 +87,25 @@ 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``. -``-P date/offset`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -D sync date/offset + This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. diff --git a/bin/dnssec/dnssec-keyfromlabel.rst b/bin/dnssec/dnssec-keyfromlabel.rst index 35920acef4..3f635e74d1 100644 --- a/bin/dnssec/dnssec-keyfromlabel.rst +++ b/bin/dnssec/dnssec-keyfromlabel.rst @@ -37,7 +37,8 @@ match the name of the zone for which the key is being generated. Options ~~~~~~~ -``-a algorithm`` +.. option:: -a algorithm + This option selects the cryptographic algorithm. The value of ``algorithm`` must be one of RSASHA1, NSEC3RSASHA1, RSASHA256, RSASHA512, ECDSAP256SHA256, ECDSAP384SHA384, ED25519, or ED448. @@ -57,20 +58,23 @@ Options ``-S`` option, which copies the algorithm from the predecessory key. Previously, the default for newly generated keys was RSASHA1. -``-3`` +.. option:: -3 + This option uses an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version is used; for example, ``dnssec-keygen -3a RSASHA1`` specifies the NSEC3RSASHA1 algorithm. -``-E engine`` +.. option:: -E engine + This option specifies the cryptographic hardware to use. When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually ``pkcs11``). -``-l label`` +.. option:: -l label + This option specifies the label for a key pair in the crypto hardware. When BIND 9 is built with OpenSSL-based PKCS#11 support, the label is @@ -78,14 +82,16 @@ Options preceded by an optional OpenSSL engine name, followed by a colon, as in ``pkcs11:keylabel``. -``-n nametype`` +.. option:: -n nametype + This option specifies the owner type of the key. The value of ``nametype`` must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user (KEY)), or OTHER (DNSKEY). These values are case-insensitive. -``-C`` +.. option:: -C + This option enables compatibility mode, which generates an old-style key, without any metadata. By default, ``dnssec-keyfromlabel`` includes the key's creation date in the metadata stored with the private key; other dates may @@ -93,26 +99,32 @@ Options that include this data may be incompatible with older versions of BIND; the ``-C`` option suppresses them. -``-c class`` +.. option:: -c class + This option indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -``-f flag`` +.. option:: -f flag + This option sets the specified flag in the ``flag`` field of the KEY/DNSKEY record. The only recognized flags are KSK (Key-Signing Key) and REVOKE. -``-G`` +.. option:: -G + This option generates a key, but does not publish it or sign with it. This option is incompatible with ``-P`` and ``-A``. -``-h`` +.. option:: -h + This option prints a short summary of the options and arguments to ``dnssec-keyfromlabel``. -``-K directory`` +.. option:: -K directory + This option sets the directory in which the key files are to be written. -``-k`` +.. option:: -k + This option generates KEY records rather than DNSKEY records. ``-L`` ttl @@ -122,12 +134,14 @@ Options place, in which case the existing TTL would take precedence. Setting the default TTL to ``0`` or ``none`` removes it. -``-p protocol`` +.. option:: -p protocol + This option sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in :rfc:`2535` and its successors. -``-S key`` +.. option:: -S key + This option generates a key as an explicit successor to an existing key. The name, algorithm, size, and type of the key are set to match the predecessor. The activation date of the new key is set to the @@ -135,19 +149,23 @@ Options set to the activation date minus the prepublication interval, which defaults to 30 days. -``-t type`` +.. option:: -t type + This option indicates the type of the key. ``type`` must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF to the ability to encrypt data. -``-v level`` +.. option:: -v level + This option sets the debugging level. -``-V`` +.. option:: -V + This option prints version information. -``-y`` +.. option:: -y + This option allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to enable if @@ -166,41 +184,49 @@ 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``. -``-P date/offset`` +.. option:: -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. If not set, and if the ``-G`` option has not been used, the default is the current date. -``-P sync date/offset`` +.. option:: -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`` +.. option:: -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. If not set, and if the ``-G`` option has not been used, the default is the current date. -``-R date/offset`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -D sync date/offset + This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -``-i interval`` +.. option:: -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 diff --git a/bin/dnssec/dnssec-keygen.rst b/bin/dnssec/dnssec-keygen.rst index db37d7e778..65f0beb09a 100644 --- a/bin/dnssec/dnssec-keygen.rst +++ b/bin/dnssec/dnssec-keygen.rst @@ -36,13 +36,15 @@ generated. Options ~~~~~~~ -``-3`` +.. option:: -3 + This option uses an NSEC3-capable algorithm to generate a DNSSEC key. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version is selected; for example, ``dnssec-keygen -3a RSASHA1`` specifies the NSEC3RSASHA1 algorithm. -``-a algorithm`` +.. option:: -a algorithm + This option selects the cryptographic algorithm. For DNSSEC keys, the value of ``algorithm`` must be one of RSASHA1, NSEC3RSASHA1, RSASHA256, RSASHA512, ECDSAP256SHA256, ECDSAP384SHA384, ED25519, or ED448. For @@ -61,7 +63,8 @@ Options keys, but that feature was removed in BIND 9.13.0. Use ``tsig-keygen`` to generate TSIG keys. -``-b keysize`` +.. option:: -b keysize + This option specifies the number of bits in the key. The choice of key size depends on the algorithm used: RSA keys must be between 1024 and 4096 bits; Diffie-Hellman keys must be between 128 and 4096 bits. Elliptic @@ -72,7 +75,8 @@ Options have a default size of 1024 bits; RSA keys for use as key-signing keys (KSKs, generated with ``-f KSK``) default to 2048 bits. -``-C`` +.. option:: -C + This option enables compatibility mode, which generates an old-style key, without any timing metadata. By default, ``dnssec-keygen`` includes the key's creation date in the metadata stored with the private key; other @@ -80,44 +84,53 @@ Options etc. Keys that include this data may be incompatible with older versions of BIND; the ``-C`` option suppresses them. -``-c class`` +.. option:: -c class + This option indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. -``-d bits`` +.. option:: -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, ECDSAP384SHA384, ED25519, and ED448. -``-E engine`` +.. option:: -E engine + This option specifies the cryptographic hardware to use, when applicable. When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually ``pkcs11``). -``-f flag`` +.. option:: -f flag + This option sets the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key-Signing Key) and REVOKE. -``-G`` +.. option:: -G + This option generates a key, but does not publish it or sign with it. This option is incompatible with ``-P`` and ``-A``. -``-g generator`` +.. option:: -g generator + This option indicates the generator to use if generating a Diffie-Hellman key. Allowed values are 2 and 5. If no generator is specified, a known prime from :rfc:`2539` is used if possible; otherwise the default is 2. -``-h`` +.. option:: -h + This option prints a short summary of the options and arguments to ``dnssec-keygen``. -``-K directory`` +.. option:: -K directory + This option sets the directory in which the key files are to be written. -``-k policy`` +.. option:: -k policy + This option creates keys for a specific ``dnssec-policy``. If a policy uses multiple keys, ``dnssec-keygen`` generates multiple keys. This also creates a ".state" file to keep track of the key state. @@ -126,7 +139,8 @@ Options it cannot be used at the same time as many of the other options that ``dnssec-keygen`` provides. -``-L ttl`` +.. option:: -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 @@ -135,24 +149,28 @@ Options defaults to the SOA TTL. Setting the default TTL to ``0`` or ``none`` is the same as leaving it unset. -``-l file`` +.. option:: -l file + This option provides a configuration file that contains a ``dnssec-policy`` statement (matching the policy set with ``-k``). -``-n nametype`` +.. option:: -n nametype + This option specifies the owner type of the key. The value of ``nametype`` must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user (KEY)), or OTHER (DNSKEY). These values are case-insensitive. The default is ZONE for DNSKEY generation. -``-p protocol`` +.. option:: -p protocol + This option sets the protocol value for the generated key, for use with ``-T KEY``. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in :rfc:`2535` and its successors. -``-q`` +.. option:: -q + This option sets quiet mode, which suppresses unnecessary output, including progress indication. Without this option, when ``dnssec-keygen`` is run interactively to generate an RSA or DSA key pair, it prints a @@ -162,7 +180,8 @@ Options round of the Miller-Rabin primality test; and a space ( ) means that the number has passed all the tests and is a satisfactory key. -``-S key`` +.. option:: -S key + This option creates a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key are set to match the existing key. The activation date of the new key is set to @@ -170,26 +189,31 @@ Options set to the activation date minus the prepublication interval, which defaults to 30 days. -``-s strength`` +.. option:: -s strength + This option specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC. -``-T rrtype`` +.. option:: -T rrtype + This option specifies the resource record type to use for the key. ``rrtype`` must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0). -``-t type`` +.. option:: -t type + This option indicates the type of the key for use with ``-T KEY``. ``type`` must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF to the ability to encrypt data. -``-V`` +.. option:: -V + This option prints version information. -``-v level`` +.. option:: -v level + This option sets the debugging level. Timing Options @@ -204,43 +228,51 @@ 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``. -``-P date/offset`` +.. option:: -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. If not set, and if the ``-G`` option has not been used, the default is the current date. -``-P sync date/offset`` +.. option:: -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`` +.. option:: -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. If not set, and if the ``-G`` option has not been used, the default is the current date. If set, and ``-P`` is not set, the publication date is set to the activation date minus the prepublication interval. -``-R date/offset`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -D sync date/offset + This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. -``-i interval`` +.. option:: -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 diff --git a/bin/dnssec/dnssec-revoke.rst b/bin/dnssec/dnssec-revoke.rst index d7027a96d5..0d748f5b0a 100644 --- a/bin/dnssec/dnssec-revoke.rst +++ b/bin/dnssec/dnssec-revoke.rst @@ -31,34 +31,42 @@ containing the now-revoked key. Options ~~~~~~~ -``-h`` +.. option:: -h + This option emits a usage message and exits. -``-K directory`` +.. option:: -K directory + This option sets the directory in which the key files are to reside. -``-r`` +.. option:: -r + This option indicates to remove the original keyset files after writing the new keyset files. -``-v level`` +.. option:: -v level + This option sets the debugging level. -``-V`` +.. option:: -V + This option prints version information. -``-E engine`` +.. option:: -E engine + This option specifies the cryptographic hardware to use, when applicable. When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually ``pkcs11``). -``-f`` +.. option:: -f + This option indicates a forced overwrite and causes ``dnssec-revoke`` to write the new key pair, even if a file already exists matching the algorithm and key ID of the revoked key. -``-R`` +.. option:: -R + This option prints the key tag of the key with the REVOKE bit set, but does not revoke the key. diff --git a/bin/dnssec/dnssec-settime.rst b/bin/dnssec/dnssec-settime.rst index 46975035ea..e21e57acae 100644 --- a/bin/dnssec/dnssec-settime.rst +++ b/bin/dnssec/dnssec-settime.rst @@ -59,7 +59,8 @@ purposes. Options ~~~~~~~ -``-f`` +.. option:: -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 @@ -68,10 +69,12 @@ Options specified, then the key's publication and activation dates are also set to the present time. -``-K directory`` +.. option:: -K directory + This option sets the directory in which the key files are to reside. -``-L ttl`` +.. option:: -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 @@ -80,16 +83,20 @@ Options defaults to the SOA TTL. Setting the default TTL to ``0`` or ``none`` removes it from the key. -``-h`` +.. option:: -h + This option emits a usage message and exits. -``-V`` +.. option:: -V + This option prints version information. -``-v level`` +.. option:: -v level + This option sets the debugging level. -``-E engine`` +.. option:: -E engine + This option specifies the cryptographic hardware to use, when applicable. When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL @@ -108,47 +115,57 @@ 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``. -``-P date/offset`` +.. option:: -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 ds date/offset`` +.. option:: -P ds date/offset + This option sets the date on which DS records that match this key have been seen in the parent zone. -``-P sync date/offset`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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 ds date/offset`` +.. option:: -D ds date/offset + This option sets the date on which the DS records that match this key have been seen removed from the parent zone. -``-D sync date/offset`` +.. option:: -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`` +.. option:: -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 @@ -156,7 +173,8 @@ explicitly prevent a date from being set, use ``none`` or ``never``. predecessor. The publication date is set to the activation date minus the prepublication interval, which defaults to 30 days. -``-i interval`` +.. option:: -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 @@ -183,22 +201,28 @@ purpose, but should never be used in production. Known key states are HIDDEN, RUMOURED, OMNIPRESENT, and UNRETENTIVE. -``-s`` +.. option:: -s + This option indicates that when setting key timing data, the state file should also be updated. -``-g state`` +.. option:: -g state + This option sets the goal state for this key. Must be HIDDEN or OMNIPRESENT. -``-d state date/offset`` +.. option:: -d state date/offset + This option sets the DS state for this key as of the specified date, offset from the current date. -``-k state date/offset`` +.. option:: -k state date/offset + This option sets the DNSKEY state for this key as of the specified date, offset from the current date. -``-r state date/offset`` +.. option:: -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 state date/offset`` +.. option:: -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 @@ -207,10 +231,12 @@ Printing Options ``dnssec-settime`` can also be used to print the timing metadata associated with a key. -``-u`` +.. option:: -u + This option indicates that times should be printed in Unix epoch format. -``-p C/P/Pds/Psync/A/R/I/D/Dds/Dsync/all`` +.. option:: -p C/P/Pds/Psync/A/R/I/D/Dds/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 diff --git a/bin/dnssec/dnssec-signzone.rst b/bin/dnssec/dnssec-signzone.rst index 4dbf25a84e..4288acd496 100644 --- a/bin/dnssec/dnssec-signzone.rst +++ b/bin/dnssec/dnssec-signzone.rst @@ -33,21 +33,26 @@ file for each child zone. Options ~~~~~~~ -``-a`` +.. option:: -a + This option verifies all generated signatures. -``-c class`` +.. option:: -c class + This option specifies the DNS class of the zone. -``-C`` +.. option:: -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`` +.. option:: -d directory + This option indicates the directory where BIND 9 should look for ``dsset-`` or ``keyset-`` files. -``-D`` +.. option:: -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. @@ -55,7 +60,8 @@ Options ``$INCLUDE``. This option cannot be combined with ``-O raw`` or serial-number updating. -``-E engine`` +.. option:: -E engine + This option specifies the hardware to use for cryptographic operations, such as a secure key store used for signing, when applicable. @@ -63,19 +69,23 @@ Options engine identifier that drives the cryptographic accelerator or hardware service module (usually ``pkcs11``). -``-g`` +.. option:: -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`` +.. option:: -K directory + This option specifies the directory to search for DNSSEC keys. If not specified, it defaults to the current directory. -``-k key`` +.. option:: -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`` +.. option:: -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, @@ -86,7 +96,8 @@ Options ``named.conf``. (Note: This option is incompatible with ``-D``, because it modifies non-DNSSEC data in the output zone.) -``-s start-time`` +.. option:: -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; @@ -95,7 +106,8 @@ Options time. If no ``start-time`` is specified, the current time minus 1 hour (to allow for clock skew) is used. -``-e end-time`` +.. option:: -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``, @@ -104,7 +116,8 @@ Options specified, 30 days from the start time is the default. ``end-time`` must be later than ``start-time``. -``-X extended end-time`` +.. option:: -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; @@ -119,20 +132,24 @@ Options 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`` +.. option:: -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``. -``-h`` +.. option:: -h + This option prints a short summary of the options and arguments to ``dnssec-signzone``. -``-V`` +.. option:: -V + This option prints version information. -``-i interval`` +.. option:: -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 @@ -146,14 +163,16 @@ Options days. Therefore, if any existing RRSIG records are due to expire in less than 7.5 days, they are replaced. -``-I input-format`` +.. option:: -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 signed directly. This option is not useful for non-dynamic zones. -``-j jitter`` +.. option:: -j jitter + When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expire simultaneously. If the zone is incrementally signed, i.e., a previously signed zone is passed @@ -168,16 +187,19 @@ Options less congestion than if all validators need to refetch at around the same time. -``-L serial`` +.. option:: -L serial + When writing a signed zone to "raw" 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`` +.. option:: -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`` +.. option:: -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``. @@ -200,11 +222,13 @@ Options than or equal to that value, in which case it is simply incremented by one. -``-o origin`` +.. option:: -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`` +.. option:: -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 @@ -214,7 +238,8 @@ Options 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. -``-P`` +.. option:: -P + This option disables post-sign verification tests. The post-sign verification tests ensure that for each algorithm in @@ -222,7 +247,8 @@ Options revoked KSK keys are self-signed, and that all records in the zone are signed by the algorithm. This option skips these tests. -``-Q`` +.. option:: -Q + This option removes signatures from keys that are no longer active. Normally, when a previously signed zone is passed as input to the @@ -234,14 +260,16 @@ Options active. This enables ZSK rollover using the procedure described in :rfc:`4641#4.2.1.1` ("Pre-Publish Key Rollover"). -``-q`` +.. option:: -q + 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`` +.. option:: -R + This option removes signatures from keys that are no longer published. This option is similar to ``-Q``, except it forces @@ -250,7 +278,8 @@ Options :rfc:`4641#4.2.1.2` ("Double Signature Zone Signing Key Rollover"). -``-S`` +.. option:: -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. @@ -283,7 +312,8 @@ Options 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`` +.. option:: -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 @@ -295,40 +325,48 @@ Options conflict between TTL values in imported keys, the shortest one is used. -``-t`` +.. option:: -t + This option prints statistics at completion. -``-u`` +.. option:: -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 switched to NSEC or to NSEC3 with different parameters. Without this option, ``dnssec-signzone`` retains the existing chain when re-signing. -``-v level`` +.. option:: -v level + This option sets the debugging level. -``-x`` +.. option:: -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`` +.. option:: -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`` +.. option:: -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`` +.. option:: -H iterations + This option indicates that, when generating an NSEC3 chain, BIND 9 should use this many iterations. The default is 10. -``-A`` +.. option:: -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. @@ -336,10 +374,12 @@ Options all records. This is useful when using the ``-u`` option to modify an NSEC3 chain which previously had OPTOUT set. -``zonefile`` +.. option:: zonefile + This option sets the file containing the zone to be signed. -``key`` +.. option:: 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 diff --git a/bin/dnssec/dnssec-verify.rst b/bin/dnssec/dnssec-verify.rst index 28e6cd8b43..5d8c7c0b56 100644 --- a/bin/dnssec/dnssec-verify.rst +++ b/bin/dnssec/dnssec-verify.rst @@ -31,48 +31,57 @@ NSEC/NSEC3 chains are complete. Options ~~~~~~~ -``-c class`` +.. option:: -c class + This option specifies the DNS class of the zone. -``-E engine`` +.. option:: -E engine + This option specifies the cryptographic hardware to use, when applicable. When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually ``pkcs11``). -``-I input-format`` +.. option:: -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`` +.. option:: -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`` +.. option:: -v level + This option sets the debugging level. -``-V`` +.. option:: -V + This option prints version information. -``-q`` +.. option:: -q + 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`` +.. option:: -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`` +.. option:: -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 diff --git a/bin/named/named.rst b/bin/named/named.rst index ea440b202b..b9cd8ed503 100644 --- a/bin/named/named.rst +++ b/bin/named/named.rst @@ -35,30 +35,36 @@ listens for queries. Options ~~~~~~~ -``-4`` +.. option:: -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`` +.. option:: -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`` +.. option:: -c config-file + This option tells ``named`` to use ``config-file`` as its configuration file instead of the default, |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. -``-d debug-level`` +.. option:: -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`` +.. option:: -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`` +.. option:: -E engine-name + When applicable, this option specifies the hardware to use for cryptographic operations, such as a secure key store used for signing. @@ -66,16 +72,20 @@ Options engine identifier that drives the cryptographic accelerator or hardware service module (usually ``pkcs11``). -``-f`` +.. option:: -f + This option runs the server in the foreground (i.e., do not daemonize). -``-g`` +.. option:: -g + This option runs the server in the foreground and forces all logging to ``stderr``. -``-L logfile`` +.. option:: -L logfile + This option sets the log to the file ``logfile`` by default, instead of the system log. -``-M option`` +.. option:: -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 @@ -84,18 +94,21 @@ Options and is the default unless ``named`` has been compiled with developer options. -``-m flag`` +.. option:: -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`` +.. option:: -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 value`` +.. option:: -p value + This option specifies the port(s) on which the server will listen for queries. If ``value`` is of the form ```` or ``dns=``, the server will listen for DNS queries on @@ -106,8 +119,9 @@ Options listen for HTTPS queries on ``portnum``; the default is 443. If ``value`` is of the form ``http=``, the server will listen for HTTP queries on ``portnum``; the default is 80. - -``-s`` + +.. option:: -s + This option writes memory usage statistics to ``stdout`` on exit. .. note:: @@ -115,7 +129,8 @@ Options This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. -``-S #max-socks`` +.. option:: -S #max-socks + This option is deprecated and no longer has any function. .. warning:: @@ -130,7 +145,8 @@ Options specified value, because ``named`` reserves some file descriptors for its internal use. -``-t directory`` +.. option:: -t directory + This option tells ``named`` to chroot to ``directory`` after processing the command-line arguments, but before reading the configuration file. @@ -141,7 +157,8 @@ Options most systems; the way ``chroot`` is defined allows a process with root privileges to escape a chroot jail. -``-U #listeners`` +.. option:: -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 @@ -151,7 +168,8 @@ Options CPUs, then ``-U`` may be increased as high as that value, but no higher. -``-u user`` +.. option:: -u user + This option sets the setuid to ``user`` after completing privileged operations, such as creating sockets that listen on privileged ports. @@ -165,13 +183,16 @@ Options previous kernels did not allow privileges to be retained after ``setuid``. -``-v`` +.. option:: -v + This option reports the version number and exits. -``-V`` +.. option:: -V + This option reports the version number and build options, and exits. -``-X lock-file`` +.. option:: -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 diff --git a/bin/nsupdate/nsupdate.rst b/bin/nsupdate/nsupdate.rst index 64865a53f8..1bd4cdedc8 100644 --- a/bin/nsupdate/nsupdate.rst +++ b/bin/nsupdate/nsupdate.rst @@ -63,26 +63,33 @@ used by Windows 2000 can be switched on with the ``-o`` flag. Options ~~~~~~~ -``-4`` +.. option:: -4 + This option sets use of IPv4 only. -``-6`` +.. option:: -6 + This option sets use of IPv6 only. -``-C`` +.. option:: -C + Overrides the default `resolv.conf` file. This is only intended for testing. -``-d`` +.. option:: -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`` +.. option:: -D + This option sets extra debug mode. -``-i`` +.. option:: -i + This option forces interactive mode, even when standard input is not a terminal. -``-k keyfile`` +.. option:: -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``; @@ -93,7 +100,8 @@ Options key used to authenticate Dynamic DNS update requests. In this case, the key specified is not an HMAC-MD5 key. -``-l`` +.. option:: -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 use a TSIG key @@ -102,26 +110,32 @@ Options ``update-policy`` to ``local``. The location of this key file can be overridden with the ``-k`` option. -``-L level`` +.. option:: -L level + This option sets the logging debug level. If zero, logging is disabled. -``-p port`` +.. option:: -p port + This option sets the port to use for connections to a name server. The default is 53. -``-P`` +.. option:: -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`` +.. option:: -r udpretries + This option sets the number of UDP retries. The default is 3. If zero, only one update request is made. -``-t timeout`` +.. option:: -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`` +.. option:: -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`` @@ -132,21 +146,25 @@ Options present, is parsed using the UNKNOWN rdata format, ( ). -``-u udptimeout`` +.. option:: -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`` +.. option:: -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 is used. TCP may be preferable when a batch of update requests is made. -``-V`` +.. option:: -V + This option prints the version number and exits. -``-y [hmac:]keyname:secret`` +.. option:: -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``, diff --git a/bin/rndc/rndc.rst b/bin/rndc/rndc.rst index fbc836a5c2..0f76030534 100644 --- a/bin/rndc/rndc.rst +++ b/bin/rndc/rndc.rst @@ -46,51 +46,62 @@ server and decide what algorithm and key it should use. Options ~~~~~~~ -``-4`` +.. option:: -4 + This option indicates use of IPv4 only. -``-6`` +.. option:: -6 + This option indicates use of IPv6 only. -``-b source-address`` +.. option:: -b source-address + 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`` +.. option:: -c config-file + This option indicates ``config-file`` as the configuration file instead of the default, |rndc_conf|. -``-k key-file`` +.. option:: -k key-file + This option indicates ``key-file`` as the key file instead of the default, |rndc_key|. The key in |rndc_key| is used to authenticate commands sent to the server if the config-file does not exist. -``-s server`` +.. option:: -s server + ``server`` is the name or address of the server which matches a server statement in the configuration file for ``rndc``. If no server is supplied on the command line, the host named by the default-server clause in the options statement of the ``rndc`` configuration file is used. -``-p port`` +.. option:: -p port + This option instructs BIND 9 to send commands to TCP port ``port`` instead of its default control channel port, 953. -``-q`` +.. option:: -q + This option sets quiet mode, where message text returned by the server is not printed unless there is an error. -``-r`` +.. option:: -r + 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`` +.. option:: -V + This option enables verbose logging. -``-y key_id`` +.. option:: -y key_id + 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 @@ -108,7 +119,8 @@ without arguments. Currently supported commands are: -``addzone`` *zone* [*class* [*view*]] *configuration* +.. option:: addzone zone [class [view]] configuration + 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 @@ -133,7 +145,8 @@ Currently supported commands are: See also ``rndc delzone`` and ``rndc modzone``. -``delzone`` [**-clean**] *zone* [*class* [*view*]] +.. option:: delzone [-clean] zone [class [view]] + This command deletes a zone while the server is running. If the ``-clean`` argument is specified, the zone's master file (and @@ -151,7 +164,8 @@ Currently supported commands are: See also ``rndc addzone`` and ``rndc modzone``. -``dnssec`` ( **-status** | **-rollover** **-key** id [**-alg** *algorithm*] [**-when** *time*] | **-checkds** [**-key** *id* [**-alg** *algorithm*]] [**-when** *time*] ( *published* | *withdrawn* )) *zone* [*class* [*view*]] +.. option:: dnssec (-status | -rollover -key id [-alg algorithm] [-when time] | -checkds [-key id [-alg algorithm]] [-when time] published | withdraw)) zone [class [view]] + This command allows you to interact with the "dnssec-policy" of a given zone. @@ -170,7 +184,8 @@ Currently supported commands are: select the correct algorithm). The time that the DS has been published or withdrawn is set to now, unless otherwise specified with the argument ``-when time``. -``dnstap`` ( **-reopen** | **-roll** [*number*] ) +.. option:: dnstap (-reopen | -roll [number]) + 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 @@ -179,25 +194,30 @@ Currently supported commands are: output file is moved to ".1", and so on. If ``number`` is specified, then the number of backup log files is limited to that number. -``dumpdb`` [**-all** | **-cache** | **-zones** | **-adb** | **-bad** | **-expired** | **-fail**] [*view ...*] +.. option:: dumpdb [-all | -cache | -zones | -adb | -bad | -expired | -fail] [view ...] + 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`` +.. option:: flush + This command flushes the server's cache. -``flushname`` *name* [*view*] +.. option:: flushname name [view] + 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*] +.. option:: flushtree name [view] + 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*]]] +.. option:: freeze [zone [class [view]]] + 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 @@ -206,7 +226,8 @@ Currently supported commands are: See also ``rndc thaw``. -``halt`` [**-p**] +.. option:: halt [-p] + 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 @@ -216,7 +237,8 @@ Currently supported commands are: See also ``rndc stop``. -``loadkeys`` [*zone* [*class* [*view*]]] +.. option:: loadkeys [zone [class [view]]] + 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 @@ -228,7 +250,8 @@ Currently supported commands are: zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.) -``managed-keys`` (*status* | *refresh* | *sync* | *destroy*) [*class* [*view*]] +.. option:: managed-keys (status | refresh | sync | destroy) [class [view]] + 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 @@ -266,7 +289,8 @@ Currently supported commands are: keys in the event of a trust anchor rollover, or as a brute-force repair for key maintenance problems. -``modzone`` *zone* [*class* [*view*]] *configuration* +.. option:: modzone zone [class [view]] configuration + 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 @@ -284,15 +308,18 @@ Currently supported commands are: See also ``rndc addzone`` and ``rndc delzone``. -``notify`` *zone* [*class* [*view*]] +.. option:: notify zone [class [view]] + This command resends NOTIFY messages for the zone. -``notrace`` +.. option:: notrace + This command sets the server's debugging level to 0. See also ``rndc trace``. -``nta`` [( **-class** *class* | **-dump** | **-force** | **-remove** | **-lifetime** *duration*)] *domain* [*view*] +.. option:: nta [(-class class | -dump | -force | -remove | -lifetime duration)] domain [view] + 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 @@ -343,7 +370,8 @@ Currently supported commands are: view name that begins with a hyphen, use a double-hyphen (--) on the command line to indicate the end of options. -``querylog`` [(*on* | *off*)] +.. option:: querylog [(on | off)] + 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. @@ -353,13 +381,15 @@ Currently supported commands are: of ``named.conf``, or by specifying ``querylog yes;`` in the ``options`` section of ``named.conf``. -``reconfig`` +.. option:: reconfig + 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`` +.. option:: recursing + 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. @@ -379,16 +409,20 @@ Currently supported commands are: and the next time a fetch is sent to that domain, it is recreated with the counters set to zero). -``refresh`` *zone* [*class* [*view*]] +.. option:: refresh zone [class [view]] + This command schedules zone maintenance for the given zone. -``reload`` +.. option:: reload + This command reloads the configuration file and zones. -``reload`` *zone* [*class* [*view*]] +.. option:: reload zone [class [view]] + This command reloads the given zone. -``retransfer`` *zone* [*class* [*view*]] +.. option:: retransfer zone [class [view]] + This command retransfers the given secondary zone from the primary server. If the zone is configured to use ``inline-signing``, the signed @@ -396,12 +430,14 @@ Currently supported commands are: unsigned version is complete, the signed version is regenerated with new signatures. -``scan`` +.. option:: scan + 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* ...] +.. option:: secroots [-] [view ...] + 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 @@ -418,7 +454,8 @@ Currently supported commands are: See also ``rndc managed-keys``. -``serve-stale`` (**on** | **off** | **reset** | **status**) [*class* [*view*]] +.. option:: serve-stale (on | off | reset | status) [class [view]] + This command enables, disables, resets, or reports the current status of the serving of stale answers as configured in ``named.conf``. @@ -430,12 +467,14 @@ Currently supported commands are: answers is currently enabled or disabled. It also reports the values of ``stale-answer-ttl`` and ``max-stale-ttl``. -``showzone`` *zone* [*class* [*view*]] +.. option:: showzone zone [class [view]] + This command prints the configuration of a running zone. See also ``rndc zonestatus``. -``sign`` *zone* [*class* [*view*]] +.. option:: sign zone [class [view]] + 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 @@ -450,7 +489,8 @@ Currently supported commands are: See also ``rndc loadkeys``. -``signing`` [(**-list** | **-clear** *keyid/algorithm* | **-clear** *all* | **-nsec3param** ( *parameters* | none ) | **-serial** *value* ) *zone* [*class* [*view*]] +.. option:: signing [(-list | -clear keyid/algorithm | -clear all | -nsec3param (parameters | none) | -serial value) zone [class [view]] + 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 @@ -495,17 +535,20 @@ Currently supported commands are: is rejected. The primary use of this parameter is to set the serial number on inline signed zones. -``stats`` +.. option:: stats + This command writes server statistics to the statistics file. (See the ``statistics-file`` option in the BIND 9 Administrator Reference Manual.) -``status`` +.. option:: status + 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** +.. option:: stop -p + 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. @@ -514,12 +557,14 @@ Currently supported commands are: See also ``rndc halt``. -``sync`` **-clean** [*zone* [*class* [*view*]]] +.. option:: sync -clean [zone [class [view]]] + 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*] +.. option:: tcp-timeouts [initial idle keepalive advertised] + 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. @@ -528,7 +573,8 @@ Currently supported commands are: denial-of-service (DoS) attack. See the descriptions of these options in the BIND 9 Administrator Reference Manual for details of their use. -``thaw`` [*zone* [*class* [*view*]]] +.. option:: thaw [zone [class [view]]] + 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 @@ -540,31 +586,37 @@ Currently supported commands are: See also ``rndc freeze``. -``trace`` +.. option:: trace + This command increments the server's debugging level by one. -``trace`` *level* +.. option:: trace level + This command sets the server's debugging level to an explicit value. See also ``rndc notrace``. -``tsig-delete`` *keyname* [*view*] +.. option:: tsig-delete keyname [view] + This command deletes a given TKEY-negotiated key from the server. This does not apply to statically configured TSIG keys. -``tsig-list`` +.. option:: tsig-list + 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* ...]`` +.. option:: validation (on | off | status) [view ...] + 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*]] +.. option:: zonestatus zone [class [view]] + 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, @@ -574,7 +626,7 @@ Currently supported commands are: See also ``rndc showzone``. -``rndc`` commands that specify zone names, such as ``reload``, +``rndc`` commands that specify zone names, such as ``reload`` ``retransfer``, or ``zonestatus``, can be ambiguous when applied to zones of type ``redirect``. Redirect zones are always called ``.``, and can be confused with zones of type ``hint`` or with secondary copies of the root diff --git a/bin/tools/dnstap-read.rst b/bin/tools/dnstap-read.rst index 104c05f2e6..dc04f4ec1c 100644 --- a/bin/tools/dnstap-read.rst +++ b/bin/tools/dnstap-read.rst @@ -32,18 +32,22 @@ longer and more detailed YAML format is used. Options ~~~~~~~ -``-m`` +.. option:: -m + This option indicates trace memory allocations, and is used for debugging memory leaks. -``-p`` +.. option:: -p + This option prints the text form of the DNS message that was encapsulated in the ``dnstap`` frame, after printing the ``dnstap`` data. -``-x`` +.. option:: -x + This option prints a hex dump of the wire form of the DNS message that was encapsulated in the ``dnstap`` frame, after printing the ``dnstap`` data. -``-y`` +.. option:: -y + This option prints ``dnstap`` data in a detailed YAML format. See Also diff --git a/bin/tools/mdig.rst b/bin/tools/mdig.rst index 50aa588637..eb6fbdb459 100644 --- a/bin/tools/mdig.rst +++ b/bin/tools/mdig.rst @@ -60,39 +60,47 @@ assign values to options like the timeout interval. They have the form Anywhere Options ~~~~~~~~~~~~~~~~ -``-f`` +.. option:: -f + This option makes ``mdig`` operate in batch mode by reading a list of lookup requests to process from the file ``filename``. The file contains a number of queries, one per line. Each entry in the file should be organized in the same way they would be presented as queries to ``mdig`` using the command-line interface. -``-h`` +.. option:: -h + This option causes ``mdig`` to print detailed help information, with the full list of options, and exit. -``-v`` +.. option:: -v + This option causes ``mdig`` to print the version number and exit. Global Options ~~~~~~~~~~~~~~ -``-4`` +.. option:: -4 + This option forces ``mdig`` to only use IPv4 query transport. -``-6`` +.. option:: -6 + This option forces ``mdig`` to only use IPv6 query transport. -``-b address`` +.. option:: -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 port may be specified by appending "#" -``-m`` +.. option:: -m + This option enables memory usage debugging. -``-p port#`` +.. option:: -p port# + This option is used when a non-standard port number is to be queried. ``port#`` is the port number that ``mdig`` sends its queries to, instead of the standard DNS port number 53. This option is @@ -101,39 +109,49 @@ Global Options The global query options are: -``+[no]additional`` +.. option:: +[no]additional + This option displays [or does not display] the additional section of a reply. The default is to display it. -``+[no]all`` +.. option:: +[no]all + This option sets or clears all display flags. -``+[no]answer`` +.. option:: +[no]answer + This option displays [or does not display] the answer section of a reply. The default is to display it. -``+[no]authority`` +.. option:: +[no]authority + This option displays [or does not display] the authority section of a reply. The default is to display it. -``+[no]besteffort`` +.. option:: +[no]besteffort + This option attempts to display [or does not display] the contents of messages which are malformed. The default is to not display malformed answers. -``+burst`` +.. option:: +burst + This option delays queries until the start of the next second. -``+[no]cl`` +.. option:: +[no]cl + This option displays [or does not display] the CLASS when printing the record. -``+[no]comments`` +.. option:: +[no]comments + This option toggles the display of comment lines in the output. The default is to print comments. -``+[no]continue`` +.. option:: +[no]continue + This option toggles continuation on errors (e.g. timeouts). -``+[no]crypto`` +.. option:: +[no]crypto + 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 @@ -141,50 +159,60 @@ The global query options are: they are replaced by the string "[omitted]"; in the DNSKEY case, the key ID is displayed as the replacement, e.g., ``[ key id = value ]``. -``+dscp[=value]`` +.. option:: +dscp[=value] + 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]multiline`` +.. option:: +[no]multiline + This option toggles printing of 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 ``mdig`` output. -``+[no]question`` +.. option:: +[no]question + This option prints [or does not print] the question section of a query when an answer is returned. The default is to print the question section as a comment. -``+[no]rrcomments`` +.. option:: +[no]rrcomments + 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]short`` +.. option:: +[no]short + This option provides [or does not provide] a terse answer. The default is to print the answer in a verbose form. -``+split=W`` +.. option:: +split=W + 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. The default is 56 characters, or 44 characters when multiline mode is active. -``+[no]tcp`` +.. option:: +[no]tcp + This option uses [or does not use] TCP when querying name servers. The default behavior is to use UDP. -``+[no]ttlid`` +.. option:: +[no]ttlid + This option displays [or does not display] the TTL when printing the record. -``+[no]ttlunits`` +.. option:: +[no]ttlunits + 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]vc`` +.. option:: +[no]vc + 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". @@ -192,18 +220,21 @@ The global query options are: Local Options ~~~~~~~~~~~~~ -``-c class`` +.. option:: -c class + This option sets the query class to ``class``. It can be any valid query class which is supported in BIND 9. The default query class is "IN". -``-t type`` +.. option:: -t type + This option sets the query type to ``type``. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the ``-x`` option is supplied to indicate a reverse lookup with the "PTR" query type. -``-x addr`` +.. option:: -x addr + Reverse lookups - mapping addresses to names - are simplified by this option. ``addr`` is an IPv4 address in dotted-decimal notation, or a colon-delimited IPv6 address. ``mdig`` automatically @@ -214,13 +245,16 @@ Local Options The local query options are: -``+[no]aaflag`` +.. option:: +[no]aaflag + This is a synonym for ``+[no]aaonly``. -``+[no]aaonly`` +.. option:: +[no]aaonly + This sets the ``aa`` flag in the query. -``+[no]adflag`` +.. option:: +[no]adflag + This 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 @@ -229,59 +263,71 @@ The local query options are: indicates that some part of the answer was insecure or not validated. This bit is set by default. -``+bufsize=B`` +.. option:: +bufsize=B + This 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 cause a EDNS query to be sent. -``+[no]cdflag`` +.. option:: +[no]cdflag + This 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]cookie=####`` +.. option:: +[no]cookie=#### + This 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 ``+nocookie``. -``+[no]dnssec`` +.. option:: +[no]dnssec + This requests that DNSSEC records be sent by setting the DNSSEC OK (DO) bit in the OPT record in the additional section of the query. -``+[no]edns[=#]`` +.. option:: +[no]edns[=#] + This specifies [or does not specify] 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[=#]`` +.. option:: +[no]ednsflags[=#] + This sets the must-be-zero EDNS flag 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]ednsopt[=code[:value]]`` +.. option:: +[no]ednsopt[=code[:value]] + This specifies [or does not specify] an EDNS option with code point ``code`` and an optional payload of ``value`` as a hexadecimal string. ``+noednsopt`` clears the EDNS options to be sent. -``+[no]expire`` +.. option:: +[no]expire + This toggles sending of an EDNS Expire option. -``+[no]nsid`` +.. option:: +[no]nsid + This toggles inclusion of an EDNS name server ID request when sending a query. -``+[no]recurse`` +.. option:: +[no]recurse + This toggles the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means ``mdig`` normally sends recursive queries. -``+retry=T`` +.. option:: +retry=T + This 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]subnet=addr[/prefix-length]`` +.. option:: +[no]subnet=addr[/prefix-length] + This sends [or does not send] an EDNS Client Subnet option with the specified IP address or network prefix. @@ -290,29 +336,35 @@ The local query options are: prefix-length of zero, which signals a resolver that the client's address information must *not* be used when resolving this query. -``+timeout=T`` +.. option:: +timeout=T + This sets the timeout for a query to ``T`` seconds. The default timeout is 5 seconds for UDP transport and 10 for TCP. An attempt to set ``T`` to less than 1 results in a query timeout of 1 second being applied. -``+tries=T`` +.. option:: +tries=T + This 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. -``+udptimeout=T`` +.. option:: +udptimeout=T + This sets the timeout between UDP query retries to ``T``. -``+[no]unknownformat`` +.. option:: +[no]unknownformat + This prints [or does not print] all RDATA in unknown RR-type presentation format (see :rfc:`3597`). The default is to print RDATA for known types in the type's presentation format. -``+[no]yaml`` +.. option:: +[no]yaml + This toggles printing of the responses in a detailed YAML format. -``+[no]zflag`` +.. option:: +[no]zflag + This sets [or does not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. diff --git a/bin/tools/named-nzd2nzf.rst b/bin/tools/named-nzd2nzf.rst index d20fc369b1..634cc85561 100644 --- a/bin/tools/named-nzd2nzf.rst +++ b/bin/tools/named-nzd2nzf.rst @@ -33,7 +33,8 @@ version of BIND to an older version. Arguments ~~~~~~~~~ -``filename`` +.. option:: filename + This is the name of the ``.nzd`` file whose contents should be printed. See Also diff --git a/bin/tools/named-rrchecker.rst b/bin/tools/named-rrchecker.rst index 191f229319..7ea9c39de8 100644 --- a/bin/tools/named-rrchecker.rst +++ b/bin/tools/named-rrchecker.rst @@ -30,22 +30,27 @@ input and checks whether it is syntactically correct. Options ~~~~~~~ -``-h`` +.. option:: -h + This option prints out the help menu. -``-o origin`` +.. option:: -o origin + This option specifies the origin to be used when interpreting the record. -``-p`` +.. option:: -p + This option prints out the resulting record in canonical form. If there is no canonical form defined, the record is printed in unknown record format. -``-u`` +.. option:: -u + This option prints out the resulting record in unknown record form. -``-C``, ``-T``, and ``-P`` +.. option:: -C, -T, -P + These options print out the known class, standard type, and private type mnemonics, respectively. diff --git a/bin/tools/nsec3hash.rst b/bin/tools/nsec3hash.rst index 9b174cee34..9facfc773e 100644 --- a/bin/tools/nsec3hash.rst +++ b/bin/tools/nsec3hash.rst @@ -39,22 +39,27 @@ into a command line to confirm the correctness of an NSEC3 hash. Arguments ~~~~~~~~~ -``salt`` +.. option:: salt + This is the salt provided to the hash algorithm. -``algorithm`` +.. option:: algorithm + This is a number indicating the hash algorithm. Currently the only supported hash algorithm for NSEC3 is SHA-1, which is indicated by the number 1; consequently "1" is the only useful value for this argument. -``flags`` +.. option:: flags + This is provided for compatibility with NSEC3 record presentation format, but is ignored since the flags do not affect the hash. -``iterations`` +.. option:: iterations + This is the number of additional times the hash should be performed. -``domain`` +.. option:: domain + This is the domain name to be hashed. See Also diff --git a/doc/man/ddns-confgen.8in b/doc/man/ddns-confgen.8in index 47261ab8c8..3088aca7d1 100644 --- a/doc/man/ddns-confgen.8in +++ b/doc/man/ddns-confgen.8in @@ -54,37 +54,47 @@ be used from a remote system. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a algorithm\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints a short summary of options and arguments. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k keyname\fP +.B \-k keyname This option specifies the key name of the DDNS authentication key. The default is \fBddns\-key\fP when neither the \fB\-s\fP nor \fB\-z\fP option is specified; otherwise, the default is \fBddns\-key\fP as a separate label followed by the argument of the option, e.g., \fBddns\-key.example.com.\fP The key name must have the format of a valid domain name, consisting of letters, digits, hyphens, and periods. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option enables quiet mode, which prints only the key, with no explanatory text or usage examples. This is essentially identical to \fBtsig\-keygen\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s name\fP +.B \-s name This option generates a configuration example to allow dynamic updates of a single hostname. The example \fBnamed.conf\fP text shows how to set an update policy for the specified name using the "name" nametype. The default key name is \fBddns\-key.name\fP\&. 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 \fB\-z\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-z zone\fP +.B \-z zone This option generates a configuration example to allow dynamic updates of a zone. The example \fBnamed.conf\fP text shows how to set an update policy for the specified zone using the "zonesub" diff --git a/doc/man/delv.1in b/doc/man/delv.1in index 08e095d04c..407d07cca2 100644 --- a/doc/man/delv.1in +++ b/doc/man/delv.1in @@ -84,7 +84,7 @@ delv @server name type where: .INDENT 0.0 .TP -.B \fBserver\fP +.B server is the name or IP address of the name server to query. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation. When the supplied \fBserver\fP argument is a @@ -99,11 +99,15 @@ options is in use, then only addresses for the corresponding transport are tried. If no usable addresses are found, \fBdelv\fP sends queries to the localhost addresses (127.0.0.1 for IPv4, ::1 for IPv6). +.UNINDENT +.INDENT 0.0 .TP -.B \fBname\fP +.B name is the domain name to be looked up. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtype\fP +.B type indicates what type of query is required \- ANY, A, MX, etc. \fBtype\fP can be any valid query type. If no \fBtype\fP argument is supplied, \fBdelv\fP performs a lookup for an A record. @@ -111,7 +115,7 @@ supplied, \fBdelv\fP performs a lookup for an A record. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a anchor\-file\fP +.B \-a anchor\-file This option specifies a file from which to read DNSSEC trust anchors. The default is \fB@sysconfdir@/bind.keys\fP, which is included with BIND 9 and contains one or more trust anchors for the root zone ("."). @@ -126,52 +130,70 @@ supported. \fBdelv\fP does not consult the managed\-keys database maintained by \fBnamed\fP, which means that if either of the keys in \fB@sysconfdir@/bind.keys\fP is revoked and rolled over, \fB@sysconfdir@/bind.keys\fP must be updated to use DNSSEC validation in \fBdelv\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-b address\fP +.B \-b address This option sets the source IP address of the query to \fBaddress\fP\&. This must be a valid address on one of the host\(aqs network interfaces, or \fB0.0.0.0\fP, or \fB::\fP\&. An optional source port may be specified by appending \fB#\fP +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option sets the query class for the requested data. Currently, only class "IN" is supported in \fBdelv\fP and any other value is ignored. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d level\fP +.B \-d level This option sets the systemwide debug level to \fBlevel\fP\&. The allowed range is from 0 to 99. The default is 0 (no debugging). Debugging traces from \fBdelv\fP become more verbose as the debug level increases. See the \fB+mtrace\fP, \fB+rtrace\fP, and \fB+vtrace\fP options below for additional debugging details. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option displays the \fBdelv\fP help usage output and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i\fP +.B \-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 \fBdelv\fP to time out. When it is necessary to examine invalid data to debug a DNSSEC problem, use \fBdig +cd\fP\&.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m\fP +.B \-m This option enables memory usage debugging. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port#\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q name\fP +.B \-q name This option sets the query name to \fBname\fP\&. While the query name can be specified without using the \fB\-q\fP 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). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t type\fP +.B \-t type This option sets the query type to \fBtype\fP, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR. As with \fB\-q\fP, this is useful to distinguish query\-name types or classes @@ -180,11 +202,15 @@ names from types. .sp The default query type is "A", unless the \fB\-x\fP option is supplied to indicate a reverse lookup, in which case it is "PTR". +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option prints the \fBdelv\fP version and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x addr\fP +.B \-x addr This option performs a reverse lookup, mapping an address to a name. \fBaddr\fP is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When \fB\-x\fP is used, there is no need to provide the @@ -192,11 +218,15 @@ IPv6 address. When \fB\-x\fP is used, there is no need to provide the lookup for a name like \fB11.12.13.10.in\-addr.arpa\fP and sets the query type to PTR. IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option forces \fBdelv\fP to only use IPv4. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option forces \fBdelv\fP to only use IPv6. .UNINDENT .SH QUERY OPTIONS @@ -211,7 +241,7 @@ assign values to options like the timeout interval. They have the form \fB+keyword=value\fP\&. The query options are: .INDENT 0.0 .TP -.B \fB+[no]cdflag\fP +.B +[no]cdflag This option controls whether to set the CD (checking disabled) bit in queries sent by \fBdelv\fP\&. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver. A validating resolver @@ -219,16 +249,22 @@ 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 \fBdelv\fP can then validate internally and report the errors in detail. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]class\fP +.B +[no]class This option controls whether to display the CLASS when printing a record. The default is to display the CLASS. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ttl\fP +.B +[no]ttl This option controls whether to display the TTL when printing a record. The default is to display the TTL. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]rtrace\fP +.B +[no]rtrace This option toggles resolver fetch logging. This reports the name and type of each query sent by \fBdelv\fP in the process of carrying out the resolution and validation process, including the original query @@ -239,8 +275,10 @@ This is equivalent to setting the debug level to 1 in the "resolver" logging category. Setting the systemwide debug level to 1 using the \fB\-d\fP option produces the same output, but affects other logging categories as well. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]mtrace\fP +.B +[no]mtrace This option toggles message logging. This produces a detailed dump of the responses received by \fBdelv\fP in the process of carrying out the resolution and validation process. @@ -249,8 +287,10 @@ 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 \fB\-d\fP option produces the same output, but affects other logging categories as well. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]vtrace\fP +.B +[no]vtrace 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. @@ -259,74 +299,100 @@ 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 \fB\-d\fP option produces the same output, but affects other logging categories as well. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]short\fP +.B +[no]short This option toggles between verbose and terse answers. The default is to print the answer in a verbose form. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]comments\fP +.B +[no]comments This option toggles the display of comment lines in the output. The default is to print comments. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]rrcomments\fP +.B +[no]rrcomments 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]crypto\fP +.B +[no]crypto 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 \fB[omitted]\fP or, in the DNSKEY case, the key ID is displayed as the replacement, e.g. \fB[ key id = value ]\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]trust\fP +.B +[no]trust This option controls whether to display the trust level when printing a record. The default is to display the trust level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]split[=W]\fP +.B +[no]split[=W] This option splits long hex\- or base64\-formatted fields in resource records into chunks of \fBW\fP characters (where \fBW\fP is rounded up to the nearest multiple of 4). \fB+nosplit\fP or \fB+split=0\fP causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]all\fP +.B +[no]all This option sets or clears the display options \fB+[no]comments\fP, \fB+[no]rrcomments\fP, and \fB+[no]trust\fP as a group. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]multiline\fP +.B +[no]multiline 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 \fBdelv\fP output. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]dnssec\fP +.B +[no]dnssec This option indicates whether to display RRSIG records in the \fBdelv\fP output. The default is to do so. Note that (unlike in \fBdig\fP) this does \fInot\fP control whether to request DNSSEC records or to validate them. DNSSEC records are always requested, and validation always occurs unless suppressed by the use of \fB\-i\fP or \fB+noroot\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]root[=ROOT]\fP +.B +[no]root[=ROOT] 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 \fB\-a\fP must be used to specify a file containing the key. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]tcp\fP +.B +[no]tcp This option controls whether to use TCP when sending queries. The default is to use UDP unless a truncated response has been received. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]unknownformat\fP +.B +[no]unknownformat This option prints all RDATA in unknown RR\-type presentation format (\fI\%RFC 3597\fP). The default is to print RDATA for known types in the type\(aqs presentation format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]yaml\fP +.B +[no]yaml This option prints response data in YAML format. .UNINDENT .SH FILES diff --git a/doc/man/dig.1in b/doc/man/dig.1in index ab8f59dddd..61c97248a3 100644 --- a/doc/man/dig.1in +++ b/doc/man/dig.1in @@ -86,7 +86,7 @@ dig @server name type where: .INDENT 0.0 .TP -.B \fBserver\fP +.B server is the name or IP address of the name server to query. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation. When the supplied \fBserver\fP argument is a @@ -100,11 +100,15 @@ options are in use, then only addresses for the corresponding transport are tried. If no usable addresses are found, \fBdig\fP sends the query to the local host. The reply from the name server that responds is displayed. +.UNINDENT +.INDENT 0.0 .TP -.B \fBname\fP +.B name is the name of the resource record that is to be looked up. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtype\fP +.B type indicates what type of query is required \- ANY, A, MX, SIG, etc. \fBtype\fP can be any valid query type. If no \fBtype\fP argument is supplied, \fBdig\fP performs a lookup for an A record. @@ -112,53 +116,73 @@ supplied, \fBdig\fP performs a lookup for an A record. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option indicates that only IPv4 should be used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option indicates that only IPv6 should be used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-b address[#port]\fP +.B \-b address[#port] This option sets the source IP address of the query. The \fBaddress\fP must be a valid address on one of the host\(aqs network interfaces, or "0.0.0.0" or "::". An optional port may be specified by appending \fB#port\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option sets the query class. The default \fBclass\fP is IN; other classes are HS for Hesiod records or CH for Chaosnet records. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f file\fP +.B \-f file This option sets batch mode, in which \fBdig\fP reads a list of lookup requests to process from the given \fBfile\fP\&. Each line in the file should be organized in the same way it would be presented as a query to \fBdig\fP using the command\-line interface. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k keyfile\fP +.B \-k keyfile This option tells \fBnamed\fP to sign queries using TSIG using a key read from the given file. Key files can be generated using \fBtsig\-keygen\fP\&. When using TSIG authentication with \fBdig\fP, 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 \fBkey\fP and \fBserver\fP statements in \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m\fP +.B \-m This option enables memory usage debugging. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q name\fP +.B \-q name This option specifies the domain name to query. This is useful to distinguish the \fBname\fP from other arguments. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r\fP +.B \-r This option indicates that options from \fB${HOME}/.digrc\fP should not be read. This is useful for scripts that need predictable behavior. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t type\fP +.B \-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 \fBNS\fP or \fBAAAA\fP). The default query type is @@ -172,14 +196,20 @@ SOA record was \fBN\fP\&. All resource record types can be expressed as \fBTYPEnn\fP, where \fBnn\fP is the number of the type. If the resource record type is not supported in BIND 9, the result is displayed as described in \fI\%RFC 3597\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u\fP +.B \-u This option indicates that print query times should be provided in microseconds instead of milliseconds. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option prints the version number and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x addr\fP +.B \-x addr This option sets simplified reverse lookups, for mapping addresses to names. The \fBaddr\fP is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When the \fB\-x\fP option is used, there is no @@ -188,8 +218,10 @@ need to provide the \fBname\fP, \fBclass\fP, and \fBtype\fP arguments. \fB94.2.0.192.in\-addr.arpa\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-y [hmac:]keyname:secret\fP +.B \-y [hmac:]keyname:secret This option signs queries using TSIG with the given authentication key. \fBkeyname\fP is the name of the key, and \fBsecret\fP is the base64\-encoded shared secret. \fBhmac\fP is the name of the key algorithm; @@ -225,17 +257,23 @@ abbreviation is unambiguous; for example, \fB+cd\fP is equivalent to \fB+cdflag\fP\&. The query options are: .INDENT 0.0 .TP -.B \fB+[no]aaflag\fP +.B +[no]aaflag This option is a synonym for \fB+[no]aaonly\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]aaonly\fP +.B +[no]aaonly This option sets the \fBaa\fP flag in the query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]additional\fP +.B +[no]additional This option displays [or does not display] the additional section of a reply. The default is to display it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]adflag\fP +.B +[no]adflag 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 been validated as secure, according to the security @@ -243,45 +281,65 @@ policy of the server. \fBAD=1\fP indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range. \fBAD=0\fP indicates that some part of the answer was insecure or not validated. This bit is set by default. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]all\fP +.B +[no]all This option sets or clears all display flags. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]answer\fP +.B +[no]answer This option displays [or does not display] the answer section of a reply. The default is to display it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]authority\fP +.B +[no]authority This option displays [or does not display] the authority section of a reply. The default is to display it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]badcookie\fP +.B +[no]badcookie This option retries the lookup with a new server cookie if a BADCOOKIE response is received. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]besteffort\fP +.B +[no]besteffort This option attempts to display the contents of messages which are malformed. The default is to not display malformed answers. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+bufsize[=B]\fP +.B +bufsize[=B] This option sets the UDP message buffer size advertised using EDNS0 to \fBB\fP bytes. The maximum and minimum sizes of this buffer are 65535 and 0, respectively. \fB+bufsize\fP restores the default buffer size. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]cdflag\fP +.B +[no]cdflag 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]class\fP +.B +[no]class This option displays [or does not display] the CLASS when printing the record. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]cmd\fP +.B +[no]cmd This option toggles the printing of the initial comment in the output, identifying the version of \fBdig\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]comments\fP +.B +[no]comments 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. @@ -289,79 +347,109 @@ 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 \fB+[no]cmd\fP, \fB+[no]question\fP, \fB+[no]stats\fP, and \fB+[no]rrcomments\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]cookie=####\fP +.B +[no]cookie=#### 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 \fB+cookie\fP\&. .sp \fB+cookie\fP is also set when \fB+trace\fP is set to better emulate the default queries from a nameserver. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]crypto\fP +.B +[no]crypto 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 \fB[omitted]\fP or, in the DNSKEY case, the key ID is displayed as the replacement, e.g. \fB[ key id = value ]\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]defname\fP +.B +[no]defname This option, which is deprecated, is treated as a synonym for \fB+[no]search\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]dns64prefix\fP +.B +[no]dns64prefix Lookup IPV4ONLY.ARPA AAAA and print any DNS64 prefixes found. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]dnssec\fP +.B +[no]dnssec 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+domain=somename\fP +.B +domain=somename This option sets the search list to contain the single domain \fBsomename\fP, as if specified in a \fBdomain\fP directive in \fB/etc/resolv.conf\fP, and enables search list processing as if the \fB+search\fP option were given. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+dscp=value\fP +.B +dscp=value 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]edns[=#]\fP +.B +[no]edns[=#] 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. \fB+noedns\fP clears the remembered EDNS version. EDNS is set to 0 by default. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ednsflags[=#]\fP +.B +[no]ednsflags[=#] 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ednsnegotiation\fP +.B +[no]ednsnegotiation This option enables/disables EDNS version negotiation. By default, EDNS version negotiation is enabled. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ednsopt[=code[:value]]\fP +.B +[no]ednsopt[=code[:value]] This option specifies the EDNS option with code point \fBcode\fP and an optional payload of \fBvalue\fP as a hexadecimal string. \fBcode\fP can be either an EDNS option name (for example, \fBNSID\fP or \fBECS\fP) or an arbitrary numeric value. \fB+noednsopt\fP clears the EDNS options to be sent. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]expire\fP +.B +[no]expire This option sends an EDNS Expire option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]fail\fP +.B +[no]fail This option indicates that \fBnamed\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]header\-only\fP +.B +[no]header\-only 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]https[=value]\fP +.B +[no]https[=value] This option indicates whether to use DNS over HTTPS (DoH) when querying name servers. When this option is in use, the port number defaults to 443. The HTTP POST request mode is used when sending the query. @@ -369,65 +457,91 @@ The HTTP POST request mode is used when sending the query. If \fBvalue\fP is specified, it will be used as the HTTP endpoint in the query URI; the default is \fB/dns\-query\fP\&. So, for example, \fBdig @example.com +https\fP will use the URI \fBhttps://example.com/dns\-query\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]https\-get[=value]\fP +.B +[no]https\-get[=value] Similar to \fB+https\fP, except that the HTTP GET request mode is used when sending the query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]https\-post[=value]\fP +.B +[no]https\-post[=value] Same as \fB+https\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]http\-plain[=value]\fP +.B +[no]http\-plain[=value] Similar to \fB+https\fP, except that HTTP queries will be sent over a non\-encrypted channel. When this option is in use, the port number defaults to 80 and the HTTP request mode is POST. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]http\-plain\-get[=value]\fP +.B +[no]http\-plain\-get[=value] Similar to \fB+http\-plain\fP, except that the HTTP request mode is GET. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]http\-plain\-post[=value]\fP +.B +[no]http\-plain\-post[=value] Same as \fB+http\-plain\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]identify\fP +.B +[no]identify This option shows [or does not show] the IP address and port number that supplied the answer, when the \fB+short\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]idnin\fP +.B +[no]idnin This option processes [or does not process] IDN domain names on input. This requires \fBIDN SUPPORT\fP to have been enabled at compile time. .sp The default is to process IDN input when standard output is a tty. The IDN processing on input is disabled when \fBdig\fP output is redirected to files, pipes, and other non\-tty file descriptors. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]idnout\fP +.B +[no]idnout This option converts [or does not convert] puny code on output. This requires \fBIDN SUPPORT\fP to have been enabled at compile time. .sp The default is to process puny code on output when standard output is a tty. The puny code processing on output is disabled when \fBdig\fP output is redirected to files, pipes, and other non\-tty file descriptors. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ignore\fP +.B +[no]ignore This option ignores [or does not ignore] truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]keepalive\fP +.B +[no]keepalive This option sends [or does not send] an EDNS Keepalive option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]keepopen\fP +.B +[no]keepopen 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 \fB+nokeepopen\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]multiline\fP +.B +[no]multiline 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 \fBdig\fP output. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+ndots=D\fP +.B +ndots=D This option sets the number of dots (\fBD\fP) that must appear in \fBname\fP for it to be considered absolute. The default value is that defined using the \fBndots\fP statement in \fB/etc/resolv.conf\fP, or 1 if no \fBndots\fP @@ -435,25 +549,35 @@ statement is present. Names with fewer dots are interpreted as relative names, and are searched for in the domains listed in the \fBsearch\fP or \fBdomain\fP directive in \fB/etc/resolv.conf\fP if \fB+search\fP is set. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]nsid\fP +.B +[no]nsid When enabled, this option includes an EDNS name server ID request when sending a query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]nssearch\fP +.B +[no]nssearch When this option is set, \fBdig\fP attempts to find the authoritative 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 did not respond are also printed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]onesoa\fP +.B +[no]onesoa 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]opcode=value\fP +.B +[no]opcode=value When enabled, this option sets (restores) the DNS message opcode to the specified value. The default value is QUERY (0). +.UNINDENT +.INDENT 0.0 .TP -.B \fB+padding=value\fP +.B +padding=value This option pads the size of the query packet using the EDNS Padding option to blocks of \fBvalue\fP bytes. For example, \fB+padding=32\fP causes a 48\-byte query to be padded to 64 bytes. The default block size is 0, @@ -461,43 +585,61 @@ 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+qid=value\fP +.B +qid=value This option specifies the query ID to use when sending queries. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]qr\fP +.B +[no]qr This option toggles the display of the query message as it is sent. By default, the query is not printed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]question\fP +.B +[no]question 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]raflag\fP +.B +[no]raflag This option sets [or does not set] the RA (Recursion Available) bit in the query. The default is \fB+noraflag\fP\&. This bit is ignored by the server for QUERY. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]rdflag\fP +.B +[no]rdflag This option is a synonym for \fB+[no]recurse\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]recurse\fP +.B +[no]recurse This option toggles the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means \fBdig\fP normally sends recursive queries. Recursion is automatically disabled when the \fB+nssearch\fP or \fB+trace\fP query option is used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+retry=T\fP +.B +retry=T This option sets the number of times to retry UDP and TCP queries to server to \fBT\fP instead of the default, 2. Unlike \fB+tries\fP, this does not include the initial query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]rrcomments\fP +.B +[no]rrcomments 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]search\fP +.B +[no]search This option uses [or does not use] the search list defined by the searchlist or domain directive in \fBresolv.conf\fP, if any. The search list is not used by default. @@ -505,37 +647,51 @@ default. \fBndots\fP from \fBresolv.conf\fP (default 1), which may be overridden by \fB+ndots\fP, determines whether the name is treated as relative and hence whether a search is eventually performed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]short\fP +.B +[no]short 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]showbadcookie\fP +.B +[no]showbadcookie This option toggles whether to show the message containing the BADCOOKIE rcode before retrying the request or not. The default is to not show the messages. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]showsearch\fP +.B +[no]showsearch This option performs [or does not perform] a search showing intermediate results. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]sigchase\fP +.B +[no]sigchase This feature is now obsolete and has been removed; use \fBdelv\fP instead. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+split=W\fP +.B +split=W This option splits long hex\- or base64\-formatted fields in resource records into chunks of \fBW\fP characters (where \fBW\fP is rounded up to the nearest multiple of 4). \fB+nosplit\fP or \fB+split=0\fP causes fields not to be split at all. The default is 56 characters, or 44 characters when multiline mode is active. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]stats\fP +.B +[no]stats 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]subnet=addr[/prefix\-length]\fP +.B +[no]subnet=addr[/prefix\-length] This option sends [or does not send] an EDNS CLIENT\-SUBNET option with the specified IP address or network prefix. .sp @@ -543,31 +699,43 @@ address or network prefix. sends an EDNS CLIENT\-SUBNET option with an empty address and a source prefix\-length of zero, which signals a resolver that the client\(aqs address information must \fInot\fP be used when resolving this query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]tcflag\fP +.B +[no]tcflag This option sets [or does not set] the TC (TrunCation) bit in the query. The default is \fB+notcflag\fP\&. This bit is ignored by the server for QUERY. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]tcp\fP +.B +[no]tcp This option indicates whether to use TCP when querying name servers. The default behavior is to use UDP unless a type \fBany\fP or \fBixfr=N\fP query is requested, in which case the default is TCP. AXFR queries always use TCP. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+timeout=T\fP +.B +timeout=T This option sets the timeout for a query to \fBT\fP seconds. The default timeout is 5 seconds. An attempt to set \fBT\fP to less than 1 is silently set to 1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]tls\fP +.B +[no]tls This option indicates whether to use DNS over TLS (DoT) when querying name servers. When this option is in use, the port number defaults to 853. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]topdown\fP +.B +[no]topdown This feature is related to \fBdig +sigchase\fP, which is obsolete and has been removed. Use \fBdelv\fP instead. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]trace\fP +.B +[no]trace 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, \fBdig\fP makes iterative queries to resolve the @@ -580,39 +748,55 @@ the root zone name servers. .sp \fB+dnssec\fP is also set when \fB+trace\fP is set, to better emulate the default queries from a name server. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+tries=T\fP +.B +tries=T This option sets the number of times to try UDP and TCP queries to server to \fBT\fP instead of the default, 3. If \fBT\fP is less than or equal to zero, the number of tries is silently rounded up to 1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+trusted\-key=####\fP +.B +trusted\-key=#### This option formerly specified trusted keys for use with \fBdig +sigchase\fP\&. This feature is now obsolete and has been removed; use \fBdelv\fP instead. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ttlid\fP +.B +[no]ttlid This option displays [or does not display] the TTL when printing the record. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ttlunits\fP +.B +[no]ttlunits This option displays [or does not display] the TTL in friendly human\-readable time units of \fBs\fP, \fBm\fP, \fBh\fP, \fBd\fP, and \fBw\fP, representing seconds, minutes, hours, days, and weeks. This implies \fB+ttlid\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]unknownformat\fP +.B +[no]unknownformat This option prints all RDATA in unknown RR type presentation format (\fI\%RFC 3597\fP). The default is to print RDATA for known types in the type\(aqs presentation format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]vc\fP +.B +[no]vc This option uses [or does not use] TCP when querying name servers. This alternate syntax to \fB+[no]tcp\fP is provided for backwards compatibility. The \fBvc\fP stands for "virtual circuit." +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]yaml\fP +.B +[no]yaml When enabled, this option prints the responses (and, if \fB+qr\fP is in use, also the outgoing queries) in a detailed YAML format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]zflag\fP +.B +[no]zflag This option sets [or does not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. .UNINDENT diff --git a/doc/man/dnssec-cds.1in b/doc/man/dnssec-cds.1in index a7b097f182..a06a8fffdd 100644 --- a/doc/man/dnssec-cds.1in +++ b/doc/man/dnssec-cds.1in @@ -85,7 +85,7 @@ maintain a \fBdsset\-\fP file as well as emit an \fBnsupdate\fP script. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a algorithm\fP +.B \-a algorithm When converting CDS records to DS records, this option specifies the acceptable digest algorithms. This option can be repeated, so that multiple digest types are allowed. If none of the CDS records @@ -99,16 +99,22 @@ are created for each CDNSKEY records. 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 is specified, the default is SHA\-256 only. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option specifies the DNS class of the zones. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D\fP +.B \-D This option generates DS records from CDNSKEY records if both CDS and CDNSKEY records are present in the child zone. By default CDS records are preferred. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d path\fP +.B \-d path This specifies the location of the parent DS records. The path can be the name of a file containing the DS records; if it is a directory, \fBdnssec\-cds\fP looks for a \fBdsset\-\fP file for the domain inside the directory. @@ -116,15 +122,19 @@ looks for a \fBdsset\-\fP file for the domain inside the directory. To protect against replay attacks, child records are rejected if they were signed earlier than the modification time of the \fBdsset\-\fP file. This can be adjusted with the \fB\-s\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f child\-file\fP +.B \-f child\-file This option specifies the file containing the child\(aqs CDS and/or CDNSKEY records, plus its DNSKEY records and the covering RRSIG records, so that they can be authenticated. .sp The examples below describe how to generate this file. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-iextension\fP +.B \-iextension This option updates the \fBdsset\-\fP file in place, instead of writing DS records to the standard output. .sp @@ -137,8 +147,10 @@ To protect against replay attacks, the modification time of the \fBdsset\-\fP file is set to match the signature inception time of the child records, provided that it is later than the file\(aqs current modification time. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s start\-time\fP +.B \-s start\-time This option specifies the date and time after which RRSIG records become acceptable. This can be either an absolute or a relative time. An absolute start time is indicated by a number in YYYYMMDDHHMMSS @@ -149,13 +161,17 @@ current time is indicated with \fBnow+N\fP\&. .sp If no start\-time is specified, the modification time of the \fBdsset\-\fP file is used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T ttl\fP +.B \-T ttl This option specifies a TTL to be used for new DS records. If not specified, the default is the TTL of the old DS records. If they had no explicit TTL, the new DS records also have no explicit TTL. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u\fP +.B \-u This option writes an \fBnsupdate\fP script to the standard output, instead of printing the new DS reords. The output is empty if no change is needed. @@ -163,13 +179,19 @@ needed. Note: The TTL of new records needs to be specified: it can be done in the original \fBdsset\-\fP file, with the \fB\-T\fP option, or using the \fBnsupdate\fP \fBttl\fP command. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. Level 1 is intended to be usefully verbose for general users; higher levels are intended for developers. +.UNINDENT +.INDENT 0.0 .TP .B \fBdomain\fP This indicates the name of the delegation point/child zone apex. diff --git a/doc/man/dnssec-dsfromkey.1in b/doc/man/dnssec-dsfromkey.1in index 2394f75a1b..12668866c9 100644 --- a/doc/man/dnssec-dsfromkey.1in +++ b/doc/man/dnssec-dsfromkey.1in @@ -61,13 +61,17 @@ as generated by \fBdnssec\-keygen\fP \fB\-C\fP\&. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-1\fP +.B \-1 This option is an abbreviation for \fB\-a SHA1\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-2\fP +.B \-2 This option is an abbreviation for \fB\-a SHA\-256\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-a algorithm\fP +.B \-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. @@ -75,20 +79,28 @@ 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 is specified, the default is SHA\-256. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A\fP +.B \-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 \fB\-f\fP zone file mode. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option specifies the DNS class; the default is IN. This option is only useful in \fB\-s\fP keyset or \fB\-f\fP zone file mode. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP +.B \-C This option generates CDS records rather than DS records. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f file\fP +.B \-f file This option sets zone file mode, in which the final dnsname argument of \fBdnssec\-dsfromkey\fP is the DNS domain name of a zone whose master file can be read from \fBfile\fP\&. If the zone name is the same as \fBfile\fP, then it may be @@ -99,24 +111,36 @@ input. This makes it possible to use the output of the \fBdig\fP command as input, as in: .sp \fBdig dnskey example.com | dnssec\-dsfromkey \-f \- example.com\fP +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints usage information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option tells BIND 9 to look for key files or \fBkeyset\-\fP files in \fBdirectory\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s\fP +.B \-s This option enables keyset mode, in which the final dnsname argument from \fBdnssec\-dsfromkey\fP is the DNS domain name used to locate a \fBkeyset\-\fP file. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T TTL\fP +.B \-T TTL This option specifies the TTL of the DS records. By default the TTL is omitted. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. .UNINDENT .SH EXAMPLE diff --git a/doc/man/dnssec-importkey.1in b/doc/man/dnssec-importkey.1in index 22d85f36d8..29ddda79ee 100644 --- a/doc/man/dnssec-importkey.1in +++ b/doc/man/dnssec-importkey.1in @@ -51,7 +51,7 @@ DNSKEY RRset on schedule even if the true private key is stored offline. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-f filename\fP +.B \-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 \fBfilename\fP\&. If the domain name is the same as \fBfilename\fP, then it may be @@ -59,24 +59,34 @@ omitted. .sp If \fBfilename\fP is set to \fB"\-"\fP, then the zone data is read from the standard input. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option sets the directory in which the key files are to reside. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L ttl\fP +.B \-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 \fB0\fP or \fBnone\fP removes it from the key. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option emits a usage message and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. .UNINDENT .SH TIMING OPTIONS @@ -91,21 +101,27 @@ respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use \fBnone\fP or \fBnever\fP\&. .INDENT 0.0 .TP -.B \fB\-P date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P sync date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D date/offset\fP +.B \-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.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D sync date/offset\fP +.B \-D sync date/offset This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. .UNINDENT diff --git a/doc/man/dnssec-keyfromlabel.1in b/doc/man/dnssec-keyfromlabel.1in index 22ad8cec0c..cc9aab63e0 100644 --- a/doc/man/dnssec-keyfromlabel.1in +++ b/doc/man/dnssec-keyfromlabel.1in @@ -47,7 +47,7 @@ match the name of the zone for which the key is being generated. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a algorithm\fP +.B \-a algorithm This option selects the cryptographic algorithm. The value of \fBalgorithm\fP must be one of RSASHA1, NSEC3RSASHA1, RSASHA256, RSASHA512, ECDSAP256SHA256, ECDSAP384SHA384, ED25519, or ED448. @@ -66,64 +66,88 @@ option, then NSEC3RSASHA1 is used instead. Since BIND 9.12.0, this option is mandatory except when using the \fB\-S\fP option, which copies the algorithm from the predecessory key. Previously, the default for newly generated keys was RSASHA1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-3\fP +.B \-3 This option uses an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version is used; for example, \fBdnssec\-keygen \-3a RSASHA1\fP specifies the NSEC3RSASHA1 algorithm. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\fP +.B \-E engine This option specifies the cryptographic hardware to use. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually \fBpkcs11\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l label\fP +.B \-l label This option specifies the label for a key pair in the crypto hardware. .sp When BIND 9 is built with OpenSSL\-based PKCS#11 support, the label is an arbitrary string that identifies a particular key. It may be preceded by an optional OpenSSL engine name, followed by a colon, as in \fBpkcs11:keylabel\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-n nametype\fP +.B \-n nametype This option specifies the owner type of the key. The value of \fBnametype\fP must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user (KEY)), or OTHER (DNSKEY). These values are case\-insensitive. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP +.B \-C This option enables compatibility mode, which generates an old\-style key, without any metadata. By default, \fBdnssec\-keyfromlabel\fP includes the key\(aqs creation date in the metadata stored with the private key; other dates may be set there as well, including publication date, activation date, etc. Keys that include this data may be incompatible with older versions of BIND; the \fB\-C\fP option suppresses them. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f flag\fP +.B \-f flag This option sets the specified flag in the \fBflag\fP field of the KEY/DNSKEY record. The only recognized flags are KSK (Key\-Signing Key) and REVOKE. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-G\fP +.B \-G This option generates a key, but does not publish it or sign with it. This option is incompatible with \fB\-P\fP and \fB\-A\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints a short summary of the options and arguments to \fBdnssec\-keyfromlabel\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option sets the directory in which the key files are to be written. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k\fP +.B \-k This option generates KEY records rather than DNSKEY records. +.UNINDENT +.INDENT 0.0 .TP .B \fB\-L\fP ttl This option sets the default TTL to use for this key when it is converted into a @@ -131,33 +155,45 @@ 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 would take precedence. Setting the default TTL to \fB0\fP or \fBnone\fP removes it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p protocol\fP +.B \-p protocol This option sets the protocol value for the key. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in \fI\%RFC 2535\fP and its successors. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-S key\fP +.B \-S key This option generates a key as an explicit successor to an existing key. The name, algorithm, size, and type of the key are set to match the predecessor. The activation date of the new key is set to the inactivation date of the existing one. The publication date is set to the activation date minus the prepublication interval, which defaults to 30 days. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t type\fP +.B \-t type This option indicates the type of the key. \fBtype\fP must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF to the ability to encrypt data. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-y\fP +.B \-y This option allows DNSSEC key files to be generated even if the key ID would collide with that of an existing key, in the event of either key being revoked. (This is only safe to enable if @@ -176,41 +212,55 @@ respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use \fBnone\fP or \fBnever\fP\&. .INDENT 0.0 .TP -.B \fB\-P date/offset\fP +.B \-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. If not set, and if the \fB\-G\fP option has not been used, the default is the current date. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P sync date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A date/offset\fP +.B \-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. If not set, and if the \fB\-G\fP option has not been used, the default is the current date. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-R date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-I date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D date/offset\fP +.B \-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.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D sync date/offset\fP +.B \-D sync date/offset This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i interval\fP +.B \-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 diff --git a/doc/man/dnssec-keygen.1in b/doc/man/dnssec-keygen.1in index 5b96ab25bd..55f1e9a987 100644 --- a/doc/man/dnssec-keygen.1in +++ b/doc/man/dnssec-keygen.1in @@ -46,13 +46,15 @@ generated. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-3\fP +.B \-3 This option uses an NSEC3\-capable algorithm to generate a DNSSEC key. If this option is used with an algorithm that has both NSEC and NSEC3 versions, then the NSEC3 version is selected; for example, \fBdnssec\-keygen \-3a RSASHA1\fP specifies the NSEC3RSASHA1 algorithm. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-a algorithm\fP +.B \-a algorithm This option selects the cryptographic algorithm. For DNSSEC keys, the value of \fBalgorithm\fP must be one of RSASHA1, NSEC3RSASHA1, RSASHA256, RSASHA512, ECDSAP256SHA256, ECDSAP384SHA384, ED25519, or ED448. For @@ -70,8 +72,10 @@ option, which copies the algorithm from the predecessor key. In prior releases, HMAC algorithms could be generated for use as TSIG keys, but that feature was removed in BIND 9.13.0. Use \fBtsig\-keygen\fP to generate TSIG keys. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-b keysize\fP +.B \-b keysize This option specifies the number of bits in the key. The choice of key size depends on the algorithm used: RSA keys must be between 1024 and 4096 bits; Diffie\-Hellman keys must be between 128 and 4096 bits. Elliptic @@ -81,53 +85,73 @@ If the key size is not specified, some algorithms have pre\-defined defaults. For example, RSA keys for use as DNSSEC zone\-signing keys have a default size of 1024 bits; RSA keys for use as key\-signing keys (KSKs, generated with \fB\-f KSK\fP) default to 2048 bits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP +.B \-C This option enables compatibility mode, which generates an old\-style key, without any timing metadata. By default, \fBdnssec\-keygen\fP includes the key\(aqs creation date in the metadata stored with the private key; other dates may be set there as well, including publication date, activation date, etc. Keys that include this data may be incompatible with older versions of BIND; the \fB\-C\fP option suppresses them. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option indicates that the DNS record containing the key should have the specified class. If not specified, class IN is used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d bits\fP +.B \-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, ECDSAP384SHA384, ED25519, and ED448. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\fP +.B \-E engine This option specifies the cryptographic hardware to use, when applicable. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually \fBpkcs11\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f flag\fP +.B \-f flag This option sets the specified flag in the flag field of the KEY/DNSKEY record. The only recognized flags are KSK (Key\-Signing Key) and REVOKE. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-G\fP +.B \-G This option generates a key, but does not publish it or sign with it. This option is incompatible with \fB\-P\fP and \fB\-A\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-g generator\fP +.B \-g generator This option indicates the generator to use if generating a Diffie\-Hellman key. Allowed values are 2 and 5. If no generator is specified, a known prime from \fI\%RFC 2539\fP is used if possible; otherwise the default is 2. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints a short summary of the options and arguments to \fBdnssec\-keygen\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option sets the directory in which the key files are to be written. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k policy\fP +.B \-k policy This option creates keys for a specific \fBdnssec\-policy\fP\&. If a policy uses multiple keys, \fBdnssec\-keygen\fP generates multiple keys. This also creates a ".state" file to keep track of the key state. @@ -135,8 +159,10 @@ creates a ".state" file to keep track of the key state. This option creates keys according to the \fBdnssec\-policy\fP configuration, hence it cannot be used at the same time as many of the other options that \fBdnssec\-keygen\fP provides. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L ttl\fP +.B \-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 @@ -144,25 +170,33 @@ 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 \fB0\fP or \fBnone\fP is the same as leaving it unset. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l file\fP +.B \-l file This option provides a configuration file that contains a \fBdnssec\-policy\fP statement (matching the policy set with \fB\-k\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-n nametype\fP +.B \-n nametype This option specifies the owner type of the key. The value of \fBnametype\fP must either be ZONE (for a DNSSEC zone key (KEY/DNSKEY)), HOST or ENTITY (for a key associated with a host (KEY)), USER (for a key associated with a user (KEY)), or OTHER (DNSKEY). These values are case\-insensitive. The default is ZONE for DNSKEY generation. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p protocol\fP +.B \-p protocol This option sets the protocol value for the generated key, for use with \fB\-T KEY\fP\&. The protocol is a number between 0 and 255. The default is 3 (DNSSEC). Other possible values for this argument are listed in \fI\%RFC 2535\fP and its successors. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option sets quiet mode, which suppresses unnecessary output, including progress indication. Without this option, when \fBdnssec\-keygen\fP is run interactively to generate an RSA or DSA key pair, it prints a @@ -171,35 +205,47 @@ generation. A \fB\&.\fP indicates that a random number has been found which passed an initial sieve test; \fB+\fP means a number has passed a single round of the Miller\-Rabin primality test; and a space ( ) means that the number has passed all the tests and is a satisfactory key. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-S key\fP +.B \-S key This option creates a new key which is an explicit successor to an existing key. The name, algorithm, size, and type of the key are set to match the existing key. The activation date of the new key is set to the inactivation date of the existing one. The publication date is set to the activation date minus the prepublication interval, which defaults to 30 days. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s strength\fP +.B \-s strength This option specifies the strength value of the key. The strength is a number between 0 and 15, and currently has no defined purpose in DNSSEC. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T rrtype\fP +.B \-T rrtype This option specifies the resource record type to use for the key. \fBrrtype\fP must be either DNSKEY or KEY. The default is DNSKEY when using a DNSSEC algorithm, but it can be overridden to KEY for use with SIG(0). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t type\fP +.B \-t type This option indicates the type of the key for use with \fB\-T KEY\fP\&. \fBtype\fP must be one of AUTHCONF, NOAUTHCONF, NOAUTH, or NOCONF. The default is AUTHCONF. AUTH refers to the ability to authenticate data, and CONF to the ability to encrypt data. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. .UNINDENT .SH TIMING OPTIONS @@ -214,43 +260,57 @@ respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use \fBnone\fP or \fBnever\fP\&. .INDENT 0.0 .TP -.B \fB\-P date/offset\fP +.B \-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. If not set, and if the \fB\-G\fP option has not been used, the default is the current date. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P sync date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A date/offset\fP +.B \-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. If not set, and if the \fB\-G\fP option has not been used, the default is the current date. If set, and \fB\-P\fP is not set, the publication date is set to the activation date minus the prepublication interval. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-R date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-I date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D date/offset\fP +.B \-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.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D sync date/offset\fP +.B \-D sync date/offset This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i interval\fP +.B \-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 diff --git a/doc/man/dnssec-revoke.1in b/doc/man/dnssec-revoke.1in index e4910734c9..65bf06a4e0 100644 --- a/doc/man/dnssec-revoke.1in +++ b/doc/man/dnssec-revoke.1in @@ -41,34 +41,48 @@ containing the now\-revoked key. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option emits a usage message and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option sets the directory in which the key files are to reside. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r\fP +.B \-r This option indicates to remove the original keyset files after writing the new keyset files. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\fP +.B \-E engine This option specifies the cryptographic hardware to use, when applicable. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually \fBpkcs11\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f\fP +.B \-f This option indicates a forced overwrite and causes \fBdnssec\-revoke\fP to write the new key pair, even if a file already exists matching the algorithm and key ID of the revoked key. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-R\fP +.B \-R This option prints the key tag of the key with the REVOKE bit set, but does not revoke the key. .UNINDENT diff --git a/doc/man/dnssec-settime.1in b/doc/man/dnssec-settime.1in index af92c1a9c1..c396220d87 100644 --- a/doc/man/dnssec-settime.1in +++ b/doc/man/dnssec-settime.1in @@ -69,7 +69,7 @@ purposes. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-f\fP +.B \-f This option forces an update of an old\-format key with no metadata fields. Without this option, \fBdnssec\-settime\fP fails when attempting to update a legacy key. With this option, the key is recreated in the new @@ -77,11 +77,15 @@ format, but with the original key data retained. The key\(aqs creation date is set to the present time. If no other values are specified, then the key\(aqs publication and activation dates are also set to the present time. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option sets the directory in which the key files are to reside. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L ttl\fP +.B \-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 @@ -89,17 +93,25 @@ 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 \fB0\fP or \fBnone\fP removes it from the key. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option emits a usage message and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\fP +.B \-E engine This option specifies the cryptographic hardware to use, when applicable. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL @@ -118,55 +130,75 @@ respectively. Without a suffix, the offset is computed in seconds. To explicitly prevent a date from being set, use \fBnone\fP or \fBnever\fP\&. .INDENT 0.0 .TP -.B \fB\-P date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P ds date/offset\fP +.B \-P ds date/offset This option sets the date on which DS records that match this key have been seen in the parent zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P sync date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-R date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-I date/offset\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D date/offset\fP +.B \-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.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D ds date/offset\fP +.B \-D ds date/offset This option sets the date on which the DS records that match this key have been seen removed from the parent zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D sync date/offset\fP +.B \-D sync date/offset This option sets the date on which the CDS and CDNSKEY records that match this key are to be deleted. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-S predecessor key\fP +.B \-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 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i interval\fP +.B \-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 @@ -193,22 +225,32 @@ purpose, but should never be used in production. Known key states are HIDDEN, RUMOURED, OMNIPRESENT, and UNRETENTIVE. .INDENT 0.0 .TP -.B \fB\-s\fP +.B \-s This option indicates that when setting key timing data, the state file should also be updated. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-g state\fP +.B \-g state This option sets the goal state for this key. Must be HIDDEN or OMNIPRESENT. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d state date/offset\fP +.B \-d state date/offset This option sets the DS state for this key as of the specified date, offset from the current date. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k state date/offset\fP +.B \-k state date/offset This option sets the DNSKEY state for this key as of the specified date, offset from the current date. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r state date/offset\fP +.B \-r state date/offset This option sets the RRSIG (KSK) state for this key as of the specified date, offset from the current date. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-z state date/offset\fP +.B \-z state date/offset This option sets the RRSIG (ZSK) state for this key as of the specified date, offset from the current date. .UNINDENT .SH PRINTING OPTIONS @@ -217,10 +259,12 @@ This option sets the RRSIG (ZSK) state for this key as of the specified date, of associated with a key. .INDENT 0.0 .TP -.B \fB\-u\fP +.B \-u This option indicates that times should be printed in Unix epoch format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p C/P/Pds/Psync/A/R/I/D/Dds/Dsync/all\fP +.B \-p C/P/Pds/Psync/A/R/I/D/Dds/Dsync/all This option prints a specific metadata value or set of metadata values. The \fB\-p\fP option may be followed by one or more of the following letters or strings to indicate which value or values to print: \fBC\fP for the diff --git a/doc/man/dnssec-signzone.1in b/doc/man/dnssec-signzone.1in index a04e31a7fe..759efd5feb 100644 --- a/doc/man/dnssec-signzone.1in +++ b/doc/man/dnssec-signzone.1in @@ -43,49 +43,67 @@ file for each child zone. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a\fP +.B \-a This option verifies all generated signatures. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option specifies the DNS class of the zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP +.B \-C This option sets compatibility mode, in which a \fBkeyset\-zonename\fP file is generated in addition to \fBdsset\-zonename\fP when signing a zone, for use by older versions of \fBdnssec\-signzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d directory\fP +.B \-d directory This option indicates the directory where BIND 9 should look for \fBdsset\-\fP or \fBkeyset\-\fP files. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D\fP +.B \-D This option indicates that only those record types automatically managed by \fBdnssec\-signzone\fP, i.e., RRSIG, NSEC, NSEC3 and NSEC3PARAM records, should be included in the output. If smart signing (\fB\-S\fP) is used, DNSKEY records are also included. The resulting file can be included in the original zone file with \fB$INCLUDE\fP\&. This option cannot be combined with \fB\-O raw\fP or serial\-number updating. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\fP +.B \-E engine This option specifies the hardware to use for cryptographic operations, such as a secure key store used for signing, when applicable. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually \fBpkcs11\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-g\fP +.B \-g This option indicates that DS records for child zones should be generated from a \fBdsset\-\fP or \fBkeyset\-\fP file. Existing DS records are removed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-K directory\fP +.B \-K directory This option specifies the directory to search for DNSSEC keys. If not specified, it defaults to the current directory. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k key\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-M maxttl\fP +.B \-M maxttl This option sets the maximum TTL for the signed zone. Any TTL higher than \fBmaxttl\fP in the input zone is reduced to \fBmaxttl\fP in the output. This provides certainty as to the largest possible TTL in the signed zone, @@ -95,8 +113,10 @@ expire from resolver caches. Zones that are signed with this option should be configured to use a matching \fBmax\-zone\-ttl\fP in \fBnamed.conf\fP\&. (Note: This option is incompatible with \fB\-D\fP, because it modifies non\-DNSSEC data in the output zone.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s start\-time\fP +.B \-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; @@ -104,8 +124,10 @@ start time is indicated by a number in YYYYMMDDHHMMSS notation; start time is indicated by \fB+N\fP, which is N seconds from the current time. If no \fBstart\-time\fP is specified, the current time minus 1 hour (to allow for clock skew) is used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-e end\-time\fP +.B \-e end\-time This option specifies the date and time when the generated RRSIG records expire. As with \fBstart\-time\fP, an absolute time is indicated in YYYYMMDDHHMMSS notation. A time relative to the start time is indicated with \fB+N\fP, @@ -113,8 +135,10 @@ which is N seconds from the start time. A time relative to the current time is indicated with \fBnow+N\fP\&. If no \fBend\-time\fP is specified, 30 days from the start time is the default. \fBend\-time\fP must be later than \fBstart\-time\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-X extended end\-time\fP +.B \-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; @@ -128,21 +152,29 @@ relative to the current time is indicated with \fBnow+N\fP\&. If no \fBextended end\-time\fP is specified, the value of \fBend\-time\fP is used as the default. (\fBend\-time\fP, in turn, defaults to 30 days from the start time.) \fBextended end\-time\fP must be later than \fBstart\-time\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f output\-file\fP +.B \-f output\-file This option indicates the name of the output file containing the signed zone. The default is to append \fB\&.signed\fP to the input filename. If \fBoutput\-file\fP is set to \fB\-\fP, then the signed zone is written to the standard output, with a default output format of \fBfull\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints a short summary of the options and arguments to \fBdnssec\-signzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i interval\fP +.B \-i interval This option indicates that, when a previously signed zone is passed as input, records may be re\-signed. The \fBinterval\fP option specifies the cycle interval as an offset from the current time, in seconds. If a RRSIG record expires @@ -155,15 +187,19 @@ the signature end and start times. So if neither \fBend\-time\fP nor 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 are replaced. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-I input\-format\fP +.B \-I input\-format This option sets the format of the input zone file. Possible formats are \fBtext\fP (the default), and \fBraw\fP\&. 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. This option is not useful for non\-dynamic zones. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-j jitter\fP +.B \-j jitter When signing a zone with a fixed signature lifetime, all RRSIG records issued at the time of signing expire simultaneously. If the zone is incrementally signed, i.e., a previously signed zone is passed @@ -177,17 +213,23 @@ 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L serial\fP +.B \-L serial When writing a signed zone to "raw" format, this option sets the "source serial" value in the header to the specified \fBserial\fP number. (This is expected to be used primarily for testing purposes.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-n ncpus\fP +.B \-n ncpus This option specifies the number of threads to use. By default, one thread is started for each detected CPU. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-N soa\-serial\-format\fP +.B \-N soa\-serial\-format This option sets the SOA serial number format of the signed zone. Possible formats are \fBkeep\fP (the default), \fBincrement\fP, \fBunixtime\fP, and \fBdate\fP\&. @@ -211,12 +253,16 @@ YYYYMMDDNN format, unless the serial number is already greater than or equal to that value, in which case it is simply incremented by one. .UNINDENT +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-o origin\fP +.B \-o origin This option sets the zone origin. If not specified, the name of the zone file is assumed to be the origin. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-O output\-format\fP +.B \-O output\-format This option sets the format of the output file containing the signed zone. Possible formats are \fBtext\fP (the default), which is the standard textual representation of the zone; \fBfull\fP, which is text output in a @@ -225,16 +271,20 @@ format suitable for processing by external scripts; and \fBraw\fP and \fBnamed\fP\&. \fBraw=N\fP specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of \fBnamed\fP; if N is 1, the file can be read by release 9.9.0 or higher. The default is 1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P\fP +.B \-P This option disables post\-sign verification tests. .sp 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-Q\fP +.B \-Q This option removes signatures from keys that are no longer active. .sp Normally, when a previously signed zone is passed as input to the @@ -245,15 +295,19 @@ with cached copies of the old DNSKEY RRset. The \fB\-Q\fP option forces \fBdnssec\-signzone\fP to remove signatures from keys that are no longer active. This enables ZSK rollover using the procedure described in \fI\%RFC 4641#4.2.1.1\fP ("Pre\-Publish Key Rollover"). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option enables quiet mode, which suppresses unnecessary output. Without this option, when \fBdnssec\-signzone\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-R\fP +.B \-R This option removes signatures from keys that are no longer published. .sp This option is similar to \fB\-Q\fP, except it forces @@ -261,8 +315,10 @@ This option is similar to \fB\-Q\fP, except it forces published. This enables ZSK rollover using the procedure described in \fI\%RFC 4641#4.2.1.2\fP ("Double Signature Zone Signing Key Rollover"). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-S\fP +.B \-S This option enables smart signing, which instructs \fBdnssec\-signzone\fP to search the key repository for keys that match the zone being signed, and to include them in the zone if appropriate. @@ -297,8 +353,10 @@ If the key\(aqs sync deletion date is set and is in the past, synchronization records (type CDS and/or CDNSKEY) are removed. .UNINDENT .UNINDENT +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T ttl\fP +.B \-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\(aqs SOA record. This option is ignored when @@ -309,52 +367,72 @@ records\(aq 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t\fP +.B \-t This option prints statistics at completion. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u\fP +.B \-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 switched to NSEC or to NSEC3 with different parameters. Without this option, \fBdnssec\-signzone\fP retains the existing chain when re\-signing. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x\fP +.B \-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 \fBdnssec\-dnskey\-kskonly yes;\fP zone option in \fBnamed\fP\&.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-z\fP +.B \-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 \fBupdate\-check\-ksk no;\fP zone option in \fBnamed\fP\&.) +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-3 salt\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-H iterations\fP +.B \-H iterations This option indicates that, when generating an NSEC3 chain, BIND 9 should use this many iterations. The default is 10. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A\fP +.B \-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. .sp Using this option twice (i.e., \fB\-AA\fP) turns the OPTOUT flag off for all records. This is useful when using the \fB\-u\fP option to modify an NSEC3 chain which previously had OPTOUT set. +.UNINDENT +.INDENT 0.0 .TP -.B \fBzonefile\fP +.B zonefile This option sets the file containing the zone to be signed. +.UNINDENT +.INDENT 0.0 .TP -.B \fBkey\fP +.B 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 diff --git a/doc/man/dnssec-verify.1in b/doc/man/dnssec-verify.1in index 8ab9e81057..09392181d1 100644 --- a/doc/man/dnssec-verify.1in +++ b/doc/man/dnssec-verify.1in @@ -41,48 +41,64 @@ NSEC/NSEC3 chains are complete. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option specifies the DNS class of the zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\fP +.B \-E engine This option specifies the cryptographic hardware to use, when applicable. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually \fBpkcs11\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-I input\-format\fP +.B \-I input\-format This option sets the format of the input zone file. Possible formats are \fBtext\fP (the default) and \fBraw\fP\&. 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-o origin\fP +.B \-o origin This option indicates the zone origin. If not specified, the name of the zone file is assumed to be the origin. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v level\fP +.B \-v level This option sets the debugging level. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints version information. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option sets quiet mode, which suppresses output. Without this option, when \fBdnssec\-verify\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x\fP +.B \-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 \fB\-x\fP option in \fBdnssec\-signzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-z\fP +.B \-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 @@ -95,6 +111,8 @@ 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 \fB\-z\fP option in \fBdnssec\-signzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP .B \fBzonefile\fP This option indicates the file containing the zone to be signed. diff --git a/doc/man/dnstap-read.1in b/doc/man/dnstap-read.1in index 420c94b4b8..da8d01c250 100644 --- a/doc/man/dnstap-read.1in +++ b/doc/man/dnstap-read.1in @@ -42,18 +42,24 @@ longer and more detailed YAML format is used. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-m\fP +.B \-m This option indicates trace memory allocations, and is used for debugging memory leaks. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p\fP +.B \-p This option prints the text form of the DNS message that was encapsulated in the \fBdnstap\fP frame, after printing the \fBdnstap\fP data. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x\fP +.B \-x This option prints a hex dump of the wire form of the DNS message that was encapsulated in the \fBdnstap\fP frame, after printing the \fBdnstap\fP data. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-y\fP +.B \-y This option prints \fBdnstap\fP data in a detailed YAML format. .UNINDENT .SH SEE ALSO diff --git a/doc/man/host.1in b/doc/man/host.1in index 824b0cf9c4..4eaae39073 100644 --- a/doc/man/host.1in +++ b/doc/man/host.1in @@ -49,69 +49,95 @@ server or servers listed in \fB/etc/resolv.conf\fP\&. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option specifies that only IPv4 should be used for query transport. See also the \fB\-6\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option specifies that only IPv6 should be used for query transport. See also the \fB\-4\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-a\fP +.B \-a The \fB\-a\fP ("all") option is normally equivalent to \fB\-v \-t ANY\fP\&. It also affects the behavior of the \fB\-l\fP list zone option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A\fP +.B \-A The \fB\-A\fP ("almost all") option is equivalent to \fB\-a\fP, except that RRSIG, NSEC, and NSEC3 records are omitted from the output. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-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). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP +.B \-C This option indicates that \fBnamed\fP should check consistency, meaning that \fBhost\fP queries the SOA records for zone \fBname\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d\fP +.B \-d This option prints debugging traces, and is equivalent to the \fB\-v\fP verbose option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l\fP +.B \-l This option tells \fBnamed\fP to list the zone, meaning the \fBhost\fP command performs a zone transfer of zone \fBname\fP and prints out the NS, PTR, and address records (A/AAAA). .sp Together, the \fB\-l \-a\fP options print all records in the zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-N ndots\fP +.B \-N ndots This option specifies the number of dots (\fBndots\fP) that have to be in \fBname\fP for it to be considered absolute. The default value is that defined using the \fBndots\fP statement in \fB/etc/resolv.conf\fP, or 1 if no \fBndots\fP statement is present. Names with fewer dots are interpreted as relative names, and are searched for in the domains listed in the \fBsearch\fP or \fBdomain\fP directive in \fB/etc/resolv.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port\fP +.B \-p port This option specifies the port to query on the server. The default is 53. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r\fP +.B \-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 \fBname\fP\&. The \fB\-r\fP option enables \fBhost\fP to mimic the behavior of a name server by making non\-recursive queries, and expecting to receive answers to those queries that can be referrals to other name servers. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-R number\fP +.B \-R number This option specifies the number of retries for UDP queries. If \fBnumber\fP is negative or zero, the number of retries is silently set to 1. The default value is 1, or the value of the \fBattempts\fP option in \fB/etc/resolv.conf\fP, if set. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s\fP +.B \-s This option tells \fBnamed\fP \fInot\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t type\fP +.B \-t type This option specifies the query type. The \fBtype\fP argument can be any recognized query type: CNAME, NS, SOA, TXT, DNSKEY, AXFR, etc. .sp @@ -124,32 +150,44 @@ colon\-delimited IPv6 address, \fBhost\fP queries for PTR records. 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., \fB\-t IXFR=12345678\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T\fP; \fB\-U\fP +.B \-T\(ga\(ga; \(ga\(ga\-U This option specifies TCP or UDP. By default, \fBhost\fP uses UDP when making queries; the \fB\-T\fP option makes it use a TCP connection when querying the name server. TCP is automatically selected for queries that require it, such as zone transfer (AXFR) requests. Type \fBANY\fP queries default to TCP, but can be forced to use UDP initially via \fB\-U\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m flag\fP +.B \-m flag This option sets memory usage debugging: the flag can be \fBrecord\fP, \fBusage\fP, or \fBtrace\fP\&. The \fB\-m\fP option can be specified more than once to set multiple flags. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option sets verbose output, and is equivalent to the \fB\-d\fP debug option. Verbose output can also be enabled by setting the \fBdebug\fP option in \fB/etc/resolv.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints the version number and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-w\fP +.B \-w This option sets "wait forever": the query timeout is set to the maximum possible. See also the \fB\-W\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-W wait\fP +.B \-W wait This options sets the length of the wait timeout, indicating that \fBnamed\fP should wait for up to \fBwait\fP seconds for a reply. If \fBwait\fP is less than 1, the wait interval is set to 1 second. .sp diff --git a/doc/man/mdig.1in b/doc/man/mdig.1in index d4c9a4e2e1..60d09faea4 100644 --- a/doc/man/mdig.1in +++ b/doc/man/mdig.1in @@ -70,39 +70,51 @@ assign values to options like the timeout interval. They have the form .SH ANYWHERE OPTIONS .INDENT 0.0 .TP -.B \fB\-f\fP +.B \-f This option makes \fBmdig\fP operate in batch mode by reading a list of lookup requests to process from the file \fBfilename\fP\&. The file contains a number of queries, one per line. Each entry in the file should be organized in the same way they would be presented as queries to \fBmdig\fP using the command\-line interface. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option causes \fBmdig\fP to print detailed help information, with the full list of options, and exit. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option causes \fBmdig\fP to print the version number and exit. .UNINDENT .SH GLOBAL OPTIONS .INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option forces \fBmdig\fP to only use IPv4 query transport. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option forces \fBmdig\fP to only use IPv6 query transport. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-b address\fP +.B \-b address This option sets the source IP address of the query to \fBaddress\fP\&. This must be a valid address on one of the host\(aqs network interfaces or "0.0.0.0" or "::". An optional port may be specified by appending "#" +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m\fP +.B \-m This option enables memory usage debugging. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port#\fP +.B \-p port# This option is used when a non\-standard port number is to be queried. \fBport#\fP is the port number that \fBmdig\fP sends its queries to, instead of the standard DNS port number 53. This option is @@ -113,90 +125,128 @@ queries on a non\-standard port number. The global query options are: .INDENT 0.0 .TP -.B \fB+[no]additional\fP +.B +[no]additional This option displays [or does not display] the additional section of a reply. The default is to display it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]all\fP +.B +[no]all This option sets or clears all display flags. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]answer\fP +.B +[no]answer This option displays [or does not display] the answer section of a reply. The default is to display it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]authority\fP +.B +[no]authority This option displays [or does not display] the authority section of a reply. The default is to display it. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]besteffort\fP +.B +[no]besteffort This option attempts to display [or does not display] the contents of messages which are malformed. The default is to not display malformed answers. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+burst\fP +.B +burst This option delays queries until the start of the next second. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]cl\fP +.B +[no]cl This option displays [or does not display] the CLASS when printing the record. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]comments\fP +.B +[no]comments This option toggles the display of comment lines in the output. The default is to print comments. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]continue\fP +.B +[no]continue This option toggles continuation on errors (e.g. timeouts). +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]crypto\fP +.B +[no]crypto 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]"; in the DNSKEY case, the key ID is displayed as the replacement, e.g., \fB[ key id = value ]\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+dscp[=value]\fP +.B +dscp[=value] 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]multiline\fP +.B +[no]multiline This option toggles printing of 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 \fBmdig\fP output. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]question\fP +.B +[no]question This option prints [or does not print] the question section of a query when an answer is returned. The default is to print the question section as a comment. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]rrcomments\fP +.B +[no]rrcomments 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]short\fP +.B +[no]short This option provides [or does not provide] a terse answer. The default is to print the answer in a verbose form. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+split=W\fP +.B +split=W This option splits long hex\- or base64\-formatted fields in resource records into chunks of \fBW\fP characters (where \fBW\fP is rounded up to the nearest multiple of 4). \fB+nosplit\fP or \fB+split=0\fP causes fields not to be split. The default is 56 characters, or 44 characters when multiline mode is active. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]tcp\fP +.B +[no]tcp This option uses [or does not use] TCP when querying name servers. The default behavior is to use UDP. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ttlid\fP +.B +[no]ttlid This option displays [or does not display] the TTL when printing the record. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ttlunits\fP +.B +[no]ttlunits 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]vc\fP +.B +[no]vc This option uses [or does not use] TCP when querying name servers. This alternate syntax to \fB+[no]tcp\fP is provided for backwards compatibility. The \fBvc\fP stands for "virtual circuit". @@ -204,18 +254,22 @@ syntax to \fB+[no]tcp\fP is provided for backwards compatibility. The .SH LOCAL OPTIONS .INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option sets the query class to \fBclass\fP\&. It can be any valid query class which is supported in BIND 9. The default query class is "IN". +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t type\fP +.B \-t type This option sets the query type to \fBtype\fP\&. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the \fB\-x\fP option is supplied to indicate a reverse lookup with the "PTR" query type. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x addr\fP +.B \-x addr Reverse lookups \- mapping addresses to names \- are simplified by this option. \fBaddr\fP is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. \fBmdig\fP automatically @@ -228,13 +282,17 @@ domain. The local query options are: .INDENT 0.0 .TP -.B \fB+[no]aaflag\fP +.B +[no]aaflag This is a synonym for \fB+[no]aaonly\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]aaonly\fP +.B +[no]aaonly This sets the \fBaa\fP flag in the query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]adflag\fP +.B +[no]adflag This 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 @@ -242,91 +300,129 @@ 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+bufsize=B\fP +.B +bufsize=B This sets the UDP message buffer size advertised using EDNS0 to \fBB\fP 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 cause a EDNS query to be sent. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]cdflag\fP +.B +[no]cdflag This sets [or does not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]cookie=####\fP +.B +[no]cookie=#### This 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 \fB+nocookie\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]dnssec\fP +.B +[no]dnssec This requests that DNSSEC records be sent by setting the DNSSEC OK (DO) bit in the OPT record in the additional section of the query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]edns[=#]\fP +.B +[no]edns[=#] This specifies [or does not specify] the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version causes an EDNS query to be sent. \fB+noedns\fP clears the remembered EDNS version. EDNS is set to 0 by default. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ednsflags[=#]\fP +.B +[no]ednsflags[=#] This sets the must\-be\-zero EDNS flag 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]ednsopt[=code[:value]]\fP +.B +[no]ednsopt[=code[:value]] This specifies [or does not specify] an EDNS option with code point \fBcode\fP and an optional payload of \fBvalue\fP as a hexadecimal string. \fB+noednsopt\fP clears the EDNS options to be sent. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]expire\fP +.B +[no]expire This toggles sending of an EDNS Expire option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]nsid\fP +.B +[no]nsid This toggles inclusion of an EDNS name server ID request when sending a query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]recurse\fP +.B +[no]recurse This toggles the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means \fBmdig\fP normally sends recursive queries. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+retry=T\fP +.B +retry=T This sets the number of times to retry UDP queries to server to \fBT\fP instead of the default, 2. Unlike \fB+tries\fP, this does not include the initial query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]subnet=addr[/prefix\-length]\fP +.B +[no]subnet=addr[/prefix\-length] This sends [or does not send] an EDNS Client Subnet option with the specified IP address or network prefix. +.UNINDENT +.INDENT 0.0 .TP .B \fBmdig +subnet=0.0.0.0/0\fP, or simply \fBmdig +subnet=0\fP This sends an EDNS client\-subnet option with an empty address and a source prefix\-length of zero, which signals a resolver that the client\(aqs address information must \fInot\fP be used when resolving this query. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+timeout=T\fP +.B +timeout=T This sets the timeout for a query to \fBT\fP seconds. The default timeout is 5 seconds for UDP transport and 10 for TCP. An attempt to set \fBT\fP to less than 1 results in a query timeout of 1 second being applied. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+tries=T\fP +.B +tries=T This sets the number of times to try UDP queries to server to \fBT\fP instead of the default, 3. If \fBT\fP is less than or equal to zero, the number of tries is silently rounded up to 1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+udptimeout=T\fP +.B +udptimeout=T This sets the timeout between UDP query retries to \fBT\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]unknownformat\fP +.B +[no]unknownformat This prints [or does not print] all RDATA in unknown RR\-type presentation format (see \fI\%RFC 3597\fP). The default is to print RDATA for known types in the type\(aqs presentation format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]yaml\fP +.B +[no]yaml This toggles printing of the responses in a detailed YAML format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB+[no]zflag\fP +.B +[no]zflag This sets [or does not set] the last unassigned DNS header flag in a DNS query. This flag is off by default. .UNINDENT diff --git a/doc/man/named-checkconf.1in b/doc/man/named-checkconf.1in index 5ff53d45e8..b094851243 100644 --- a/doc/man/named-checkconf.1in +++ b/doc/man/named-checkconf.1in @@ -48,48 +48,68 @@ However, \fBnamed\-checkconf\fP can be run on these files explicitly. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints the usage summary and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-j\fP +.B \-j When loading a zonefile, this option instructs \fBnamed\fP to read the journal if it exists. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l\fP +.B \-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). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c\fP +.B \-c This option specifies that only the "core" configuration should be checked. This suppresses the loading of plugin modules, and causes all parameters to \fBplugin\fP statements to be ignored. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i\fP +.B \-i This option ignores warnings on deprecated options. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p\fP +.B \-p This option prints out the \fBnamed.conf\fP and included files in canonical form if no errors were detected. See also the \fB\-x\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t directory\fP +.B \-t directory This option instructs \fBnamed\fP to chroot to \fBdirectory\fP, so that \fBinclude\fP directives in the configuration file are processed as if run by a similarly chrooted \fBnamed\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option prints the version of the \fBnamed\-checkconf\fP program and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-x\fP +.B \-x When printing the configuration files in canonical form, this option obscures shared secrets by replacing them with strings of question marks (\fB?\fP). This allows the contents of \fBnamed.conf\fP and related files to be shared \- for example, when submitting bug reports \- without compromising private data. This option cannot be used without \fB\-p\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-z\fP +.B \-z This option performs a test load of all zones of type \fBprimary\fP found in \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBfilename\fP +.B filename This indicates the name of the configuration file to be checked. If not specified, it defaults to \fB@sysconfdir@/named.conf\fP\&. .UNINDENT diff --git a/doc/man/named-checkzone.1in b/doc/man/named-checkzone.1in index c7ed4bf1dd..06a3411382 100644 --- a/doc/man/named-checkzone.1in +++ b/doc/man/named-checkzone.1in @@ -42,32 +42,46 @@ configuring them into a name server. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-d\fP +.B \-d This option enables debugging. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints the usage summary and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option sets quiet mode, which only sets an exit code to indicate successful or failed completion. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option prints the version of the \fBnamed\-checkzone\fP program and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-j\fP +.B \-j When loading a zone file, this option tells \fBnamed\fP to read the journal if it exists. The journal file name is assumed to be the zone file name with the string \fB\&.jnl\fP appended. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-J filename\fP +.B \-J filename When loading the zone file, this option tells \fBnamed\fP to read the journal from the given file, if it exists. This implies \fB\-j\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option specifies the class of the zone. If not specified, \fBIN\fP is assumed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i mode\fP +.B \-i mode This option performs post\-load zone integrity checks. Possible modes are \fBfull\fP (the default), \fBfull\-sibling\fP, \fBlocal\fP, \fBlocal\-sibling\fP, and \fBnone\fP\&. @@ -92,12 +106,16 @@ checks, but are otherwise the same as \fBfull\fP and \fBlocal\fP, respectively. .sp Mode \fBnone\fP disables the checks. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f format\fP +.B \-f format This option specifies the format of the zone file. Possible formats are \fBtext\fP (the default), and \fBraw\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-F format\fP +.B \-F format This option specifies the format of the output file specified. For \fBnamed\-checkzone\fP, this does not have any effect unless it dumps the zone contents. @@ -108,44 +126,62 @@ store the zone in a binary format for rapid loading by \fBnamed\fP\&. \fBraw=N\fP specifies the format version of the raw zone file: if \fBN\fP is 0, the raw file can be read by any version of \fBnamed\fP; if N is 1, the file can only be read by release 9.9.0 or higher. The default is 1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k mode\fP +.B \-k mode This option performs \fBcheck\-names\fP checks with the specified failure mode. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l ttl\fP +.B \-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 \fBmax\-zone\-ttl\fP option in \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L serial\fP +.B \-L serial When compiling a zone to \fBraw\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m mode\fP +.B \-m mode This option specifies whether MX records should be checked to see if they are addresses. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-M mode\fP +.B \-M mode This option checks whether a MX record refers to a CNAME. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-n mode\fP +.B \-n mode This option specifies whether NS records should be checked to see if they are addresses. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-o filename\fP +.B \-o filename This option writes the zone output to \fBfilename\fP\&. If \fBfilename\fP is \fB\-\fP, then the zone output is written to standard output. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r mode\fP +.B \-r mode This option checks for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s style\fP +.B \-s style This option specifies the style of the dumped zone file. Possible styles are \fBfull\fP (the default) and \fBrelative\fP\&. The \fBfull\fP format is most suitable for processing automatically by a separate script. @@ -153,39 +189,55 @@ The relative format is more human\-readable and is thus suitable for editing by hand. 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-S mode\fP +.B \-S mode This option checks whether an SRV record refers to a CNAME. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t directory\fP +.B \-t directory This option tells \fBnamed\fP to chroot to \fBdirectory\fP, so that \fBinclude\fP directives in the configuration file are processed as if run by a similarly chrooted \fBnamed\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T mode\fP +.B \-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 \fBwarn\fP (the default) and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-w directory\fP +.B \-w directory This option instructs \fBnamed\fP to chdir to \fBdirectory\fP, so that relative filenames in master file \fB$INCLUDE\fP directives work. This is similar to the directory clause in \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D\fP +.B \-D This option dumps the zone file in canonical format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-W mode\fP +.B \-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 (\fI\%RFC 4592\fP). Possible modes are \fBwarn\fP (the default) and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBzonename\fP +.B zonename This indicates the domain name of the zone being checked. +.UNINDENT +.INDENT 0.0 .TP -.B \fBfilename\fP +.B filename This is the name of the zone file. .UNINDENT .SH RETURN VALUES diff --git a/doc/man/named-compilezone.1in b/doc/man/named-compilezone.1in index 7635bd07ad..96741bfc0f 100644 --- a/doc/man/named-compilezone.1in +++ b/doc/man/named-compilezone.1in @@ -44,32 +44,46 @@ strict as those specified in the \fBnamed\fP configuration file. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-d\fP +.B \-d This option enables debugging. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints the usage summary and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option sets quiet mode, which only sets an exit code to indicate successful or failed completion. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option prints the version of the \fBnamed\-checkzone\fP program and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-j\fP +.B \-j When loading a zone file, this option tells \fBnamed\fP to read the journal if it exists. The journal file name is assumed to be the zone file name with the string \fB\&.jnl\fP appended. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-J filename\fP +.B \-J filename When loading the zone file, this option tells \fBnamed\fP to read the journal from the given file, if it exists. This implies \fB\-j\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c class\fP +.B \-c class This option specifies the class of the zone. If not specified, \fBIN\fP is assumed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i mode\fP +.B \-i mode This option performs post\-load zone integrity checks. Possible modes are \fBfull\fP (the default), \fBfull\-sibling\fP, \fBlocal\fP, \fBlocal\-sibling\fP, and \fBnone\fP\&. @@ -94,12 +108,16 @@ checks, but are otherwise the same as \fBfull\fP and \fBlocal\fP, respectively. .sp Mode \fBnone\fP disables the checks. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f format\fP +.B \-f format This option specifies the format of the zone file. Possible formats are \fBtext\fP (the default), and \fBraw\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-F format\fP +.B \-F format This option specifies the format of the output file specified. For \fBnamed\-checkzone\fP, this does not have any effect unless it dumps the zone contents. @@ -110,84 +128,118 @@ store the zone in a binary format for rapid loading by \fBnamed\fP\&. \fBraw=N\fP specifies the format version of the raw zone file: if \fBN\fP is 0, the raw file can be read by any version of \fBnamed\fP; if N is 1, the file can only be read by release 9.9.0 or higher. The default is 1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k mode\fP +.B \-k mode This option performs \fBcheck\-names\fP checks with the specified failure mode. Possible modes are \fBfail\fP (the default), \fBwarn\fP, and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l ttl\fP +.B \-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 \fBmax\-zone\-ttl\fP option in \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L serial\fP +.B \-L serial When compiling a zone to \fBraw\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m mode\fP +.B \-m mode This option specifies whether MX records should be checked to see if they are addresses. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-M mode\fP +.B \-M mode This option checks whether a MX record refers to a CNAME. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-n mode\fP +.B \-n mode This option specifies whether NS records should be checked to see if they are addresses. Possible modes are \fBfail\fP (the default), \fBwarn\fP, and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-o filename\fP +.B \-o filename This option writes the zone output to \fBfilename\fP\&. If \fBfilename\fP is \fB\-\fP, then the zone output is written to standard output. This is mandatory for \fBnamed\-compilezone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r mode\fP +.B \-r mode This option checks for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s style\fP +.B \-s style This option specifies the style of the dumped zone file. Possible styles are \fBfull\fP (the default) and \fBrelative\fP\&. The \fBfull\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-S mode\fP +.B \-S mode This option checks whether an SRV record refers to a CNAME. Possible modes are \fBfail\fP, \fBwarn\fP (the default), and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t directory\fP +.B \-t directory This option tells \fBnamed\fP to chroot to \fBdirectory\fP, so that \fBinclude\fP directives in the configuration file are processed as if run by a similarly chrooted \fBnamed\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T mode\fP +.B \-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 \fBwarn\fP (the default) and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-w directory\fP +.B \-w directory This option instructs \fBnamed\fP to chdir to \fBdirectory\fP, so that relative filenames in master file \fB$INCLUDE\fP directives work. This is similar to the directory clause in \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D\fP +.B \-D This option dumps the zone file in canonical format. This is always enabled for \fBnamed\-compilezone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-W mode\fP +.B \-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 (\fI\%RFC 4592\fP). Possible modes are \fBwarn\fP (the default) and \fBignore\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBzonename\fP +.B zonename This indicates the domain name of the zone being checked. +.UNINDENT +.INDENT 0.0 .TP -.B \fBfilename\fP +.B filename This is the name of the zone file. .UNINDENT .SH RETURN VALUES diff --git a/doc/man/named-nzd2nzf.1in b/doc/man/named-nzd2nzf.1in index 4c537aa932..fee8beec73 100644 --- a/doc/man/named-nzd2nzf.1in +++ b/doc/man/named-nzd2nzf.1in @@ -43,7 +43,7 @@ version of BIND to an older version. .SH ARGUMENTS .INDENT 0.0 .TP -.B \fBfilename\fP +.B filename This is the name of the \fB\&.nzd\fP file whose contents should be printed. .UNINDENT .SH SEE ALSO diff --git a/doc/man/named-rrchecker.1in b/doc/man/named-rrchecker.1in index 26609b0d21..d51b24734f 100644 --- a/doc/man/named-rrchecker.1in +++ b/doc/man/named-rrchecker.1in @@ -40,22 +40,30 @@ input and checks whether it is syntactically correct. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints out the help menu. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-o origin\fP +.B \-o origin This option specifies the origin to be used when interpreting the record. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p\fP +.B \-p This option prints out the resulting record in canonical form. If there is no canonical form defined, the record is printed in unknown record format. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u\fP +.B \-u This option prints out the resulting record in unknown record form. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP, \fB\-T\fP, and \fB\-P\fP +.B \-C, \-T, \-P These options print out the known class, standard type, and private type mnemonics, respectively. .UNINDENT diff --git a/doc/man/named.8in b/doc/man/named.8in index 34ef4c4081..e200fc37c7 100644 --- a/doc/man/named.8in +++ b/doc/man/named.8in @@ -45,47 +45,65 @@ listens for queries. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option tells \fBnamed\fP to use only IPv4, even if the host machine is capable of IPv6. \fB\-4\fP and \fB\-6\fP are mutually exclusive. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option tells \fBnamed\fP to use only IPv6, even if the host machine is capable of IPv4. \fB\-4\fP and \fB\-6\fP are mutually exclusive. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c config\-file\fP +.B \-c config\-file This option tells \fBnamed\fP to use \fBconfig\-file\fP as its configuration file instead of the default, \fB@sysconfdir@/named.conf\fP\&. To ensure that the configuration file can be reloaded after the server has changed its working directory due to to a possible \fBdirectory\fP option in the configuration file, \fBconfig\-file\fP should be an absolute pathname. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d debug\-level\fP +.B \-d debug\-level This option sets the daemon\(aqs debug level to \fBdebug\-level\fP\&. Debugging traces from \fBnamed\fP become more verbose as the debug level increases. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D string\fP +.B \-D string This option specifies a string that is used to identify a instance of \fBnamed\fP in a process listing. The contents of \fBstring\fP are not examined. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-E engine\-name\fP +.B \-E engine\-name When applicable, this option specifies the hardware to use for cryptographic operations, such as a secure key store used for signing. .sp When BIND 9 is built with OpenSSL, this needs to be set to the OpenSSL engine identifier that drives the cryptographic accelerator or hardware service module (usually \fBpkcs11\fP). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-f\fP +.B \-f This option runs the server in the foreground (i.e., do not daemonize). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-g\fP +.B \-g This option runs the server in the foreground and forces all logging to \fBstderr\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L logfile\fP +.B \-L logfile This option sets the log to the file \fBlogfile\fP by default, instead of the system log. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-M option\fP +.B \-M option This option sets the default memory context options. If set to \fBexternal\fP, the internal memory manager is bypassed in favor of system\-provided memory allocation functions. If set to \fBfill\fP, blocks @@ -93,19 +111,25 @@ of memory are filled with tag values when allocated or freed, to assist debugging of memory problems. \fBnofill\fP disables this behavior, and is the default unless \fBnamed\fP has been compiled with developer options. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-m flag\fP +.B \-m flag This option turns on memory usage debugging flags. Possible flags are \fBusage\fP, \fBtrace\fP, \fBrecord\fP, \fBsize\fP, and \fBmctx\fP\&. These correspond to the \fBISC_MEM_DEBUGXXXX\fP flags described in \fB\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-n #cpus\fP +.B \-n #cpus This option creates \fB#cpus\fP worker threads to take advantage of multiple CPUs. If not specified, \fBnamed\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p value\fP +.B \-p value This option specifies the port(s) on which the server will listen for queries. If \fBvalue\fP is of the form \fB\fP or \fBdns=\fP, the server will listen for DNS queries on @@ -116,8 +140,10 @@ If \fBvalue\fP is of the form \fBhttps=\fP, the server will listen for HTTPS queries on \fBportnum\fP; the default is 443. If \fBvalue\fP is of the form \fBhttp=\fP, the server will listen for HTTP queries on \fBportnum\fP; the default is 80. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s\fP +.B \-s This option writes memory usage statistics to \fBstdout\fP on exit. .UNINDENT .sp @@ -130,7 +156,7 @@ removed or changed in a future release. .UNINDENT .INDENT 0.0 .TP -.B \fB\-S #max\-socks\fP +.B \-S #max\-socks This option is deprecated and no longer has any function. .UNINDENT .sp @@ -150,7 +176,7 @@ for its internal use. .UNINDENT .INDENT 0.0 .TP -.B \fB\-t directory\fP +.B \-t directory This option tells \fBnamed\fP to chroot to \fBdirectory\fP after processing the command\-line arguments, but before reading the configuration file. .UNINDENT @@ -166,7 +192,7 @@ with root privileges to escape a chroot jail. .UNINDENT .INDENT 0.0 .TP -.B \fB\-U #listeners\fP +.B \-U #listeners This option tells \fBnamed\fP the number of \fB#listeners\fP worker threads to listen on, for incoming UDP packets on each address. If not specified, \fBnamed\fP calculates a default value based on the number of detected CPUs: 1 for 1 CPU, and the @@ -175,8 +201,10 @@ This cannot be increased to a value higher than the number of CPUs. If \fB\-n\fP has been set to a higher value than the number of detected CPUs, then \fB\-U\fP may be increased as high as that value, but no higher. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u user\fP +.B \-u user This option sets the setuid to \fBuser\fP after completing privileged operations, such as creating sockets that listen on privileged ports. .UNINDENT @@ -195,13 +223,17 @@ previous kernels did not allow privileges to be retained after .UNINDENT .INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option reports the version number and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option reports the version number and build options, and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-X lock\-file\fP +.B \-X lock\-file This option acquires a lock on the specified file at runtime; this helps to prevent duplicate \fBnamed\fP instances from running simultaneously. Use of this option overrides the \fBlock\-file\fP option in diff --git a/doc/man/nsec3hash.1in b/doc/man/nsec3hash.1in index 3090300f6e..e0ac570c1f 100644 --- a/doc/man/nsec3hash.1in +++ b/doc/man/nsec3hash.1in @@ -49,22 +49,30 @@ into a command line to confirm the correctness of an NSEC3 hash. .SH ARGUMENTS .INDENT 0.0 .TP -.B \fBsalt\fP +.B salt This is the salt provided to the hash algorithm. +.UNINDENT +.INDENT 0.0 .TP -.B \fBalgorithm\fP +.B algorithm This is a number indicating the hash algorithm. Currently the only supported hash algorithm for NSEC3 is SHA\-1, which is indicated by the number 1; consequently "1" is the only useful value for this argument. +.UNINDENT +.INDENT 0.0 .TP -.B \fBflags\fP +.B flags This is provided for compatibility with NSEC3 record presentation format, but is ignored since the flags do not affect the hash. +.UNINDENT +.INDENT 0.0 .TP -.B \fBiterations\fP +.B iterations This is the number of additional times the hash should be performed. +.UNINDENT +.INDENT 0.0 .TP -.B \fBdomain\fP +.B domain This is the domain name to be hashed. .UNINDENT .SH SEE ALSO diff --git a/doc/man/nsupdate.1in b/doc/man/nsupdate.1in index b4840b36b3..3a3d1c281b 100644 --- a/doc/man/nsupdate.1in +++ b/doc/man/nsupdate.1in @@ -73,26 +73,38 @@ used by Windows 2000 can be switched on with the \fB\-o\fP flag. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option sets use of IPv4 only. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option sets use of IPv6 only. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-C\fP +.B \-C Overrides the default \fIresolv.conf\fP file. This is only intended for testing. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-d\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-D\fP +.B \-D This option sets extra debug mode. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-i\fP +.B \-i This option forces interactive mode, even when standard input is not a terminal. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k keyfile\fP +.B \-k keyfile This option indicates the file containing the TSIG authentication key. Keyfiles may be in two formats: a single file containing a \fBnamed.conf\fP\-format \fBkey\fP statement, which may be generated automatically by \fBddns\-confgen\fP; @@ -102,8 +114,10 @@ or a pair of files whose names are of the format \fBdnssec\-keygen\fP\&. The \fB\-k\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-l\fP +.B \-l This option sets local\-host only mode, which sets the server address to localhost (disabling the \fBserver\fP so that the server address cannot be overridden). Connections to the local server use a TSIG key @@ -111,27 +125,39 @@ found in \fB@runstatedir@/session.key\fP, which is automatically generated by \fBnamed\fP if any local \fBprimary\fP zone has set \fBupdate\-policy\fP to \fBlocal\fP\&. The location of this key file can be overridden with the \fB\-k\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-L level\fP +.B \-L level This option sets the logging debug level. If zero, logging is disabled. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port\fP +.B \-p port This option sets the port to use for connections to a name server. The default is 53. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-P\fP +.B \-P This option prints the list of private BIND\-specific resource record types whose format is understood by \fBnsupdate\fP\&. See also the \fB\-T\fP option. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r udpretries\fP +.B \-r udpretries This option sets the number of UDP retries. The default is 3. If zero, only one update request is made. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t timeout\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-T\fP +.B \-T This option prints the list of IANA standard resource record types whose format is understood by \fBnsupdate\fP\&. \fBnsupdate\fP exits after the lists are printed. The \fB\-T\fP option can be combined with the \fB\-P\fP @@ -141,22 +167,30 @@ Other types can be entered using \fBTYPEXXXXX\fP where \fBXXXXX\fP is the decimal value of the type with no leading zeros. The rdata, if present, is parsed using the UNKNOWN rdata format, ( ). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u udptimeout\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-v\fP +.B \-v This option specifies that TCP should be used even for small update requests. By default, \fBnsupdate\fP 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 is used. TCP may be preferable when a batch of update requests is made. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option prints the version number and exits. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-y [hmac:]keyname:secret\fP +.B \-y [hmac:]keyname:secret This option sets the literal TSIG authentication key. \fBkeyname\fP is the name of the key, and \fBsecret\fP is the base64 encoded shared secret. \fBhmac\fP is the name of the key algorithm; valid choices are \fBhmac\-md5\fP, diff --git a/doc/man/rndc-confgen.8in b/doc/man/rndc-confgen.8in index fa3158722a..6abc3951bd 100644 --- a/doc/man/rndc-confgen.8in +++ b/doc/man/rndc-confgen.8in @@ -44,7 +44,7 @@ by hand. Alternatively, it can be run with the \fB\-a\fP option to set up a .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a\fP +.B \-a This option sets automatic \fBrndc\fP configuration, which creates a file \fB@sysconfdir@/rndc.key\fP that is read by both \fBrndc\fP and \fBnamed\fP on startup. The \fBrndc.key\fP file defines a default command channel and @@ -55,47 +55,67 @@ If a more elaborate configuration than that generated by \fBrndc\-confgen \-a\fP is required, for example if rndc is to be used remotely, run \fBrndc\-confgen\fP without the \fB\-a\fP option and set up \fBrndc.conf\fP and \fBnamed.conf\fP as directed. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-A algorithm\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-b keysize\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c keyfile\fP +.B \-c keyfile This option is used with the \fB\-a\fP option to specify an alternate location for \fBrndc.key\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints a short summary of the options and arguments to \fBrndc\-confgen\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k keyname\fP +.B \-k keyname This option specifies the key name of the \fBrndc\fP authentication key. This must be a valid domain name. The default is \fBrndc\-key\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port\fP +.B \-p port This option specifies the command channel port where \fBnamed\fP listens for connections from \fBrndc\fP\&. The default is 953. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option prevets printing the written path in automatic configuration mode. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s address\fP +.B \-s address This option specifies the IP address where \fBnamed\fP listens for command\-channel connections from \fBrndc\fP\&. The default is the loopback address 127.0.0.1. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-t chrootdir\fP +.B \-t chrootdir This option is used with the \fB\-a\fP option to specify a directory where \fBnamed\fP runs chrooted. An additional copy of the \fBrndc.key\fP is written relative to this directory, so that it is found by the chrooted \fBnamed\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-u user\fP +.B \-u user This option is used with the \fB\-a\fP option to set the owner of the generated \fBrndc.key\fP file. If \fB\-t\fP is also specified, only the file in the chroot area has its owner changed. diff --git a/doc/man/rndc.8in b/doc/man/rndc.8in index 3b1d5d2f25..bc6534c2c1 100644 --- a/doc/man/rndc.8in +++ b/doc/man/rndc.8in @@ -56,51 +56,71 @@ server and decide what algorithm and key it should use. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-4\fP +.B \-4 This option indicates use of IPv4 only. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-6\fP +.B \-6 This option indicates use of IPv6 only. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-b source\-address\fP +.B \-b source\-address This option indicates \fBsource\-address\fP 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-c config\-file\fP +.B \-c config\-file This option indicates \fBconfig\-file\fP as the configuration file instead of the default, \fB@sysconfdir@/rndc.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-k key\-file\fP +.B \-k key\-file This option indicates \fBkey\-file\fP as the key file instead of the default, \fB@sysconfdir@/rndc.key\fP\&. The key in \fB@sysconfdir@/rndc.key\fP is used to authenticate commands sent to the server if the config\-file does not exist. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-s server\fP +.B \-s server \fBserver\fP is the name or address of the server which matches a server statement in the configuration file for \fBrndc\fP\&. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the \fBrndc\fP configuration file is used. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-p port\fP +.B \-p port This option instructs BIND 9 to send commands to TCP port \fBport\fP instead of its default control channel port, 953. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-q\fP +.B \-q This option sets quiet mode, where message text returned by the server is not printed unless there is an error. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-r\fP +.B \-r This option instructs \fBrndc\fP to print the result code returned by \fBnamed\fP after executing the requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc.). +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-V\fP +.B \-V This option enables verbose logging. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-y key_id\fP +.B \-y key_id This option indicates use of the key \fBkey_id\fP from the configuration file. For control message validation to succeed, \fBkey_id\fP must be known by \fBnamed\fP with the same algorithm and secret string. If no \fBkey_id\fP is specified, \fBrndc\fP first looks for a key clause in the server statement of @@ -118,7 +138,7 @@ without arguments. Currently supported commands are: .INDENT 0.0 .TP -.B \fBaddzone\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] \fIconfiguration\fP +.B addzone zone [class [view]] configuration This command adds a zone while the server is running. This command requires the \fBallow\-new\-zones\fP option to be set to \fByes\fP\&. The configuration string specified on the command line is the zone configuration text @@ -142,8 +162,10 @@ the default view: text.) .sp See also \fBrndc delzone\fP and \fBrndc modzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBdelzone\fP [\fB\-clean\fP] \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B delzone [\-clean] zone [class [view]] This command deletes a zone while the server is running. .sp If the \fB\-clean\fP argument is specified, the zone\(aqs master file (and @@ -160,8 +182,10 @@ recreated. To remove it permanently, it must also be removed from \fBnamed.conf\fP\&. .sp See also \fBrndc addzone\fP and \fBrndc modzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBdnssec\fP ( \fB\-status\fP | \fB\-rollover\fP \fB\-key\fP id [\fB\-alg\fP \fIalgorithm\fP] [\fB\-when\fP \fItime\fP] | \fB\-checkds\fP [\fB\-key\fP \fIid\fP [\fB\-alg\fP \fIalgorithm\fP]] [\fB\-when\fP \fItime\fP] ( \fIpublished\fP | \fIwithdrawn\fP )) \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B dnssec (\-status | \-rollover \-key id [\-alg algorithm] [\-when time] | \-checkds [\-key id [\-alg algorithm]] [\-when time] published | withdraw)) zone [class [view]] This command allows you to interact with the "dnssec\-policy" of a given zone. .sp @@ -179,8 +203,10 @@ is only one key acting as a KSK in the zone, assume the DS of that key (if there are multiple keys with the same tag, use \fB\-alg algorithm\fP to select the correct algorithm). The time that the DS has been published or withdrawn is set to now, unless otherwise specified with the argument \fB\-when time\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBdnstap\fP ( \fB\-reopen\fP | \fB\-roll\fP [\fInumber\fP] ) +.B dnstap (\-reopen | \-roll [number]) This command closes and re\-opens DNSTAP output files. \fBrndc dnstap \-reopen\fP allows the output file to be renamed externally, so that \fBnamed\fP can truncate and re\-open it. \fBrndc dnstap \-roll\fP causes the output file @@ -188,26 +214,36 @@ to be rolled automatically, similar to log files. The most recent output file has ".0" appended to its name; the previous most recent output file is moved to ".1", and so on. If \fBnumber\fP is specified, then the number of backup log files is limited to that number. +.UNINDENT +.INDENT 0.0 .TP -\fBdumpdb\fP [\fB\-all\fP | \fB\-cache\fP | \fB\-zones\fP | \fB\-adb\fP | \fB\-bad\fP | \fB\-expired\fP | \fB\-fail\fP] [\fIview ...\fP] +.B dumpdb [\-all | \-cache | \-zones | \-adb | \-bad | \-expired | \-fail] [view ...] This command dumps the server\(aqs caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped. (See the \fBdump\-file\fP option in the BIND 9 Administrator Reference Manual.) +.UNINDENT +.INDENT 0.0 .TP -.B \fBflush\fP +.B flush This command flushes the server\(aqs cache. +.UNINDENT +.INDENT 0.0 .TP -.B \fBflushname\fP \fIname\fP [\fIview\fP] +.B flushname name [view] This command flushes the given name from the view\(aqs DNS cache and, if applicable, from the view\(aqs nameserver address database, bad server cache, and SERVFAIL cache. +.UNINDENT +.INDENT 0.0 .TP -.B \fBflushtree\fP \fIname\fP [\fIview\fP] +.B flushtree name [view] This command flushes the given name, and all of its subdomains, from the view\(aqs DNS cache, address database, bad server cache, and SERVFAIL cache. +.UNINDENT +.INDENT 0.0 .TP -.B \fBfreeze\fP [\fIzone\fP [\fIclass\fP [\fIview\fP]]] +.B freeze [zone [class [view]]] 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 @@ -215,8 +251,10 @@ journal file to be synced into the master file. All dynamic update attempts are refused while the zone is frozen. .sp See also \fBrndc thaw\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBhalt\fP [\fB\-p\fP] +.B halt [\-p] 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 @@ -225,8 +263,10 @@ an external process to determine when \fBnamed\fP has completed halting. .sp See also \fBrndc stop\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBloadkeys\fP [\fIzone\fP [\fIclass\fP [\fIview\fP]]] +.B loadkeys [zone [class [view]]] 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\(aqs DNSKEY RRset. Unlike \fBrndc sign\fP, however, the zone is not @@ -237,8 +277,10 @@ This command requires that the zone be configured with a \fBdnssec\-policy\fP, o that the \fBauto\-dnssec\fP zone option be set to \fBmaintain\fP, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.) +.UNINDENT +.INDENT 0.0 .TP -.B \fBmanaged\-keys\fP (\fIstatus\fP | \fIrefresh\fP | \fIsync\fP | \fIdestroy\fP) [\fIclass\fP [\fIview\fP]] +.B managed\-keys (status | refresh | sync | destroy) [class [view]] This command inspects and controls the "managed\-keys" database which handles \fI\%RFC 5011\fP DNSSEC trust anchor maintenance. If a view is specified, these commands are applied to that view; otherwise, they are applied to all @@ -277,8 +319,10 @@ also be used, for example, to jumpstart the acquisition of new keys in the event of a trust anchor rollover, or as a brute\-force repair for key maintenance problems. .UNINDENT +.UNINDENT +.INDENT 0.0 .TP -.B \fBmodzone\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] \fIconfiguration\fP +.B modzone zone [class [view]] configuration This command modifies the configuration of a zone while the server is running. This command requires the \fBallow\-new\-zones\fP option to be set to \fByes\fP\&. As with \fBaddzone\fP, the configuration string specified on the @@ -295,16 +339,22 @@ make the changes permanent, it must also be modified in \fBnamed.conf\fP\&. .sp See also \fBrndc addzone\fP and \fBrndc delzone\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBnotify\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B notify zone [class [view]] This command resends NOTIFY messages for the zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fBnotrace\fP +.B notrace This command sets the server\(aqs debugging level to 0. .sp See also \fBrndc trace\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBnta\fP [( \fB\-class\fP \fIclass\fP | \fB\-dump\fP | \fB\-force\fP | \fB\-remove\fP | \fB\-lifetime\fP \fIduration\fP)] \fIdomain\fP [\fIview\fP] +.B nta [(\-class class | \-dump | \-force | \-remove | \-lifetime duration)] domain [view] This command sets a DNSSEC negative trust anchor (NTA) for \fBdomain\fP, with a lifetime of \fBduration\fP\&. The default lifetime is configured in \fBnamed.conf\fP via the \fBnta\-lifetime\fP option, and defaults to one @@ -354,8 +404,10 @@ All of these options can be shortened, i.e., to \fB\-l\fP, \fB\-r\fP, Unrecognized options are treated as errors. To refer to a domain or view name that begins with a hyphen, use a double\-hyphen (\-\-) on the command line to indicate the end of options. +.UNINDENT +.INDENT 0.0 .TP -.B \fBquerylog\fP [(\fIon\fP | \fIoff\fP)] +.B querylog [(on | off)] 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. @@ -364,14 +416,18 @@ Query logging can also be enabled by explicitly directing the \fBqueries\fP \fBcategory\fP to a \fBchannel\fP in the \fBlogging\fP section of \fBnamed.conf\fP, or by specifying \fBquerylog yes;\fP in the \fBoptions\fP section of \fBnamed.conf\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBreconfig\fP +.B reconfig 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 \fBreload\fP when there is a large number of zones, because it avoids the need to examine the modification times of the zone files. +.UNINDENT +.INDENT 0.0 .TP -.B \fBrecursing\fP +.B recursing This command dumps the list of queries \fBnamed\fP is currently recursing on, and the list of domains to which iterative queries are currently being sent. @@ -390,30 +446,42 @@ cumulative over time; whenever the number of active fetches for a domain drops to zero, the counter for that domain is deleted, and the next time a fetch is sent to that domain, it is recreated with the counters set to zero). +.UNINDENT +.INDENT 0.0 .TP -.B \fBrefresh\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B refresh zone [class [view]] This command schedules zone maintenance for the given zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fBreload\fP +.B reload This command reloads the configuration file and zones. +.UNINDENT +.INDENT 0.0 .TP -.B \fBreload\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B reload zone [class [view]] This command reloads the given zone. +.UNINDENT +.INDENT 0.0 .TP -.B \fBretransfer\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B retransfer zone [class [view]] This command retransfers the given secondary zone from the primary server. .sp If the zone is configured to use \fBinline\-signing\fP, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version is regenerated with new signatures. +.UNINDENT +.INDENT 0.0 .TP -.B \fBscan\fP +.B scan This command scans the list of available network interfaces for changes, without performing a full \fBreconfig\fP or waiting for the \fBinterface\-interval\fP timer. +.UNINDENT +.INDENT 0.0 .TP -\fBsecroots\fP [\fB\-\fP] [\fIview\fP ...] +.B secroots [\-] [view ...] This command dumps the security roots (i.e., trust anchors configured via \fBtrust\-anchors\fP, or the \fBmanaged\-keys\fP or \fBtrusted\-keys\fP statements [both deprecated], or \fBdnssec\-validation auto\fP) and negative trust anchors @@ -429,8 +497,10 @@ Otherwise, it is written to the secroots dump file, which defaults to option in \fBnamed.conf\fP\&. .sp See also \fBrndc managed\-keys\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBserve\-stale\fP (\fBon\fP | \fBoff\fP | \fBreset\fP | \fBstatus\fP) [\fIclass\fP [\fIview\fP]] +.B serve\-stale (on | off | reset | status) [class [view]] This command enables, disables, resets, or reports the current status of the serving of stale answers as configured in \fBnamed.conf\fP\&. .sp @@ -441,13 +511,17 @@ serve\-stale reset\fP restores the setting as configured in \fBnamed.conf\fP\&. \fBrndc serve\-stale status\fP reports whether caching and serving of stale answers is currently enabled or disabled. It also reports the values of \fBstale\-answer\-ttl\fP and \fBmax\-stale\-ttl\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBshowzone\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B showzone zone [class [view]] This command prints the configuration of a running zone. .sp See also \fBrndc zonestatus\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBsign\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B sign zone [class [view]] This command fetches all DNSSEC keys for the given zone from the key directory (see the \fBkey\-directory\fP option in the BIND 9 Administrator Reference Manual). If they are within their publication period, they are merged into @@ -461,8 +535,10 @@ and also requires the zone to be configured to allow dynamic DNS. (See details.) .sp See also \fBrndc loadkeys\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBsigning\fP [(\fB\-list\fP | \fB\-clear\fP \fIkeyid/algorithm\fP | \fB\-clear\fP \fIall\fP | \fB\-nsec3param\fP ( \fIparameters\fP | none ) | \fB\-serial\fP \fIvalue\fP ) \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B signing [(\-list | \-clear keyid/algorithm | \-clear all | \-nsec3param (parameters | none) | \-serial value) zone [class [view]] 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 @@ -506,18 +582,24 @@ replaces it with NSEC. \fBvalue\fP\&. If the value would cause the serial number to go backwards, it is rejected. The primary use of this parameter is to set the serial number on inline signed zones. +.UNINDENT +.INDENT 0.0 .TP -.B \fBstats\fP +.B stats This command writes server statistics to the statistics file. (See the \fBstatistics\-file\fP option in the BIND 9 Administrator Reference Manual.) +.UNINDENT +.INDENT 0.0 .TP -.B \fBstatus\fP +.B status This command displays the status of the server. Note that the number of zones includes the internal \fBbind/CH\fP zone and the default \fB\&./IN\fP hint zone, if there is no explicit root zone configured. +.UNINDENT +.INDENT 0.0 .TP -\fBstop\fP \fB\-p\fP +.B stop \-p 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 \fB\-p\fP is specified, \fBnamed(8)\(ga\(aqs process ID is returned. @@ -525,13 +607,17 @@ This allows an external process to determine when \(ga\(ganamed\fP has completed stopping. .sp See also \fBrndc halt\fP\&. +.UNINDENT +.INDENT 0.0 .TP -\fBsync\fP \fB\-clean\fP [\fIzone\fP [\fIclass\fP [\fIview\fP]]] +.B sync \-clean [zone [class [view]]] 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. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtcp\-timeouts\fP [\fIinitial\fP \fIidle\fP \fIkeepalive\fP \fIadvertised\fP] +.B tcp\-timeouts [initial idle keepalive advertised] When called without arguments, this command displays the current values of the \fBtcp\-initial\-timeout\fP, \fBtcp\-idle\-timeout\fP, \fBtcp\-keepalive\-timeout\fP, and \fBtcp\-advertised\-timeout\fP options. @@ -539,8 +625,10 @@ When called with arguments, these values are updated. This allows an administrator to make rapid adjustments when under a denial\-of\-service (DoS) attack. See the descriptions of these options in the BIND 9 Administrator Reference Manual for details of their use. +.UNINDENT +.INDENT 0.0 .TP -.B \fBthaw\fP [\fIzone\fP [\fIclass\fP [\fIview\fP]]] +.B thaw [zone [class [view]]] 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 @@ -551,32 +639,44 @@ changes in the zone. Otherwise, if the zone has changed, any existing journal file is removed. .sp See also \fBrndc freeze\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtrace\fP +.B trace This command increments the server\(aqs debugging level by one. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtrace\fP \fIlevel\fP +.B trace level This command sets the server\(aqs debugging level to an explicit value. .sp See also \fBrndc notrace\fP\&. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtsig\-delete\fP \fIkeyname\fP [\fIview\fP] +.B tsig\-delete keyname [view] This command deletes a given TKEY\-negotiated key from the server. This does not apply to statically configured TSIG keys. +.UNINDENT +.INDENT 0.0 .TP -.B \fBtsig\-list\fP +.B tsig\-list This command lists the names of all TSIG keys currently configured for use by \fBnamed\fP in each view. The list includes both statically configured keys and dynamic TKEY\-negotiated keys. +.UNINDENT +.INDENT 0.0 .TP -\fBvalidation\fP (\fBon\fP | \fBoff\fP | \fBstatus\fP) [\fIview\fP ...]\(ga\(ga +.B validation (on | off | status) [view ...] This command enables, disables, or checks the current status of DNSSEC validation. By default, validation is enabled. .sp The cache is flushed when validation is turned on or off to avoid using data that might differ between states. +.UNINDENT +.INDENT 0.0 .TP -.B \fBzonestatus\fP \fIzone\fP [\fIclass\fP [\fIview\fP]] +.B zonestatus zone [class [view]] 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, @@ -587,7 +687,7 @@ signing, and the scheduled refresh or expiry times for the zone. See also \fBrndc showzone\fP\&. .UNINDENT .sp -\fBrndc\fP commands that specify zone names, such as \fBreload\fP, +\fBrndc\fP commands that specify zone names, such as \fBreload\fP \fBretransfer\fP, or \fBzonestatus\fP, can be ambiguous when applied to zones of type \fBredirect\fP\&. Redirect zones are always called \fB\&.\fP, and can be confused with zones of type \fBhint\fP or with secondary copies of the root diff --git a/doc/man/tsig-keygen.8in b/doc/man/tsig-keygen.8in index 868cc41d6f..b2424663e3 100644 --- a/doc/man/tsig-keygen.8in +++ b/doc/man/tsig-keygen.8in @@ -44,13 +44,15 @@ of the generated key. If no name is specified, the default is \fBtsig\-key\fP\&. .SH OPTIONS .INDENT 0.0 .TP -.B \fB\-a algorithm\fP +.B \-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. +.UNINDENT +.INDENT 0.0 .TP -.B \fB\-h\fP +.B \-h This option prints a short summary of options and arguments. .UNINDENT .SH SEE ALSO