mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-26 03:58:15 +00:00
Code Issues Releases Wiki Activity
bind/doc/man/delv.1in

412 lines
14 KiB
Plaintext
Raw Normal View History

Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
Regenerate man pages with docutils 0.17.1 The Debian 10 (buster) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.2.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2021-09-16 10:57:04 +02:00
.TH "DELV" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.SH NAME
delv \- DNS lookup and validation utility
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.SH SYNOPSIS
.sp
\fBdelv\fP [@server] [ [\fB\-4\fP] | [\fB\-6\fP] ] [\fB\-a\fP anchor\-file] [\fB\-b\fP address] [\fB\-c\fP class] [\fB\-d\fP level] [\fB\-i\fP] [\fB\-m\fP] [\fB\-p\fP port#] [\fB\-q\fP name] [\fB\-t\fP type] [\fB\-x\fP addr] [name] [type] [class] [queryopt...]
.sp
\fBdelv\fP [\fB\-h\fP]
.sp
\fBdelv\fP [\fB\-v\fP]
.sp
\fBdelv\fP [queryopt...] [query...]
.SH DESCRIPTION
.sp
\fBdelv\fP is a tool for sending DNS queries and validating the results,
Regenerate man pages with Sphinx 4.5.0 The Debian 11 (bullseye) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.5.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2022-04-22 13:05:10 +02:00
using the same internal resolver and validator logic as \fI\%named\fP\&.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
\fBdelv\fP sends to a specified name server all queries needed to
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
fetch and validate the requested data; this includes the original
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
requested query, subsequent queries to follow CNAME or DNAME chains,
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
queries for DNSKEY, and DS records to establish a chain of trust for
DNSSEC validation. It does not perform iterative resolution, but
simulates the behavior of a name server configured for DNSSEC validating
and forwarding.
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
By default, responses are validated using the built\-in DNSSEC trust anchor
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
for the root zone ("."). Records returned by \fBdelv\fP are either fully
validated or were not signed. If validation fails, an explanation of the
failure is included in the output; the validation process can be traced
in detail. Because \fBdelv\fP does not rely on an external server to carry
out validation, it can be used to check the validity of DNS responses in
environments where local name servers may not be trustworthy.
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
Unless it is told to query a specific name server, \fBdelv\fP tries
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
each of the servers listed in \fB/etc/resolv.conf\fP\&. If no usable server
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
addresses are found, \fBdelv\fP sends queries to the localhost
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
addresses (127.0.0.1 for IPv4, ::1 for IPv6).
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
When no command\-line arguments or options are given, \fBdelv\fP
performs an NS query for "." (the root zone).
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.SH SIMPLE USAGE
.sp
A typical invocation of \fBdelv\fP looks like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
delv @server name type
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
where:
.INDENT 0.0
.TP
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.
2022-03-02 15:12:17 +01:00
.B server
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
hostname, \fBdelv\fP resolves that name before querying that name
server (note, however, that this initial lookup is \fInot\fP validated by
DNSSEC).
.sp
If no \fBserver\fP argument is provided, \fBdelv\fP consults
\fB/etc/resolv.conf\fP; if an address is found there, it queries the
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
name server at that address. If either of the \fI\%\-4\fP or \fI\%\-6\fP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
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
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
for IPv6).
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B name
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
is the domain name to be looked up.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B type
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
indicates what type of query is required \- ANY, A, MX, etc.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
\fBtype\fP can be any valid query type. If no \fBtype\fP argument is
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
supplied, \fBdelv\fP performs a lookup for an A record.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-a anchor\-file
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option specifies a file from which to read DNSSEC trust anchors. The default
Use compile-time paths in the manual pages Replace the hard-coded paths for various BIND 9 files (configuration, pid, etc.) in the man pages and ARM with compile-time values using the sphinx-build replace system. This is more complicated, because the restructured text specification doesn't allow |substitions| inside ``code-blocks``, so for each specific file we had to create own substition which is sub-optimal, but it is only way how to do this without adding Sphinx extension.
2022-01-24 12:13:24 +01:00
is \fB@sysconfdir@/bind.keys\fP, which is included with BIND 9 and contains one
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
or more trust anchors for the root zone (".").
.sp
Keys that do not match the root zone name are ignored. An alternate
Add hyperlinks to dig/mdig/delv +options
2022-04-25 18:12:17 +02:00
key name can be specified using the \fI\%+root\fP option.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
Note: When reading the trust anchor file, \fBdelv\fP treats \fBtrust\-anchors\fP,
\fBinitial\-key\fP, and \fBstatic\-key\fP identically. That is, for a managed key,
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
it is the \fIinitial\fP key that is trusted; \fI\%RFC 5011\fP key management is not
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
supported. \fBdelv\fP does not consult the managed\-keys database maintained by
Regenerate man pages with Sphinx 4.5.0 The Debian 11 (bullseye) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.5.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2022-04-22 13:05:10 +02:00
\fI\%named\fP, which means that if either of the keys in \fB@sysconfdir@/bind.keys\fP is
Use compile-time paths in the manual pages Replace the hard-coded paths for various BIND 9 files (configuration, pid, etc.) in the man pages and ARM with compile-time values using the sphinx-build replace system. This is more complicated, because the restructured text specification doesn't allow |substitions| inside ``code-blocks``, so for each specific file we had to create own substition which is sub-optimal, but it is only way how to do this without adding Sphinx extension.
2022-01-24 12:13:24 +01:00
revoked and rolled over, \fB@sysconfdir@/bind.keys\fP must be updated to
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
use DNSSEC validation in \fBdelv\fP\&.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-b address
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
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#<port>\fP
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-c class
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option sets the query class for the requested data. Currently, only class
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
"IN" is supported in \fBdelv\fP and any other value is ignored.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-d level
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option sets the systemwide debug level to \fBlevel\fP\&. The allowed range is
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
Add hyperlinks to dig/mdig/delv +options
2022-04-25 18:12:17 +02:00
\fI\%+mtrace\fP, \fI\%+rtrace\fP, and \fI\%+vtrace\fP options below for
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
additional debugging details.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-h
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option displays the \fBdelv\fP help usage output and exits.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-i
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
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
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
Add hyperlinks to dig/mdig/delv +options
2022-04-25 18:12:17 +02:00
\fI\%dig +cd\fP\&.)
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-m
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option enables memory usage debugging.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-p port#
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
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
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
server that has been configured to listen for queries on a
non\-standard port number.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-q name
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option sets the query name to \fBname\fP\&. While the query name can be
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
specified without using the \fI\%\-q\fP option, it is sometimes necessary to
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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).
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-t type
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option sets the query type to \fBtype\fP, which can be any valid query type
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
supported in BIND 9 except for zone transfer types AXFR and IXFR. As
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
with \fI\%\-q\fP, this is useful to distinguish query\-name types or classes
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
when they are ambiguous. It is sometimes necessary to disambiguate
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
names from types.
.sp
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
The default query type is "A", unless the \fI\%\-x\fP option is supplied
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
to indicate a reverse lookup, in which case it is "PTR".
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-v
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option prints the \fBdelv\fP version and exits.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-x addr
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option performs a reverse lookup, mapping an address to a name. \fBaddr\fP
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
is an IPv4 address in dotted\-decimal notation, or a colon\-delimited
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
IPv6 address. When \fI\%\-x\fP is used, there is no need to provide the
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
\fBname\fP or \fBtype\fP arguments; \fBdelv\fP automatically performs a
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-4
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option forces \fBdelv\fP to only use IPv4.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
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.
2022-03-02 15:12:17 +01:00
.B \-6
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option forces \fBdelv\fP to only use IPv6.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.UNINDENT
.SH QUERY OPTIONS
.sp
\fBdelv\fP provides a number of query options which affect the way results
are displayed, and in some cases the way lookups are performed.
.sp
Each query option is identified by a keyword preceded by a plus sign
(\fB+\fP). Some keywords set or reset an option. These may be preceded by
the string \fBno\fP to negate the meaning of that keyword. Other keywords
assign values to options like the timeout interval. They have the form
\fB+keyword=value\fP\&. The query options are:
.INDENT 0.0
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +cdflag, +nocdflag
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option controls whether to set the CD (checking disabled) bit in queries
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
sent by \fBdelv\fP\&. This may be useful when troubleshooting DNSSEC
problems from behind a validating resolver. A validating resolver
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
blocks invalid responses, making it difficult to retrieve them
for analysis. Setting the CD flag on queries causes the resolver
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
to return invalid responses, which \fBdelv\fP can then validate
internally and report the errors in detail.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +class, +noclass
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option controls whether to display the CLASS when printing a record. The
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
default is to display the CLASS.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +ttl, +nottl
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option controls whether to display the TTL when printing a record. The
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
default is to display the TTL.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +rtrace, +nortrace
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles resolver fetch logging. This reports the name and type of each
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
query sent by \fBdelv\fP in the process of carrying out the resolution
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
and validation process, including the original query
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
and all subsequent queries to follow CNAMEs and to establish a chain
of trust for DNSSEC validation.
.sp
This is equivalent to setting the debug level to 1 in the "resolver"
logging category. Setting the systemwide debug level to 1 using the
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
\fI\%\-d\fP option produces the same output, but affects other
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
logging categories as well.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +mtrace, +nomtrace
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles message logging. This produces a detailed dump of the
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
responses received by \fBdelv\fP in the process of carrying out the
resolution and validation process.
.sp
This is equivalent to setting the debug level to 10 for the "packets"
module of the "resolver" logging category. Setting the systemwide
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
debug level to 10 using the \fI\%\-d\fP option produces the same
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
output, but affects other logging categories as well.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +vtrace, +novtrace
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles validation logging. This shows the internal process of the
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
validator as it determines whether an answer is validly signed,
unsigned, or invalid.
.sp
This is equivalent to setting the debug level to 3 for the
"validator" module of the "dnssec" logging category. Setting the
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
systemwide debug level to 3 using the \fI\%\-d\fP option produces the
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
same output, but affects other logging categories as well.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +short, +noshort
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles between verbose and terse answers. The default is to print the answer in a
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
verbose form.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +comments, +nocomments
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles the display of comment lines in the output. The default is to
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
print comments.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +rrcomments, +norrcomments
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles the display of per\-record comments in the output (for example,
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
human\-readable key information about DNSKEY records). The default is
to print per\-record comments.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +crypto, +nocrypto
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option toggles the display of cryptographic fields in DNSSEC records. The
contents of these fields are unnecessary to debug most DNSSEC
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
validation failures and removing them makes it easier to see the
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
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\&.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +trust, +notrust
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option controls whether to display the trust level when printing a record.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
The default is to display the trust level.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +split[=W], +nosplit
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option splits long hex\- or base64\-formatted fields in resource records into
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +all, +noall
Add hyperlinks to dig/mdig/delv +options
2022-04-25 18:12:17 +02:00
This option sets or clears the display options \fI\%+comments\fP,
\fI\%+rrcomments\fP, and \fI\%+trust\fP as a group.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +multiline, +nomultiline
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option prints long records (such as RRSIG, DNSKEY, and SOA records) in a
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +dnssec, +nodnssec
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option indicates whether to display RRSIG records in the \fBdelv\fP output.
Regenerate man pages with Sphinx 4.5.0 The Debian 11 (bullseye) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.5.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2022-04-22 13:05:10 +02:00
The default is to do so. Note that (unlike in \fI\%dig\fP) this does
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
\fInot\fP control whether to request DNSSEC records or to
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
validate them. DNSSEC records are always requested, and validation
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
always occurs unless suppressed by the use of \fI\%\-i\fP or
Add hyperlinks to dig/mdig/delv +options
2022-04-25 18:12:17 +02:00
\fI\%+noroot\fP\&.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +root[=ROOT], +noroot
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option indicates whether to perform conventional DNSSEC validation, and if so,
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
Add hyperlinks from program options to definition in man pages Side-effect of hyperlinking is that typos in program and option names are now detected by Sphinx. Candidate -options were detected using: find -name *.rst | xargs grep '``-[^`]' and then modified from ``-o`` to :option:`-o` using regex s/``\(-[^`]\+\)``/:option:`\1`/ + manual modifications where necessary. Non-hyphenated options were detected by looking at context around program names: find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u and grepping for program name with trailing whitespace. Stand-alone program names like ``named`` are not hyperlinked in this commit.
2022-03-02 16:54:31 +01:00
specifying a different trust anchor, then \fI\%\-a\fP must be used to specify a
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
file containing the key.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +tcp, +notcp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option controls whether to use TCP when sending queries. The default is to
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
use UDP unless a truncated response has been received.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +unknownformat, +nounknownformat
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option prints all RDATA in unknown RR\-type presentation format (\fI\%RFC 3597\fP).
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
The default is to print RDATA for known types in the type\(aqs
presentation format.
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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Split negative and positive dig/mdig/delv options to support Sphinx 1.4.9 Man pages for dig/mdig/delv used `.. option:: +[no]bla` to describe two options at once, and very old Sphinx does not support that [] in option names. Solution is to split negative and positive options into `+bla, +nobla` form. In the end it improves readability because it transforms hard to read strings with double brackets from `+[no]subnet=addr[/prefix-length]` to `+subnet=addr[/prefix-length], +nosubnet`. As a side-effect it also allows easier linking to dig/mdig/delv options using their name directly instead of always overriding the link target to `+[no]bla` form. Transformation was done using regex: s/:: +\[no\]\(.*\)/:: +\1, +no\1 ... and manual review around occurences matching regex +no.*= Fixes: #3301
2022-04-25 16:28:02 +02:00
.B +yaml, +noyaml
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
This option prints response data in YAML format.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.UNINDENT
.SH FILES
.sp
Use compile-time paths in the manual pages Replace the hard-coded paths for various BIND 9 files (configuration, pid, etc.) in the man pages and ARM with compile-time values using the sphinx-build replace system. This is more complicated, because the restructured text specification doesn't allow |substitions| inside ``code-blocks``, so for each specific file we had to create own substition which is sub-optimal, but it is only way how to do this without adding Sphinx extension.
2022-01-24 12:13:24 +01:00
\fB@sysconfdir@/bind.keys\fP
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.sp
\fB/etc/resolv.conf\fP
.SH SEE ALSO
.sp
Regenerate man pages with Sphinx 4.5.0 The Debian 11 (bullseye) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.5.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2022-04-22 13:05:10 +02:00
\fI\%dig(1)\fP, \fI\%named(8)\fP, \fI\%RFC 4034\fP, \fI\%RFC 4035\fP, \fI\%RFC 4431\fP, \fI\%RFC 5074\fP, \fI\%RFC 5155\fP\&.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
Update copyrights to 2022
2022-01-03 10:29:49 +01:00
2022, Internet Systems Consortium
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.\" Generated by docutils manpage writer.
.
Reference in New Issue Copy Permalink