contrib/bind9/bin/dig/dig.1

   1 .\" Copyright (C) 2004-2010, 2013 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000-2003 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id$
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: dig
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23 .\"      Date: Jun 30, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "DIG" "1" "Jun 30, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 dig \- DNS lookup utility
  34 .SH "SYNOPSIS"
  35 .HP 4
  36 \fBdig\fR [@server] [\fB\-b\ \fR\fB\fIaddress\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIfilename\fR\fR] [\fB\-k\ \fR\fB\fIfilename\fR\fR] [\fB\-m\fR] [\fB\-p\ \fR\fB\fIport#\fR\fR] [\fB\-q\ \fR\fB\fIname\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-x\ \fR\fB\fIaddr\fR\fR] [\fB\-y\ \fR\fB\fI[hmac:]\fR\fIname:key\fR\fR] [\fB\-4\fR] [\fB\-6\fR] [name] [type] [class] [queryopt...]
  37 .HP 4
  38 \fBdig\fR [\fB\-h\fR]
  39 .HP 4
  40 \fBdig\fR [global\-queryopt...] [query...]
  41 .SH "DESCRIPTION"
  42 .PP
  43 \fBdig\fR
  44 (domain information groper) is a flexible tool for interrogating DNS name servers. It performs DNS lookups and displays the answers that are returned from the name server(s) that were queried. Most DNS administrators use
  45 \fBdig\fR
  46 to troubleshoot DNS problems because of its flexibility, ease of use and clarity of output. Other lookup tools tend to have less functionality than
  47 \fBdig\fR.
  48 .PP
  49 Although
  50 \fBdig\fR
  51 is normally used with command\-line arguments, it also has a batch mode of operation for reading lookup requests from a file. A brief summary of its command\-line arguments and options is printed when the
  52 \fB\-h\fR
  53 option is given. Unlike earlier versions, the BIND 9 implementation of
  54 \fBdig\fR
  55 allows multiple lookups to be issued from the command line.
  56 .PP
  57 Unless it is told to query a specific name server,
  58 \fBdig\fR
  59 will try each of the servers listed in
  60 \fI/etc/resolv.conf\fR. If no usable server addreses are found,
  61 \fBdig\fR
  62 will send the query to the local host.
  63 .PP
  64 When no command line arguments or options are given,
  65 \fBdig\fR
  66 will perform an NS query for "." (the root).
  67 .PP
  68 It is possible to set per\-user defaults for
  69 \fBdig\fR
  70 via
  71 \fI${HOME}/.digrc\fR. This file is read and any options in it are applied before the command line arguments.
  72 .PP
  73 The IN and CH class names overlap with the IN and CH top level domains names. Either use the
  74 \fB\-t\fR
  75 and
  76 \fB\-c\fR
  77 options to specify the type and class, use the
  78 \fB\-q\fR
  79 the specify the domain name, or use "IN." and "CH." when looking up these top level domains.
  80 .SH "SIMPLE USAGE"
  81 .PP
  82 A typical invocation of
  83 \fBdig\fR
  84 looks like:
  85 .sp
  86 .RS 4
  87 .nf
  88  dig @server name type
  89 .fi
  90 .RE
  91 .sp
  92 where:
  93 .PP
  94 \fBserver\fR
  95 .RS 4
  96 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
  97 \fIserver\fR
  98 argument is a hostname,
  99 \fBdig\fR
 100 resolves that name before querying that name server.
 101 .sp
 102 If no
 103 \fIserver\fR
 104 argument is provided,
 105 \fBdig\fR
 106 consults
 107 \fI/etc/resolv.conf\fR; if an address is found there, it queries the name server at that address. If either of the
 108 \fB\-4\fR
 109 or
 110 \fB\-6\fR
 111 options are in use, then only addresses for the corresponding transport will be tried. If no usable addresses are found,
 112 \fBdig\fR
 113 will send the query to the local host. The reply from the name server that responds is displayed.
 114 .RE
 115 .PP
 116 \fBname\fR
 117 .RS 4
 118 is the name of the resource record that is to be looked up.
 119 .RE
 120 .PP
 121 \fBtype\fR
 122 .RS 4
 123 indicates what type of query is required \(em ANY, A, MX, SIG, etc.
 124 \fItype\fR
 125 can be any valid query type. If no
 126 \fItype\fR
 127 argument is supplied,
 128 \fBdig\fR
 129 will perform a lookup for an A record.
 130 .RE
 131 .SH "OPTIONS"
 132 .PP
 133 The
 134 \fB\-b\fR
 135 option sets the source IP address of the query to
 136 \fIaddress\fR. This must be a valid address on one of the host's network interfaces or "0.0.0.0" or "::". An optional port may be specified by appending "#<port>"
 137 .PP
 138 The default query class (IN for internet) is overridden by the
 139 \fB\-c\fR
 140 option.
 141 \fIclass\fR
 142 is any valid class, such as HS for Hesiod records or CH for Chaosnet records.
 143 .PP
 144 The
 145 \fB\-f\fR
 146 option makes
 147 \fBdig \fR
 148 operate in batch mode by reading a list of lookup requests to process from the file
 149 \fIfilename\fR. The file contains a number of queries, one per line. Each entry in the file should be organized in the same way they would be presented as queries to
 150 \fBdig\fR
 151 using the command\-line interface.
 152 .PP
 153 The
 154 \fB\-m\fR
 155 option enables memory usage debugging.
 156 .PP
 157 If a non\-standard port number is to be queried, the
 158 \fB\-p\fR
 159 option is used.
 160 \fIport#\fR
 161 is the port number that
 162 \fBdig\fR
 163 will send its queries instead of the standard DNS port number 53. This option would be used to test a name server that has been configured to listen for queries on a non\-standard port number.
 164 .PP
 165 The
 166 \fB\-4\fR
 167 option forces
 168 \fBdig\fR
 169 to only use IPv4 query transport. The
 170 \fB\-6\fR
 171 option forces
 172 \fBdig\fR
 173 to only use IPv6 query transport.
 174 .PP
 175 The
 176 \fB\-t\fR
 177 option sets the query type to
 178 \fItype\fR. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the
 179 \fB\-x\fR
 180 option is supplied to indicate a reverse lookup. A zone transfer can be requested by specifying a type of AXFR. When an incremental zone transfer (IXFR) is required,
 181 \fItype\fR
 182 is set to
 183 ixfr=N. The incremental zone transfer will contain the changes made to the zone since the serial number in the zone's SOA record was
 184 \fIN\fR.
 185 .PP
 186 The
 187 \fB\-q\fR
 188 option sets the query name to
 189 \fIname\fR. This useful do distinguish the
 190 \fIname\fR
 191 from other arguments.
 192 .PP
 193 Reverse lookups \(em mapping addresses to names \(em are simplified by the
 194 \fB\-x\fR
 195 option.
 196 \fIaddr\fR
 197 is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address. When this option is used, there is no need to provide the
 198 \fIname\fR,
 199 \fIclass\fR
 200 and
 201 \fItype\fR
 202 arguments.
 203 \fBdig\fR
 204 automatically performs a lookup for a name like
 205 11.12.13.10.in\-addr.arpa
 206 and sets the query type and class to PTR and IN respectively. By default, IPv6 addresses are looked up using nibble format under the IP6.ARPA domain. To use the older RFC1886 method using the IP6.INT domain specify the
 207 \fB\-i\fR
 208 option. Bit string labels (RFC2874) are now experimental and are not attempted.
 209 .PP
 210 To sign the DNS queries sent by
 211 \fBdig\fR
 212 and their responses using transaction signatures (TSIG), specify a TSIG key file using the
 213 \fB\-k\fR
 214 option. You can also specify the TSIG key itself on the command line using the
 215 \fB\-y\fR
 216 option;
 217 \fIhmac\fR
 218 is the type of the TSIG, default HMAC\-MD5,
 219 \fIname\fR
 220 is the name of the TSIG key and
 221 \fIkey\fR
 222 is the actual key. The key is a base\-64 encoded string, typically generated by
 223 \fBdnssec\-keygen\fR(8). Caution should be taken when using the
 224 \fB\-y\fR
 225 option on multi\-user systems as the key can be visible in the output from
 226 \fBps\fR(1)
 227 or in the shell's history file. When using TSIG authentication with
 228 \fBdig\fR, the name server that is queried needs to know the key and algorithm that is being used. In BIND, this is done by providing appropriate
 229 \fBkey\fR
 230 and
 231 \fBserver\fR
 232 statements in
 233 \fInamed.conf\fR.
 234 .SH "QUERY OPTIONS"
 235 .PP
 236 \fBdig\fR
 237 provides a number of query options which affect the way in which lookups are made and the results displayed. Some of these set or reset flag bits in the query header, some determine which sections of the answer get printed, and others determine the timeout and retry strategies.
 238 .PP
 239 Each query option is identified by a keyword preceded by a plus sign (+). Some keywords set or reset an option. These may be preceded by the string
 240 no
 241 to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form
 242 \fB+keyword=value\fR. The query options are:
 243 .PP
 244 \fB+[no]tcp\fR
 245 .RS 4
 246 Use [do not use] TCP when querying name servers. The default behavior is to use UDP unless an AXFR or IXFR query is requested, in which case a TCP connection is used.
 247 .RE
 248 .PP
 249 \fB+[no]vc\fR
 250 .RS 4
 251 Use [do not use] TCP when querying name servers. This alternate syntax to
 252 \fI+[no]tcp\fR
 253 is provided for backwards compatibility. The "vc" stands for "virtual circuit".
 254 .RE
 255 .PP
 256 \fB+[no]ignore\fR
 257 .RS 4
 258 Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed.
 259 .RE
 260 .PP
 261 \fB+domain=somename\fR
 262 .RS 4
 263 Set the search list to contain the single domain
 264 \fIsomename\fR, as if specified in a
 265 \fBdomain\fR
 266 directive in
 267 \fI/etc/resolv.conf\fR, and enable search list processing as if the
 268 \fI+search\fR
 269 option were given.
 270 .RE
 271 .PP
 272 \fB+[no]search\fR
 273 .RS 4
 274 Use [do not use] the search list defined by the searchlist or domain directive in
 275 \fIresolv.conf\fR
 276 (if any). The search list is not used by default.
 277 .RE
 278 .PP
 279 \fB+[no]showsearch\fR
 280 .RS 4
 281 Perform [do not perform] a search showing intermediate results.
 282 .RE
 283 .PP
 284 \fB+[no]defname\fR
 285 .RS 4
 286 Deprecated, treated as a synonym for
 287 \fI+[no]search\fR
 288 .RE
 289 .PP
 290 \fB+[no]aaonly\fR
 291 .RS 4
 292 Sets the "aa" flag in the query.
 293 .RE
 294 .PP
 295 \fB+[no]aaflag\fR
 296 .RS 4
 297 A synonym for
 298 \fI+[no]aaonly\fR.
 299 .RE
 300 .PP
 301 \fB+[no]adflag\fR
 302 .RS 4
 303 Set [do not set] the AD (authentic data) bit in the query. This requests the server to return whether all of the answer and authority sections have all been validated as secure according to the security policy of the server. AD=1 indicates that all records have been validated as secure and the answer is not from a OPT\-OUT range. AD=0 indicate that some part of the answer was insecure or not validated.
 304 .RE
 305 .PP
 306 \fB+[no]cdflag\fR
 307 .RS 4
 308 Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses.
 309 .RE
 310 .PP
 311 \fB+[no]cl\fR
 312 .RS 4
 313 Display [do not display] the CLASS when printing the record.
 314 .RE
 315 .PP
 316 \fB+[no]ttlid\fR
 317 .RS 4
 318 Display [do not display] the TTL when printing the record.
 319 .RE
 320 .PP
 321 \fB+[no]recurse\fR
 322 .RS 4
 323 Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means
 324 \fBdig\fR
 325 normally sends recursive queries. Recursion is automatically disabled when the
 326 \fI+nssearch\fR
 327 or
 328 \fI+trace\fR
 329 query options are used.
 330 .RE
 331 .PP
 332 \fB+[no]nssearch\fR
 333 .RS 4
 334 When this option is set,
 335 \fBdig\fR
 336 attempts to find the authoritative name servers for the zone containing the name being looked up and display the SOA record that each name server has for the zone.
 337 .RE
 338 .PP
 339 \fB+[no]trace\fR
 340 .RS 4
 341 Toggle tracing of the delegation path from the root name servers for the name being looked up. Tracing is disabled by default. When tracing is enabled,
 342 \fBdig\fR
 343 makes iterative queries to resolve the name being looked up. It will follow referrals from the root servers, showing the answer from each server that was used to resolve the lookup.
 344 .RE
 345 .PP
 346 \fB+[no]cmd\fR
 347 .RS 4
 348 Toggles the printing of the initial comment in the output identifying the version of
 349 \fBdig\fR
 350 and the query options that have been applied. This comment is printed by default.
 351 .RE
 352 .PP
 353 \fB+[no]short\fR
 354 .RS 4
 355 Provide a terse answer. The default is to print the answer in a verbose form.
 356 .RE
 357 .PP
 358 \fB+[no]identify\fR
 359 .RS 4
 360 Show [or do not show] the IP address and port number that supplied the answer when the
 361 \fI+short\fR
 362 option is enabled. If short form answers are requested, the default is not to show the source address and port number of the server that provided the answer.
 363 .RE
 364 .PP
 365 \fB+[no]comments\fR
 366 .RS 4
 367 Toggle the display of comment lines in the output. The default is to print comments.
 368 .RE
 369 .PP
 370 \fB+[no]stats\fR
 371 .RS 4
 372 This query option toggles the printing of statistics: when the query was made, the size of the reply and so on. The default behavior is to print the query statistics.
 373 .RE
 374 .PP
 375 \fB+[no]qr\fR
 376 .RS 4
 377 Print [do not print] the query as it is sent. By default, the query is not printed.
 378 .RE
 379 .PP
 380 \fB+[no]question\fR
 381 .RS 4
 382 Print [do not print] the question section of a query when an answer is returned. The default is to print the question section as a comment.
 383 .RE
 384 .PP
 385 \fB+[no]answer\fR
 386 .RS 4
 387 Display [do not display] the answer section of a reply. The default is to display it.
 388 .RE
 389 .PP
 390 \fB+[no]authority\fR
 391 .RS 4
 392 Display [do not display] the authority section of a reply. The default is to display it.
 393 .RE
 394 .PP
 395 \fB+[no]additional\fR
 396 .RS 4
 397 Display [do not display] the additional section of a reply. The default is to display it.
 398 .RE
 399 .PP
 400 \fB+[no]all\fR
 401 .RS 4
 402 Set or clear all display flags.
 403 .RE
 404 .PP
 405 \fB+time=T\fR
 406 .RS 4
 407 Sets the timeout for a query to
 408 \fIT\fR
 409 seconds. The default timeout is 5 seconds. An attempt to set
 410 \fIT\fR
 411 to less than 1 will result in a query timeout of 1 second being applied.
 412 .RE
 413 .PP
 414 \fB+tries=T\fR
 415 .RS 4
 416 Sets the number of times to try UDP queries to server to
 417 \fIT\fR
 418 instead of the default, 3. If
 419 \fIT\fR
 420 is less than or equal to zero, the number of tries is silently rounded up to 1.
 421 .RE
 422 .PP
 423 \fB+retry=T\fR
 424 .RS 4
 425 Sets the number of times to retry UDP queries to server to
 426 \fIT\fR
 427 instead of the default, 2. Unlike
 428 \fI+tries\fR, this does not include the initial query.
 429 .RE
 430 .PP
 431 \fB+ndots=D\fR
 432 .RS 4
 433 Set the number of dots that have to appear in
 434 \fIname\fR
 435 to
 436 \fID\fR
 437 for it to be considered absolute. The default value is that defined using the ndots statement in
 438 \fI/etc/resolv.conf\fR, or 1 if no ndots statement is present. Names with fewer dots are interpreted as relative names and will be searched for in the domains listed in the
 439 \fBsearch\fR
 440 or
 441 \fBdomain\fR
 442 directive in
 443 \fI/etc/resolv.conf\fR.
 444 .RE
 445 .PP
 446 \fB+bufsize=B\fR
 447 .RS 4
 448 Set the UDP message buffer size advertised using EDNS0 to
 449 \fIB\fR
 450 bytes. The maximum and minimum sizes of this buffer are 65535 and 0 respectively. Values outside this range are rounded up or down appropriately. Values other than zero will cause a EDNS query to be sent.
 451 .RE
 452 .PP
 453 \fB+edns=#\fR
 454 .RS 4
 455 Specify the EDNS version to query with. Valid values are 0 to 255. Setting the EDNS version will cause a EDNS query to be sent.
 456 \fB+noedns\fR
 457 clears the remembered EDNS version.
 458 .RE
 459 .PP
 460 \fB+[no]multiline\fR
 461 .RS 4
 462 Print records like the SOA records in a verbose multi\-line format with human\-readable comments. The default is to print each record on a single line, to facilitate machine parsing of the
 463 \fBdig\fR
 464 output.
 465 .RE
 466 .PP
 467 \fB+[no]onesoa\fR
 468 .RS 4
 469 Print only one (starting) SOA record when performing an AXFR. The default is to print both the starting and ending SOA records.
 470 .RE
 471 .PP
 472 \fB+[no]fail\fR
 473 .RS 4
 474 Do not try the next server if you receive a SERVFAIL. The default is to not try the next server which is the reverse of normal stub resolver behavior.
 475 .RE
 476 .PP
 477 \fB+[no]besteffort\fR
 478 .RS 4
 479 Attempt to display the contents of messages which are malformed. The default is to not display malformed answers.
 480 .RE
 481 .PP
 482 \fB+[no]dnssec\fR
 483 .RS 4
 484 Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query.
 485 .RE
 486 .PP
 487 \fB+[no]sigchase\fR
 488 .RS 4
 489 Chase DNSSEC signature chains. Requires dig be compiled with \-DDIG_SIGCHASE.
 490 .RE
 491 .PP
 492 \fB+trusted\-key=####\fR
 493 .RS 4
 494 Specifies a file containing trusted keys to be used with
 495 \fB+sigchase\fR. Each DNSKEY record must be on its own line.
 496 .sp
 497 If not specified,
 498 \fBdig\fR
 499 will look for
 500 \fI/etc/trusted\-key.key\fR
 501 then
 502 \fItrusted\-key.key\fR
 503 in the current directory.
 504 .sp
 505 Requires dig be compiled with \-DDIG_SIGCHASE.
 506 .RE
 507 .PP
 508 \fB+[no]topdown\fR
 509 .RS 4
 510 When chasing DNSSEC signature chains perform a top\-down validation. Requires dig be compiled with \-DDIG_SIGCHASE.
 511 .RE
 512 .PP
 513 \fB+[no]nsid\fR
 514 .RS 4
 515 Include an EDNS name server ID request when sending a query.
 516 .RE
 517 .SH "MULTIPLE QUERIES"
 518 .PP
 519 The BIND 9 implementation of
 520 \fBdig \fR
 521 supports specifying multiple queries on the command line (in addition to supporting the
 522 \fB\-f\fR
 523 batch file option). Each of those queries can be supplied with its own set of flags, options and query options.
 524 .PP
 525 In this case, each
 526 \fIquery\fR
 527 argument represent an individual query in the command\-line syntax described above. Each consists of any of the standard options and flags, the name to be looked up, an optional query type and class and any query options that should be applied to that query.
 528 .PP
 529 A global set of query options, which should be applied to all queries, can also be supplied. These global query options must precede the first tuple of name, class, type, options, flags, and query options supplied on the command line. Any global query options (except the
 530 \fB+[no]cmd\fR
 531 option) can be overridden by a query\-specific set of query options. For example:
 532 .sp
 533 .RS 4
 534 .nf
 535 dig +qr www.isc.org any \-x 127.0.0.1 isc.org ns +noqr
 536 .fi
 537 .RE
 538 .sp
 539 shows how
 540 \fBdig\fR
 541 could be used from the command line to make three lookups: an ANY query for
 542 www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of
 543 isc.org. A global query option of
 544 \fI+qr\fR
 545 is applied, so that
 546 \fBdig\fR
 547 shows the initial query it made for each lookup. The final query has a local query option of
 548 \fI+noqr\fR
 549 which means that
 550 \fBdig\fR
 551 will not print the initial query when it looks up the NS records for
 552 isc.org.
 553 .SH "IDN SUPPORT"
 554 .PP
 555 If
 556 \fBdig\fR
 557 has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names.
 558 \fBdig\fR
 559 appropriately converts character encoding of domain name before sending a request to DNS server or displaying a reply from the server. If you'd like to turn off the IDN support for some reason, defines the
 560 \fBIDN_DISABLE\fR
 561 environment variable. The IDN support is disabled if the variable is set when
 562 \fBdig\fR
 563 runs.
 564 .SH "FILES"
 565 .PP
 566 \fI/etc/resolv.conf\fR
 567 .PP
 568 \fI${HOME}/.digrc\fR
 569 .SH "SEE ALSO"
 570 .PP
 571 \fBhost\fR(1),
 572 \fBnamed\fR(8),
 573 \fBdnssec\-keygen\fR(8),
 574 RFC1035.
 575 .SH "BUGS"
 576 .PP
 577 There are probably too many query options.
 578 .SH "COPYRIGHT"
 579 Copyright \(co 2004\-2010, 2013 Internet Systems Consortium, Inc. ("ISC")
 580 .br
 581 Copyright \(co 2000\-2003 Internet Software Consortium.
 582 .br