1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3 [<!ENTITY mdash "—">]>
5 - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
6 - Copyright (C) 2000-2003 Internet Software Consortium.
8 - Permission to use, copy, modify, and/or distribute this software for any
9 - purpose with or without fee is hereby granted, provided that the above
10 - copyright notice and this permission notice appear in all copies.
12 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
13 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
14 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
15 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
16 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
17 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
18 - PERFORMANCE OF THIS SOFTWARE.
21 <!-- Id: dig.docbook,v 1.45 2009/02/02 04:41:28 marka Exp -->
22 <refentry id="man.dig">
25 <date>Jun 30, 2000</date>
29 <refentrytitle>dig</refentrytitle>
30 <manvolnum>1</manvolnum>
31 <refmiscinfo>BIND9</refmiscinfo>
35 <refname>dig</refname>
36 <refpurpose>DNS lookup utility</refpurpose>
47 <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
54 <holder>Internet Software Consortium.</holder>
60 <command>dig</command>
61 <arg choice="opt">@server</arg>
62 <arg><option>-b <replaceable class="parameter">address</replaceable></option></arg>
63 <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
64 <arg><option>-f <replaceable class="parameter">filename</replaceable></option></arg>
65 <arg><option>-k <replaceable class="parameter">filename</replaceable></option></arg>
66 <arg><option>-m</option></arg>
67 <arg><option>-p <replaceable class="parameter">port#</replaceable></option></arg>
68 <arg><option>-q <replaceable class="parameter">name</replaceable></option></arg>
69 <arg><option>-t <replaceable class="parameter">type</replaceable></option></arg>
70 <arg><option>-x <replaceable class="parameter">addr</replaceable></option></arg>
71 <arg><option>-y <replaceable class="parameter"><optional>hmac:</optional>name:key</replaceable></option></arg>
72 <arg><option>-4</option></arg>
73 <arg><option>-6</option></arg>
74 <arg choice="opt">name</arg>
75 <arg choice="opt">type</arg>
76 <arg choice="opt">class</arg>
77 <arg choice="opt" rep="repeat">queryopt</arg>
81 <command>dig</command>
82 <arg><option>-h</option></arg>
86 <command>dig</command>
87 <arg choice="opt" rep="repeat">global-queryopt</arg>
88 <arg choice="opt" rep="repeat">query</arg>
93 <title>DESCRIPTION</title>
94 <para><command>dig</command>
95 (domain information groper) is a flexible tool
96 for interrogating DNS name servers. It performs DNS lookups and
97 displays the answers that are returned from the name server(s) that
98 were queried. Most DNS administrators use <command>dig</command> to
99 troubleshoot DNS problems because of its flexibility, ease of use and
100 clarity of output. Other lookup tools tend to have less functionality
101 than <command>dig</command>.
105 Although <command>dig</command> is normally used with
107 arguments, it also has a batch mode of operation for reading lookup
108 requests from a file. A brief summary of its command-line arguments
109 and options is printed when the <option>-h</option> option is given.
110 Unlike earlier versions, the BIND 9 implementation of
111 <command>dig</command> allows multiple lookups to be issued
117 Unless it is told to query a specific name server,
118 <command>dig</command> will try each of the servers listed
120 <filename>/etc/resolv.conf</filename>.
124 When no command line arguments or options are given,
125 <command>dig</command> will perform an NS query for "." (the root).
129 It is possible to set per-user defaults for <command>dig</command> via
130 <filename>${HOME}/.digrc</filename>. This file is read and
132 are applied before the command line arguments.
136 The IN and CH class names overlap with the IN and CH top level
137 domains names. Either use the <option>-t</option> and
138 <option>-c</option> options to specify the type and class,
139 use the <option>-q</option> the specify the domain name, or
140 use "IN." and "CH." when looking up these top level domains.
146 <title>SIMPLE USAGE</title>
149 A typical invocation of <command>dig</command> looks like:
150 <programlisting> dig @server name type </programlisting>
156 <term><constant>server</constant></term>
159 is the name or IP address of the name server to query. This can
161 address in dotted-decimal notation or an IPv6
162 address in colon-delimited notation. When the supplied
163 <parameter>server</parameter> argument is a
165 <command>dig</command> resolves that name before
167 server. If no <parameter>server</parameter>
168 argument is provided,
169 <command>dig</command> consults <filename>/etc/resolv.conf</filename>
170 and queries the name servers listed there. The reply from the
172 server that responds is displayed.
178 <term><constant>name</constant></term>
181 is the name of the resource record that is to be looked up.
187 <term><constant>type</constant></term>
190 indicates what type of query is required —
191 ANY, A, MX, SIG, etc.
192 <parameter>type</parameter> can be any valid query
194 <parameter>type</parameter> argument is supplied,
195 <command>dig</command> will perform a lookup for an
207 <title>OPTIONS</title>
210 The <option>-b</option> option sets the source IP address of the query
211 to <parameter>address</parameter>. This must be a valid
213 one of the host's network interfaces or "0.0.0.0" or "::". An optional
215 may be specified by appending "#<port>"
219 The default query class (IN for internet) is overridden by the
220 <option>-c</option> option. <parameter>class</parameter> is
222 class, such as HS for Hesiod records or CH for Chaosnet records.
226 The <option>-f</option> option makes <command>dig </command>
228 in batch mode by reading a list of lookup requests to process from the
229 file <parameter>filename</parameter>. The file contains a
231 queries, one per line. Each entry in the file should be organized in
232 the same way they would be presented as queries to
233 <command>dig</command> using the command-line interface.
237 The <option>-m</option> option enables memory usage debugging.
238 <!-- It enables ISC_MEM_DEBUGTRACE and ISC_MEM_DEBUGRECORD
239 documented in include/isc/mem.h -->
243 If a non-standard port number is to be queried, the
244 <option>-p</option> option is used. <parameter>port#</parameter> is
245 the port number that <command>dig</command> will send its
247 instead of the standard DNS port number 53. This option would be used
248 to test a name server that has been configured to listen for queries
249 on a non-standard port number.
253 The <option>-4</option> option forces <command>dig</command>
255 use IPv4 query transport. The <option>-6</option> option forces
256 <command>dig</command> to only use IPv6 query transport.
260 The <option>-t</option> option sets the query type to
261 <parameter>type</parameter>. It can be any valid query type
263 supported in BIND 9. The default query type is "A", unless the
264 <option>-x</option> option is supplied to indicate a reverse lookup.
265 A zone transfer can be requested by specifying a type of AXFR. When
266 an incremental zone transfer (IXFR) is required,
267 <parameter>type</parameter> is set to <literal>ixfr=N</literal>.
268 The incremental zone transfer will contain the changes made to the zone
269 since the serial number in the zone's SOA record was
270 <parameter>N</parameter>.
274 The <option>-q</option> option sets the query name to
275 <parameter>name</parameter>. This useful do distinguish the
276 <parameter>name</parameter> from other arguments.
280 Reverse lookups — mapping addresses to names — are simplified by the
281 <option>-x</option> option. <parameter>addr</parameter> is
283 address in dotted-decimal notation, or a colon-delimited IPv6 address.
284 When this option is used, there is no need to provide the
285 <parameter>name</parameter>, <parameter>class</parameter> and
286 <parameter>type</parameter> arguments. <command>dig</command>
287 automatically performs a lookup for a name like
288 <literal>11.12.13.10.in-addr.arpa</literal> and sets the
290 class to PTR and IN respectively. By default, IPv6 addresses are
291 looked up using nibble format under the IP6.ARPA domain.
292 To use the older RFC1886 method using the IP6.INT domain
293 specify the <option>-i</option> option. Bit string labels (RFC2874)
294 are now experimental and are not attempted.
298 To sign the DNS queries sent by <command>dig</command> and
300 responses using transaction signatures (TSIG), specify a TSIG key file
301 using the <option>-k</option> option. You can also specify the TSIG
302 key itself on the command line using the <option>-y</option> option;
303 <parameter>hmac</parameter> is the type of the TSIG, default HMAC-MD5,
304 <parameter>name</parameter> is the name of the TSIG key and
305 <parameter>key</parameter> is the actual key. The key is a
307 encoded string, typically generated by
309 <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
312 Caution should be taken when using the <option>-y</option> option on
313 multi-user systems as the key can be visible in the output from
315 <refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>
317 or in the shell's history file. When
318 using TSIG authentication with <command>dig</command>, the name
319 server that is queried needs to know the key and algorithm that is
320 being used. In BIND, this is done by providing appropriate
321 <command>key</command> and <command>server</command> statements in
322 <filename>named.conf</filename>.
328 <title>QUERY OPTIONS</title>
330 <para><command>dig</command>
331 provides a number of query options which affect
332 the way in which lookups are made and the results displayed. Some of
333 these set or reset flag bits in the query header, some determine which
334 sections of the answer get printed, and others determine the timeout
335 and retry strategies.
339 Each query option is identified by a keyword preceded by a plus sign
340 (<literal>+</literal>). Some keywords set or reset an
341 option. These may be preceded
342 by the string <literal>no</literal> to negate the meaning of
344 keywords assign values to options like the timeout interval. They
345 have the form <option>+keyword=value</option>.
346 The query options are:
351 <term><option>+[no]tcp</option></term>
354 Use [do not use] TCP when querying name servers. The default
355 behavior is to use UDP unless an AXFR or IXFR query is
357 which case a TCP connection is used.
363 <term><option>+[no]vc</option></term>
366 Use [do not use] TCP when querying name servers. This alternate
367 syntax to <parameter>+[no]tcp</parameter> is
368 provided for backwards
369 compatibility. The "vc" stands for "virtual circuit".
375 <term><option>+[no]ignore</option></term>
378 Ignore truncation in UDP responses instead of retrying with TCP.
380 default, TCP retries are performed.
386 <term><option>+domain=somename</option></term>
389 Set the search list to contain the single domain
390 <parameter>somename</parameter>, as if specified in
392 <command>domain</command> directive in
393 <filename>/etc/resolv.conf</filename>, and enable
395 processing as if the <parameter>+search</parameter>
402 <term><option>+[no]search</option></term>
405 Use [do not use] the search list defined by the searchlist or
407 directive in <filename>resolv.conf</filename> (if
409 The search list is not used by default.
415 <term><option>+[no]showsearch</option></term>
418 Perform [do not perform] a search showing intermediate
425 <term><option>+[no]defname</option></term>
428 Deprecated, treated as a synonym for <parameter>+[no]search</parameter>
434 <term><option>+[no]aaonly</option></term>
437 Sets the "aa" flag in the query.
443 <term><option>+[no]aaflag</option></term>
446 A synonym for <parameter>+[no]aaonly</parameter>.
452 <term><option>+[no]adflag</option></term>
455 Set [do not set] the AD (authentic data) bit in the
456 query. This requests the server to return whether
457 all of the answer and authority sections have all
458 been validated as secure according to the security
459 policy of the server. AD=1 indicates that all records
460 have been validated as secure and the answer is not
461 from a OPT-OUT range. AD=0 indicate that some part
462 of the answer was insecure or not validated.
468 <term><option>+[no]cdflag</option></term>
471 Set [do not set] the CD (checking disabled) bit in the query.
473 requests the server to not perform DNSSEC validation of
480 <term><option>+[no]cl</option></term>
483 Display [do not display] the CLASS when printing the record.
489 <term><option>+[no]ttlid</option></term>
492 Display [do not display] the TTL when printing the record.
498 <term><option>+[no]recurse</option></term>
501 Toggle the setting of the RD (recursion desired) bit in the
503 This bit is set by default, which means <command>dig</command>
504 normally sends recursive queries. Recursion is automatically
506 when the <parameter>+nssearch</parameter> or
507 <parameter>+trace</parameter> query options are
514 <term><option>+[no]nssearch</option></term>
517 When this option is set, <command>dig</command>
519 authoritative name servers for the zone containing the name
521 looked up and display the SOA record that each name server has
529 <term><option>+[no]trace</option></term>
532 Toggle tracing of the delegation path from the root name servers
534 the name being looked up. Tracing is disabled by default. When
535 tracing is enabled, <command>dig</command> makes
537 resolve the name being looked up. It will follow referrals from
539 root servers, showing the answer from each server that was used
547 <term><option>+[no]cmd</option></term>
550 Toggles the printing of the initial comment in the output
552 the version of <command>dig</command> and the query
554 been applied. This comment is printed by default.
560 <term><option>+[no]short</option></term>
563 Provide a terse answer. The default is to print the answer in a
570 <term><option>+[no]identify</option></term>
573 Show [or do not show] the IP address and port number that
575 answer when the <parameter>+short</parameter> option
577 short form answers are requested, the default is not to show the
578 source address and port number of the server that provided the
585 <term><option>+[no]comments</option></term>
588 Toggle the display of comment lines in the output. The default
596 <term><option>+[no]stats</option></term>
599 This query option toggles the printing of statistics: when the
601 was made, the size of the reply and so on. The default
603 to print the query statistics.
609 <term><option>+[no]qr</option></term>
612 Print [do not print] the query as it is sent.
613 By default, the query is not printed.
619 <term><option>+[no]question</option></term>
622 Print [do not print] the question section of a query when an
624 returned. The default is to print the question section as a
631 <term><option>+[no]answer</option></term>
634 Display [do not display] the answer section of a reply. The
642 <term><option>+[no]authority</option></term>
645 Display [do not display] the authority section of a reply. The
646 default is to display it.
652 <term><option>+[no]additional</option></term>
655 Display [do not display] the additional section of a reply.
656 The default is to display it.
662 <term><option>+[no]all</option></term>
665 Set or clear all display flags.
671 <term><option>+time=T</option></term>
675 Sets the timeout for a query to
676 <parameter>T</parameter> seconds. The default
677 timeout is 5 seconds.
678 An attempt to set <parameter>T</parameter> to less
680 in a query timeout of 1 second being applied.
686 <term><option>+tries=T</option></term>
689 Sets the number of times to try UDP queries to server to
690 <parameter>T</parameter> instead of the default, 3.
692 <parameter>T</parameter> is less than or equal to
694 tries is silently rounded up to 1.
700 <term><option>+retry=T</option></term>
703 Sets the number of times to retry UDP queries to server to
704 <parameter>T</parameter> instead of the default, 2.
706 <parameter>+tries</parameter>, this does not include
714 <term><option>+ndots=D</option></term>
717 Set the number of dots that have to appear in
718 <parameter>name</parameter> to <parameter>D</parameter> for it to be
719 considered absolute. The default value is that defined using
721 ndots statement in <filename>/etc/resolv.conf</filename>, or 1 if no
722 ndots statement is present. Names with fewer dots are
724 relative names and will be searched for in the domains listed in
726 <option>search</option> or <option>domain</option> directive in
727 <filename>/etc/resolv.conf</filename>.
733 <term><option>+bufsize=B</option></term>
736 Set the UDP message buffer size advertised using EDNS0 to
737 <parameter>B</parameter> bytes. The maximum and minimum sizes
738 of this buffer are 65535 and 0 respectively. Values outside
739 this range are rounded up or down appropriately.
740 Values other than zero will cause a EDNS query to be sent.
746 <term><option>+edns=#</option></term>
749 Specify the EDNS version to query with. Valid values
750 are 0 to 255. Setting the EDNS version will cause a
751 EDNS query to be sent. <option>+noedns</option> clears the
752 remembered EDNS version.
758 <term><option>+[no]multiline</option></term>
761 Print records like the SOA records in a verbose multi-line
762 format with human-readable comments. The default is to print
763 each record on a single line, to facilitate machine parsing
764 of the <command>dig</command> output.
770 <term><option>+[no]fail</option></term>
773 Do not try the next server if you receive a SERVFAIL. The
775 to not try the next server which is the reverse of normal stub
783 <term><option>+[no]besteffort</option></term>
786 Attempt to display the contents of messages which are malformed.
787 The default is to not display malformed answers.
793 <term><option>+[no]dnssec</option></term>
796 Requests DNSSEC records be sent by setting the DNSSEC OK bit
798 in the OPT record in the additional section of the query.
804 <term><option>+[no]sigchase</option></term>
807 Chase DNSSEC signature chains. Requires dig be compiled with
814 <term><option>+trusted-key=####</option></term>
817 Specifies a file containing trusted keys to be used with
818 <option>+sigchase</option>. Each DNSKEY record must be
822 If not specified, <command>dig</command> will look for
823 <filename>/etc/trusted-key.key</filename> then
824 <filename>trusted-key.key</filename> in the current directory.
827 Requires dig be compiled with -DDIG_SIGCHASE.
833 <term><option>+[no]topdown</option></term>
836 When chasing DNSSEC signature chains perform a top-down
838 Requires dig be compiled with -DDIG_SIGCHASE.
844 <term><option>+[no]nsid</option></term>
847 Include an EDNS name server ID request when sending a query.
859 <title>MULTIPLE QUERIES</title>
862 The BIND 9 implementation of <command>dig </command>
864 specifying multiple queries on the command line (in addition to
865 supporting the <option>-f</option> batch file option). Each of those
866 queries can be supplied with its own set of flags, options and query
871 In this case, each <parameter>query</parameter> argument
873 individual query in the command-line syntax described above. Each
874 consists of any of the standard options and flags, the name to be
875 looked up, an optional query type and class and any query options that
876 should be applied to that query.
880 A global set of query options, which should be applied to all queries,
881 can also be supplied. These global query options must precede the
882 first tuple of name, class, type, options, flags, and query options
883 supplied on the command line. Any global query options (except
884 the <option>+[no]cmd</option> option) can be
885 overridden by a query-specific set of query options. For example:
887 dig +qr www.isc.org any -x 127.0.0.1 isc.org ns +noqr
889 shows how <command>dig</command> could be used from the
891 to make three lookups: an ANY query for <literal>www.isc.org</literal>, a
892 reverse lookup of 127.0.0.1 and a query for the NS records of
893 <literal>isc.org</literal>.
895 A global query option of <parameter>+qr</parameter> is
897 that <command>dig</command> shows the initial query it made
899 lookup. The final query has a local query option of
900 <parameter>+noqr</parameter> which means that <command>dig</command>
901 will not print the initial query when it looks up the NS records for
902 <literal>isc.org</literal>.
908 <title>IDN SUPPORT</title>
910 If <command>dig</command> has been built with IDN (internationalized
911 domain name) support, it can accept and display non-ASCII domain names.
912 <command>dig</command> appropriately converts character encoding of
913 domain name before sending a request to DNS server or displaying a
914 reply from the server.
915 If you'd like to turn off the IDN support for some reason, defines
916 the <envar>IDN_DISABLE</envar> environment variable.
917 The IDN support is disabled if the variable is set when
918 <command>dig</command> runs.
924 <para><filename>/etc/resolv.conf</filename>
926 <para><filename>${HOME}/.digrc</filename>
931 <title>SEE ALSO</title>
933 <refentrytitle>host</refentrytitle><manvolnum>1</manvolnum>
936 <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
939 <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
941 <citetitle>RFC1035</citetitle>.
948 There are probably too many query options.