contrib/bind9/bin/dig/dig.1

   1 .\" Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000-2003 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and 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: dig.1,v 1.23.18.22 2007/05/16 06:11:27 marka Exp $
  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\-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.
  61 .PP
  62 When no command line arguments or options are given, will perform an NS query for "." (the root).
  63 .PP
  64 It is possible to set per\-user defaults for
  65 \fBdig\fR
  66 via
  67 \fI${HOME}/.digrc\fR. This file is read and any options in it are applied before the command line arguments.
  68 .PP
  69 The IN and CH class names overlap with the IN and CH top level domains names. Either use the
  70 \fB\-t\fR
  71 and
  72 \fB\-c\fR
  73 options to specify the type and class or use the
  74 \fB\-q\fR
  75 the specify the domain name or use "IN." and "CH." when looking up these top level domains.
  76 .SH "SIMPLE USAGE"
  77 .PP
  78 A typical invocation of
  79 \fBdig\fR
  80 looks like:
  81 .sp
  82 .RS 4
  83 .nf
  84  dig @server name type
  85 .fi
  86 .RE
  87 .sp
  88 where:
  89 .PP
  90 \fBserver\fR
  91 .RS 4
  92 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
  93 \fIserver\fR
  94 argument is a hostname,
  95 \fBdig\fR
  96 resolves that name before querying that name server. If no
  97 \fIserver\fR
  98 argument is provided,
  99 \fBdig\fR
 100 consults
 101 \fI/etc/resolv.conf\fR
 102 and queries the name servers listed there. The reply from the name server that responds is displayed.
 103 .RE
 104 .PP
 105 \fBname\fR
 106 .RS 4
 107 is the name of the resource record that is to be looked up.
 108 .RE
 109 .PP
 110 \fBtype\fR
 111 .RS 4
 112 indicates what type of query is required \(em ANY, A, MX, SIG, etc.
 113 \fItype\fR
 114 can be any valid query type. If no
 115 \fItype\fR
 116 argument is supplied,
 117 \fBdig\fR
 118 will perform a lookup for an A record.
 119 .RE
 120 .SH "OPTIONS"
 121 .PP
 122 The
 123 \fB\-b\fR
 124 option sets the source IP address of the query to
 125 \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>"
 126 .PP
 127 The default query class (IN for internet) is overridden by the
 128 \fB\-c\fR
 129 option.
 130 \fIclass\fR
 131 is any valid class, such as HS for Hesiod records or CH for Chaosnet records.
 132 .PP
 133 The
 134 \fB\-f\fR
 135 option makes
 136 \fBdig \fR
 137 operate in batch mode by reading a list of lookup requests to process from the file
 138 \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
 139 \fBdig\fR
 140 using the command\-line interface.
 141 .PP
 142 If a non\-standard port number is to be queried, the
 143 \fB\-p\fR
 144 option is used.
 145 \fIport#\fR
 146 is the port number that
 147 \fBdig\fR
 148 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.
 149 .PP
 150 The
 151 \fB\-4\fR
 152 option forces
 153 \fBdig\fR
 154 to only use IPv4 query transport. The
 155 \fB\-6\fR
 156 option forces
 157 \fBdig\fR
 158 to only use IPv6 query transport.
 159 .PP
 160 The
 161 \fB\-t\fR
 162 option sets the query type to
 163 \fItype\fR. It can be any valid query type which is supported in BIND 9. The default query type is "A", unless the
 164 \fB\-x\fR
 165 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,
 166 \fItype\fR
 167 is set to
 168 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
 169 \fIN\fR.
 170 .PP
 171 The
 172 \fB\-q\fR
 173 option sets the query name to
 174 \fIname\fR. This useful do distinguish the
 175 \fIname\fR
 176 from other arguments.
 177 .PP
 178 Reverse lookups \(em mapping addresses to names \(em are simplified by the
 179 \fB\-x\fR
 180 option.
 181 \fIaddr\fR
 182 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
 183 \fIname\fR,
 184 \fIclass\fR
 185 and
 186 \fItype\fR
 187 arguments.
 188 \fBdig\fR
 189 automatically performs a lookup for a name like
 190 11.12.13.10.in\-addr.arpa
 191 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
 192 \fB\-i\fR
 193 option. Bit string labels (RFC2874) are now experimental and are not attempted.
 194 .PP
 195 To sign the DNS queries sent by
 196 \fBdig\fR
 197 and their responses using transaction signatures (TSIG), specify a TSIG key file using the
 198 \fB\-k\fR
 199 option. You can also specify the TSIG key itself on the command line using the
 200 \fB\-y\fR
 201 option;
 202 \fIhmac\fR
 203 is the type of the TSIG, default HMAC\-MD5,
 204 \fIname\fR
 205 is the name of the TSIG key and
 206 \fIkey\fR
 207 is the actual key. The key is a base\-64 encoded string, typically generated by
 208 \fBdnssec\-keygen\fR(8). Caution should be taken when using the
 209 \fB\-y\fR
 210 option on multi\-user systems as the key can be visible in the output from
 211 \fBps\fR(1)
 212 or in the shell's history file. When using TSIG authentication with
 213 \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
 214 \fBkey\fR
 215 and
 216 \fBserver\fR
 217 statements in
 218 \fInamed.conf\fR.
 219 .SH "QUERY OPTIONS"
 220 .PP
 221 \fBdig\fR
 222 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.
 223 .PP
 224 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
 225 no
 226 to negate the meaning of that keyword. Other keywords assign values to options like the timeout interval. They have the form
 227 \fB+keyword=value\fR. The query options are:
 228 .PP
 229 \fB+[no]tcp\fR
 230 .RS 4
 231 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.
 232 .RE
 233 .PP
 234 \fB+[no]vc\fR
 235 .RS 4
 236 Use [do not use] TCP when querying name servers. This alternate syntax to
 237 \fI+[no]tcp\fR
 238 is provided for backwards compatibility. The "vc" stands for "virtual circuit".
 239 .RE
 240 .PP
 241 \fB+[no]ignore\fR
 242 .RS 4
 243 Ignore truncation in UDP responses instead of retrying with TCP. By default, TCP retries are performed.
 244 .RE
 245 .PP
 246 \fB+domain=somename\fR
 247 .RS 4
 248 Set the search list to contain the single domain
 249 \fIsomename\fR, as if specified in a
 250 \fBdomain\fR
 251 directive in
 252 \fI/etc/resolv.conf\fR, and enable search list processing as if the
 253 \fI+search\fR
 254 option were given.
 255 .RE
 256 .PP
 257 \fB+[no]search\fR
 258 .RS 4
 259 Use [do not use] the search list defined by the searchlist or domain directive in
 260 \fIresolv.conf\fR
 261 (if any). The search list is not used by default.
 262 .RE
 263 .PP
 264 \fB+[no]showsearch\fR
 265 .RS 4
 266 Perform [do not perform] a search showing intermediate results.
 267 .RE
 268 .PP
 269 \fB+[no]defname\fR
 270 .RS 4
 271 Deprecated, treated as a synonym for
 272 \fI+[no]search\fR
 273 .RE
 274 .PP
 275 \fB+[no]aaonly\fR
 276 .RS 4
 277 Sets the "aa" flag in the query.
 278 .RE
 279 .PP
 280 \fB+[no]aaflag\fR
 281 .RS 4
 282 A synonym for
 283 \fI+[no]aaonly\fR.
 284 .RE
 285 .PP
 286 \fB+[no]adflag\fR
 287 .RS 4
 288 Set [do not set] the AD (authentic data) bit in the query. The AD bit currently has a standard meaning only in responses, not in queries, but the ability to set the bit in the query is provided for completeness.
 289 .RE
 290 .PP
 291 \fB+[no]cdflag\fR
 292 .RS 4
 293 Set [do not set] the CD (checking disabled) bit in the query. This requests the server to not perform DNSSEC validation of responses.
 294 .RE
 295 .PP
 296 \fB+[no]cl\fR
 297 .RS 4
 298 Display [do not display] the CLASS when printing the record.
 299 .RE
 300 .PP
 301 \fB+[no]ttlid\fR
 302 .RS 4
 303 Display [do not display] the TTL when printing the record.
 304 .RE
 305 .PP
 306 \fB+[no]recurse\fR
 307 .RS 4
 308 Toggle the setting of the RD (recursion desired) bit in the query. This bit is set by default, which means
 309 \fBdig\fR
 310 normally sends recursive queries. Recursion is automatically disabled when the
 311 \fI+nssearch\fR
 312 or
 313 \fI+trace\fR
 314 query options are used.
 315 .RE
 316 .PP
 317 \fB+[no]nssearch\fR
 318 .RS 4
 319 When this option is set,
 320 \fBdig\fR
 321 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.
 322 .RE
 323 .PP
 324 \fB+[no]trace\fR
 325 .RS 4
 326 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,
 327 \fBdig\fR
 328 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.
 329 .RE
 330 .PP
 331 \fB+[no]cmd\fR
 332 .RS 4
 333 Toggles the printing of the initial comment in the output identifying the version of
 334 \fBdig\fR
 335 and the query options that have been applied. This comment is printed by default.
 336 .RE
 337 .PP
 338 \fB+[no]short\fR
 339 .RS 4
 340 Provide a terse answer. The default is to print the answer in a verbose form.
 341 .RE
 342 .PP
 343 \fB+[no]identify\fR
 344 .RS 4
 345 Show [or do not show] the IP address and port number that supplied the answer when the
 346 \fI+short\fR
 347 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.
 348 .RE
 349 .PP
 350 \fB+[no]comments\fR
 351 .RS 4
 352 Toggle the display of comment lines in the output. The default is to print comments.
 353 .RE
 354 .PP
 355 \fB+[no]stats\fR
 356 .RS 4
 357 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.
 358 .RE
 359 .PP
 360 \fB+[no]qr\fR
 361 .RS 4
 362 Print [do not print] the query as it is sent. By default, the query is not printed.
 363 .RE
 364 .PP
 365 \fB+[no]question\fR
 366 .RS 4
 367 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.
 368 .RE
 369 .PP
 370 \fB+[no]answer\fR
 371 .RS 4
 372 Display [do not display] the answer section of a reply. The default is to display it.
 373 .RE
 374 .PP
 375 \fB+[no]authority\fR
 376 .RS 4
 377 Display [do not display] the authority section of a reply. The default is to display it.
 378 .RE
 379 .PP
 380 \fB+[no]additional\fR
 381 .RS 4
 382 Display [do not display] the additional section of a reply. The default is to display it.
 383 .RE
 384 .PP
 385 \fB+[no]all\fR
 386 .RS 4
 387 Set or clear all display flags.
 388 .RE
 389 .PP
 390 \fB+time=T\fR
 391 .RS 4
 392 Sets the timeout for a query to
 393 \fIT\fR
 394 seconds. The default timeout is 5 seconds. An attempt to set
 395 \fIT\fR
 396 to less than 1 will result in a query timeout of 1 second being applied.
 397 .RE
 398 .PP
 399 \fB+tries=T\fR
 400 .RS 4
 401 Sets the number of times to try UDP queries to server to
 402 \fIT\fR
 403 instead of the default, 3. If
 404 \fIT\fR
 405 is less than or equal to zero, the number of tries is silently rounded up to 1.
 406 .RE
 407 .PP
 408 \fB+retry=T\fR
 409 .RS 4
 410 Sets the number of times to retry UDP queries to server to
 411 \fIT\fR
 412 instead of the default, 2. Unlike
 413 \fI+tries\fR, this does not include the initial query.
 414 .RE
 415 .PP
 416 \fB+ndots=D\fR
 417 .RS 4
 418 Set the number of dots that have to appear in
 419 \fIname\fR
 420 to
 421 \fID\fR
 422 for it to be considered absolute. The default value is that defined using the ndots statement in
 423 \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
 424 \fBsearch\fR
 425 or
 426 \fBdomain\fR
 427 directive in
 428 \fI/etc/resolv.conf\fR.
 429 .RE
 430 .PP
 431 \fB+bufsize=B\fR
 432 .RS 4
 433 Set the UDP message buffer size advertised using EDNS0 to
 434 \fIB\fR
 435 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.
 436 .RE
 437 .PP
 438 \fB+edns=#\fR
 439 .RS 4
 440 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.
 441 \fB+noedns\fR
 442 clears the remembered EDNS version.
 443 .RE
 444 .PP
 445 \fB+[no]multiline\fR
 446 .RS 4
 447 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
 448 \fBdig\fR
 449 output.
 450 .RE
 451 .PP
 452 \fB+[no]fail\fR
 453 .RS 4
 454 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.
 455 .RE
 456 .PP
 457 \fB+[no]besteffort\fR
 458 .RS 4
 459 Attempt to display the contents of messages which are malformed. The default is to not display malformed answers.
 460 .RE
 461 .PP
 462 \fB+[no]dnssec\fR
 463 .RS 4
 464 Requests DNSSEC records be sent by setting the DNSSEC OK bit (DO) in the OPT record in the additional section of the query.
 465 .RE
 466 .PP
 467 \fB+[no]sigchase\fR
 468 .RS 4
 469 Chase DNSSEC signature chains. Requires dig be compiled with \-DDIG_SIGCHASE.
 470 .RE
 471 .PP
 472 \fB+trusted\-key=####\fR
 473 .RS 4
 474 Specifies a file containing trusted keys to be used with
 475 \fB+sigchase\fR. Each DNSKEY record must be on its own line.
 476 .sp
 477 If not specified
 478 \fBdig\fR
 479 will look for
 480 \fI/etc/trusted\-key.key\fR
 481 then
 482 \fItrusted\-key.key\fR
 483 in the current directory.
 484 .sp
 485 Requires dig be compiled with \-DDIG_SIGCHASE.
 486 .RE
 487 .PP
 488 \fB+[no]topdown\fR
 489 .RS 4
 490 When chasing DNSSEC signature chains perform a top\-down validation. Requires dig be compiled with \-DDIG_SIGCHASE.
 491 .RE
 492 .SH "MULTIPLE QUERIES"
 493 .PP
 494 The BIND 9 implementation of
 495 \fBdig \fR
 496 supports specifying multiple queries on the command line (in addition to supporting the
 497 \fB\-f\fR
 498 batch file option). Each of those queries can be supplied with its own set of flags, options and query options.
 499 .PP
 500 In this case, each
 501 \fIquery\fR
 502 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.
 503 .PP
 504 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
 505 \fB+[no]cmd\fR
 506 option) can be overridden by a query\-specific set of query options. For example:
 507 .sp
 508 .RS 4
 509 .nf
 510 dig +qr www.isc.org any \-x 127.0.0.1 isc.org ns +noqr
 511 .fi
 512 .RE
 513 .sp
 514 shows how
 515 \fBdig\fR
 516 could be used from the command line to make three lookups: an ANY query for
 517 www.isc.org, a reverse lookup of 127.0.0.1 and a query for the NS records of
 518 isc.org. A global query option of
 519 \fI+qr\fR
 520 is applied, so that
 521 \fBdig\fR
 522 shows the initial query it made for each lookup. The final query has a local query option of
 523 \fI+noqr\fR
 524 which means that
 525 \fBdig\fR
 526 will not print the initial query when it looks up the NS records for
 527 isc.org.
 528 .SH "IDN SUPPORT"
 529 .PP
 530 If
 531 \fBdig\fR
 532 has been built with IDN (internationalized domain name) support, it can accept and display non\-ASCII domain names.
 533 \fBdig\fR
 534 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
 535 \fBIDN_DISABLE\fR
 536 environment variable. The IDN support is disabled if the variable is set when
 537 \fBdig\fR
 538 runs.
 539 .SH "FILES"
 540 .PP
 541 \fI/etc/resolv.conf\fR
 542 .PP
 543 \fI${HOME}/.digrc\fR
 544 .SH "SEE ALSO"
 545 .PP
 546 \fBhost\fR(1),
 547 \fBnamed\fR(8),
 548 \fBdnssec\-keygen\fR(8),
 549 RFC1035.
 550 .SH "BUGS"
 551 .PP
 552 There are probably too many query options.
 553 .SH "COPYRIGHT"
 554 Copyright \(co 2004\-2007 Internet Systems Consortium, Inc. ("ISC")
 555 .br
 556 Copyright \(co 2000\-2003 Internet Software Consortium.
 557 .br