dig.docbook 43 KB
Newer Older
Evan Hunt's avatar
Evan Hunt committed
1 2
<!DOCTYPE book [
<!ENTITY mdash "&#8212;">]>
3
<!--
4
 - Copyright (C) Internet Systems Consortium, Inc. ("ISC")
5
 -
6 7 8
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 10 11
 -
 - See the COPYRIGHT file distributed with this work for additional
 - information regarding copyright ownership.
12
-->
13

Evan Hunt's avatar
Evan Hunt committed
14
<!-- Converted by db4-upgrade version 1.0 -->
15
<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.dig">
Evan Hunt's avatar
Evan Hunt committed
16 17 18
  <info>
    <date>2014-02-19</date>
  </info>
19
  <refentryinfo>
Evan Hunt's avatar
Evan Hunt committed
20 21
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
  </refentryinfo>

  <refmeta>
    <refentrytitle>dig</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>dig</refname>
    <refpurpose>DNS lookup utility</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
Mark Andrews's avatar
Mark Andrews committed
37 38 39 40
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
41
      <year>2004</year>
Mark Andrews's avatar
Mark Andrews committed
42
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
43
      <year>2006</year>
Mark Andrews's avatar
Mark Andrews committed
44
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
45
      <year>2008</year>
Automatic Updater's avatar
Automatic Updater committed
46
      <year>2009</year>
Automatic Updater's avatar
Automatic Updater committed
47
      <year>2010</year>
Automatic Updater's avatar
Automatic Updater committed
48
      <year>2011</year>
Tinderbox User's avatar
Tinderbox User committed
49
      <year>2013</year>
Tinderbox User's avatar
Tinderbox User committed
50
      <year>2014</year>
51
      <year>2015</year>
52
      <year>2016</year>
Tinderbox User's avatar
Tinderbox User committed
53
      <year>2017</year>
54
      <year>2018</year>
Mark Andrews's avatar
Mark Andrews committed
55
      <year>2019</year>
56 57 58 59 60
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
Evan Hunt's avatar
Evan Hunt committed
61
    <cmdsynopsis sepchar=" ">
62
      <command>dig</command>
Evan Hunt's avatar
Evan Hunt committed
63 64 65 66 67 68 69 70 71 72 73 74
      <arg choice="opt" rep="norepeat">@server</arg>
      <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">address</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">class</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-f <replaceable class="parameter">filename</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">filename</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-m</option></arg>
      <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port#</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-q <replaceable class="parameter">name</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">type</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
      <arg choice="opt" rep="norepeat"><option>-x <replaceable class="parameter">addr</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-y <replaceable class="parameter"><optional>hmac:</optional>name:key</replaceable></option></arg>
75 76 77 78
      <group choice="opt" rep="norepeat">
	<arg choice="opt" rep="norepeat"><option>-4</option></arg>
	<arg choice="opt" rep="norepeat"><option>-6</option></arg>
      </group>
Evan Hunt's avatar
Evan Hunt committed
79 80 81
      <arg choice="opt" rep="norepeat">name</arg>
      <arg choice="opt" rep="norepeat">type</arg>
      <arg choice="opt" rep="norepeat">class</arg>
82 83 84
      <arg choice="opt" rep="repeat">queryopt</arg>
    </cmdsynopsis>

Evan Hunt's avatar
Evan Hunt committed
85
    <cmdsynopsis sepchar=" ">
86
      <command>dig</command>
Evan Hunt's avatar
Evan Hunt committed
87
      <arg choice="opt" rep="norepeat"><option>-h</option></arg>
88 89
    </cmdsynopsis>

Evan Hunt's avatar
Evan Hunt committed
90
    <cmdsynopsis sepchar=" ">
91 92 93 94 95 96
      <command>dig</command>
      <arg choice="opt" rep="repeat">global-queryopt</arg>
      <arg choice="opt" rep="repeat">query</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

Evan Hunt's avatar
Evan Hunt committed
97
  <refsection><info><title>DESCRIPTION</title></info>
98

99
    <para><command>dig</command> is a flexible tool
100 101 102 103 104 105 106 107 108 109 110 111 112 113
      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 <command>dig</command> to
      troubleshoot DNS problems because of its flexibility, ease of use and
      clarity of output.  Other lookup tools tend to have less functionality
      than <command>dig</command>.
    </para>

    <para>
      Although <command>dig</command> 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 <option>-h</option> option is given.
114
      Unlike earlier versions, the BIND 9 implementation of
115 116 117 118 119 120 121
      <command>dig</command> allows multiple lookups to be issued
      from the
      command line.
    </para>

    <para>
      Unless it is told to query a specific name server,
122
      <command>dig</command> will try each of the servers listed in
Jeremy C. Reed's avatar
Jeremy C. Reed committed
123
      <filename>/etc/resolv.conf</filename>. If no usable server addresses
124 125
      are found, <command>dig</command> will send the query to the local
      host.
126 127 128
    </para>

    <para>
129 130
      When no command line arguments or options are given,
      <command>dig</command> will perform an NS query for "." (the root).
131 132 133 134
    </para>

    <para>
      It is possible to set per-user defaults for <command>dig</command> via
135 136 137 138
      <filename>${HOME}/.digrc</filename>. This file is read and any
      options in it are applied before the command line arguments.
      The <option>-r</option> option disables this feature, for
      scripts that need predictable behaviour.
139 140
    </para>

141 142
    <para>
      The IN and CH class names overlap with the IN and CH top level
Evan Hunt's avatar
Evan Hunt committed
143
      domain names.  Either use the <option>-t</option> and
144
      <option>-c</option> options to specify the type and class,
145
      use the <option>-q</option> the specify the domain name, or
146 147 148
      use "IN." and "CH." when looking up these top level domains.
    </para>

Evan Hunt's avatar
Evan Hunt committed
149
  </refsection>
150

Evan Hunt's avatar
Evan Hunt committed
151
  <refsection><info><title>SIMPLE USAGE</title></info>
152

153 154 155 156 157 158 159 160

    <para>
      A typical invocation of <command>dig</command> looks like:
      <programlisting> dig @server name type </programlisting>
      where:

      <variablelist>

Mark Andrews's avatar
Mark Andrews committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
	<varlistentry>
	  <term><constant>server</constant></term>
	  <listitem>
	    <para>
	      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
	      <parameter>server</parameter> argument is a hostname,
	      <command>dig</command> resolves that name before querying
	      that name server.
	    </para>
	    <para>
	      If no <parameter>server</parameter> argument is
	      provided, <command>dig</command> consults
	      <filename>/etc/resolv.conf</filename>; if an
	      address is found there, it queries the name server at
	      that address. If either of the <option>-4</option> or
	      <option>-6</option> options are in use, then
	      only addresses for the corresponding transport
	      will be tried.  If no usable addresses are found,
	      <command>dig</command> will send the query to the
	      local host.  The reply from the name server that
	      responds is displayed.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><constant>name</constant></term>
	  <listitem>
	    <para>
	      is the name of the resource record that is to be looked up.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><constant>type</constant></term>
	  <listitem>
	    <para>
	      indicates what type of query is required &mdash;
	      ANY, A, MX, SIG, etc.
	      <parameter>type</parameter> can be any valid query
	      type.  If no
	      <parameter>type</parameter> argument is supplied,
	      <command>dig</command> will perform a lookup for an
	      A record.
	    </para>
	  </listitem>
	</varlistentry>
211 212 213 214

      </variablelist>
    </para>

Evan Hunt's avatar
Evan Hunt committed
215
  </refsection>
216

Evan Hunt's avatar
Evan Hunt committed
217
  <refsection><info><title>OPTIONS</title></info>
218

219

220 221
    <variablelist>
      <varlistentry>
222 223
	<term>-4</term>
	<listitem>
224 225 226
	  <para>
	    Use IPv4 only.
	  </para>
227
	</listitem>
228 229 230
      </varlistentry>

      <varlistentry>
231 232
	<term>-6</term>
	<listitem>
233 234 235
	  <para>
	    Use IPv6 only.
	  </para>
236
	</listitem>
237 238 239
      </varlistentry>

      <varlistentry>
240 241
	<term>-b <replaceable class="parameter">address<optional>#port</optional></replaceable></term>
	<listitem>
242 243 244 245 246 247
	  <para>
	    Set the source IP address of the query.
	    The <parameter>address</parameter> 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 "#&lt;port&gt;"
	  </para>
248
	</listitem>
249 250 251
      </varlistentry>

      <varlistentry>
252 253
	<term>-c <replaceable class="parameter">class</replaceable></term>
	<listitem>
254 255 256 257 258
	  <para>
	    Set the query class. The
	    default <parameter>class</parameter> is IN; other classes
	    are HS for Hesiod records or CH for Chaosnet records.
	  </para>
259
	</listitem>
260 261 262
      </varlistentry>

      <varlistentry>
263 264
	<term>-f <replaceable class="parameter">file</replaceable></term>
	<listitem>
265 266 267 268 269 270 271 272
	  <para>
	    Batch mode: <command>dig</command> reads a list of lookup
	    requests to process from the
	    given <parameter>file</parameter>. Each line in the file
	    should be organized in the same way they would be
	    presented as queries to
	    <command>dig</command> using the command-line interface.
	  </para>
273
	</listitem>
274 275 276
      </varlistentry>

      <varlistentry>
277 278
	<term>-k <replaceable class="parameter">keyfile</replaceable></term>
	<listitem>
279 280 281 282 283 284 285 286 287 288 289 290 291
	  <para>
	    Sign queries using TSIG using a key read from the given file.
	    Key files can be generated using
	    <citerefentry>
	      <refentrytitle>tsig-keygen</refentrytitle><manvolnum>8</manvolnum>
	    </citerefentry>.
	    When using TSIG authentication with <command>dig</command>,
	    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 <command>key</command>
	    and <command>server</command> statements in
	    <filename>named.conf</filename>.
	  </para>
292
	</listitem>
293 294 295
      </varlistentry>

      <varlistentry>
296 297
	<term>-m</term>
	<listitem>
298 299 300 301 302
	  <para>
	    Enable memory usage debugging.
	    <!-- It enables ISC_MEM_DEBUGTRACE and ISC_MEM_DEBUGRECORD
		 documented in include/isc/mem.h -->
	  </para>
303
	</listitem>
304 305 306
      </varlistentry>

      <varlistentry>
307 308
	<term>-p <replaceable class="parameter">port</replaceable></term>
	<listitem>
309 310
	  <para>
	    Send the query to a non-standard port on the server,
311
	    instead of the default port 53. This option would be used
312 313 314
	    to test a name server that has been configured to listen
	    for queries on a non-standard port number.
	  </para>
315
	</listitem>
316 317 318
      </varlistentry>

      <varlistentry>
319 320
	<term>-q <replaceable class="parameter">name</replaceable></term>
	<listitem>
321 322 323 324
	  <para>
	    The domain name to query. This is useful to distinguish
	    the <parameter>name</parameter> from other arguments.
	  </para>
325
	</listitem>
326 327 328
      </varlistentry>

      <varlistentry>
329 330 331 332 333 334 335 336 337 338
	<term>-r</term>
	<listitem>
	  <para>
	    Do not read options from <filename>${HOME}/.digrc</filename>.
	    This is useful for scripts that need predictable behaviour.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
339 340
	<term>-t <replaceable class="parameter">type</replaceable></term>
	<listitem>
341
	  <para>
342 343 344 345 346 347
	    The resource record type to query. It can be any valid query
	    type.  If it is a resource record type supported in BIND 9, it
	    can be given by the type mnemonic (such as "NS" or "AAAA").
	    The default query type is "A", unless the <option>-x</option>
	    option is supplied to indicate a reverse lookup.  A zone
	    transfer can be requested by specifying a type of AXFR.  When
348 349 350 351 352 353 354
	    an incremental zone transfer (IXFR) is required, set the
	    <parameter>type</parameter> to <literal>ixfr=N</literal>.
	    The incremental zone transfer will contain the changes
	    made to the zone since the serial number in the zone's SOA
	    record was
	    <parameter>N</parameter>.
	  </para>
355 356 357 358 359 360
	  <para>
	    All resource record types can be expressed as "TYPEnn", where
	    "nn" is the number of the type. If the resource record type is
	    not supported in BIND 9, the result will be displayed as
	    described in RFC 3597.
	  </para>
361
	</listitem>
362 363
      </varlistentry>

364 365 366 367 368 369 370 371 372
      <varlistentry>
	<term>-u</term>
	<listitem>
	  <para>
	    Print query times in microseconds instead of milliseconds.
	  </para>
	</listitem>
      </varlistentry>

373
      <varlistentry>
374 375
	<term>-v</term>
	<listitem>
376 377 378
	  <para>
	    Print the version number and exit.
	  </para>
379
	</listitem>
380 381 382
      </varlistentry>

      <varlistentry>
383 384
	<term>-x <replaceable class="parameter">addr</replaceable></term>
	<listitem>
385 386 387 388 389 390 391 392 393 394 395 396 397
	  <para>
	    Simplified reverse lookups, for mapping addresses to
	    names. The <parameter>addr</parameter> is an IPv4 address
	    in dotted-decimal notation, or a colon-delimited IPv6
	    address. When the <option>-x</option> is used, there is no
	    need to provide
	    the <parameter>name</parameter>, <parameter>class</parameter>
	    and <parameter>type</parameter>
	    arguments. <command>dig</command> automatically performs a
	    lookup for a name like
	    <literal>94.2.0.192.in-addr.arpa</literal> and sets the
	    query type and class to PTR and IN respectively. IPv6
	    addresses are looked up using nibble format under the
398
	    IP6.ARPA domain.
399
	  </para>
400
	</listitem>
401 402 403
      </varlistentry>

      <varlistentry>
404 405
	<term>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></term>
	<listitem>
406 407 408 409 410 411 412 413 414
	  <para>
	    Sign queries using TSIG with the given authentication key.
	    <parameter>keyname</parameter> is the name of the key, and
	    <parameter>secret</parameter> is the base64 encoded shared secret.
	    <parameter>hmac</parameter> is the name of the key algorithm;
	    valid choices are <literal>hmac-md5</literal>,
	    <literal>hmac-sha1</literal>, <literal>hmac-sha224</literal>,
	    <literal>hmac-sha256</literal>, <literal>hmac-sha384</literal>, or
	    <literal>hmac-sha512</literal>.  If <parameter>hmac</parameter>
415 416
	    is not specified, the default is <literal>hmac-md5</literal>
	    or if MD5 was disabled <literal>hmac-sha256</literal>.
417 418 419 420 421 422 423 424
	  </para>
	  <para>
	    NOTE: You should use the <option>-k</option> option and
	    avoid the <option>-y</option> option, because
	    with <option>-y</option> the shared secret is supplied as
	    a command line argument in clear text. This may be visible
	    in the output from
	    <citerefentry>
425
	      <refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>
426 427 428
	    </citerefentry>
	    or in a history file maintained by the user's shell.
	  </para>
429
	</listitem>
430 431 432
      </varlistentry>

    </variablelist>
Evan Hunt's avatar
Evan Hunt committed
433
  </refsection>
434

Evan Hunt's avatar
Evan Hunt committed
435
  <refsection><info><title>QUERY OPTIONS</title></info>
436

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453

    <para><command>dig</command>
      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.
    </para>

    <para>
      Each query option is identified by a keyword preceded by a plus sign
      (<literal>+</literal>).  Some keywords set or reset an
      option.  These may be preceded
      by the string <literal>no</literal> to negate the meaning of
      that keyword.  Other
      keywords assign values to options like the timeout interval.  They
      have the form <option>+keyword=value</option>.
Evan Hunt's avatar
Evan Hunt committed
454 455 456
      Keywords may be abbreviated, provided the abbreviation is
      unambiguous; for example, <literal>+cd</literal> is equivalent
      to <literal>+cdflag</literal>.
457 458 459 460
      The query options are:

      <variablelist>

Mark Andrews's avatar
Mark Andrews committed
461 462
	<varlistentry>
	  <term><option>+[no]aaflag</option></term>
463 464 465 466 467 468
	  <listitem>
	    <para>
	      A synonym for <parameter>+[no]aaonly</parameter>.
	    </para>
	  </listitem>
	</varlistentry>
469

Mark Andrews's avatar
Mark Andrews committed
470 471
	<varlistentry>
	  <term><option>+[no]aaonly</option></term>
472 473 474 475 476 477
	  <listitem>
	    <para>
	      Sets the "aa" flag in the query.
	    </para>
	  </listitem>
	</varlistentry>
478

Mark Andrews's avatar
Mark Andrews committed
479 480
	<varlistentry>
	  <term><option>+[no]additional</option></term>
481 482 483 484 485 486 487
	  <listitem>
	    <para>
	      Display [do not display] the additional section of a
	      reply.  The default is to display it.
	    </para>
	  </listitem>
	</varlistentry>
488

Mark Andrews's avatar
Mark Andrews committed
489 490
	<varlistentry>
	  <term><option>+[no]adflag</option></term>
491 492 493 494 495 496 497 498 499
	  <listitem>
	    <para>
	      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
500 501
	      of the answer was insecure or not validated.  This
	      bit is set by default.
502 503 504
	    </para>
	  </listitem>
	</varlistentry>
505

Mark Andrews's avatar
Mark Andrews committed
506 507
	<varlistentry>
	  <term><option>+[no]all</option></term>
508 509 510 511 512 513
	  <listitem>
	    <para>
	      Set or clear all display flags.
	    </para>
	  </listitem>
	</varlistentry>
514

Mark Andrews's avatar
Mark Andrews committed
515 516
	<varlistentry>
	  <term><option>+[no]answer</option></term>
517 518 519 520 521 522 523
	  <listitem>
	    <para>
	      Display [do not display] the answer section of a
	      reply.  The default is to display it.
	    </para>
	  </listitem>
	</varlistentry>
524

Mark Andrews's avatar
Mark Andrews committed
525 526
	<varlistentry>
	  <term><option>+[no]authority</option></term>
527 528 529 530 531 532 533
	  <listitem>
	    <para>
	      Display [do not display] the authority section of a
	      reply.  The default is to display it.
	    </para>
	  </listitem>
	</varlistentry>
534

535 536 537 538 539 540 541 542 543 544
	<varlistentry>
	  <term><option>+[no]badcookie</option></term>
	  <listitem>
	    <para>
	      Retry lookup with the new server cookie if a
	      BADCOOKIE response is received.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
545 546
	<varlistentry>
	  <term><option>+[no]besteffort</option></term>
547 548 549 550 551 552 553 554
	  <listitem>
	    <para>
	      Attempt to display the contents of messages which are
	      malformed.  The default is to not display malformed
	      answers.
	    </para>
	  </listitem>
	</varlistentry>
Evan Hunt's avatar
Evan Hunt committed
555

Mark Andrews's avatar
Mark Andrews committed
556 557
	<varlistentry>
	  <term><option>+bufsize=B</option></term>
558 559
	  <listitem>
	    <para>
560 561 562 563 564 565
	      Set the UDP message buffer size advertised using EDNS0
	      to <parameter>B</parameter> 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.
566 567 568
	    </para>
	  </listitem>
	</varlistentry>
569

Mark Andrews's avatar
Mark Andrews committed
570 571
	<varlistentry>
	  <term><option>+[no]cdflag</option></term>
572 573 574 575 576 577 578 579
	  <listitem>
	    <para>
	      Set [do not set] the CD (checking disabled) bit in
	      the query.  This requests the server to not perform
	      DNSSEC validation of responses.
	    </para>
	  </listitem>
	</varlistentry>
580

Mark Andrews's avatar
Mark Andrews committed
581
	<varlistentry>
Evan Hunt's avatar
Evan Hunt committed
582
	  <term><option>+[no]class</option></term>
583
	  <listitem>
584
	    <para>
585 586
	      Display [do not display] the CLASS when printing the
	      record.
587
	    </para>
588 589 590
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
591 592
	<varlistentry>
	  <term><option>+[no]cmd</option></term>
593
	  <listitem>
594
	    <para>
595
	      Toggles the printing of the initial comment in the
596 597 598 599 600
	      output, identifying the version of <command>dig</command>
	      and the query options that have been applied.  This option
	      always has global effect; it cannot be set globally
	      and then overridden on a per-lookup basis.  The default
	      is to print this comment.
601 602 603
	    </para>
	  </listitem>
	</varlistentry>
604

Mark Andrews's avatar
Mark Andrews committed
605 606
	<varlistentry>
	  <term><option>+[no]comments</option></term>
607 608
	  <listitem>
	    <para>
609 610 611 612 613 614 615 616 617 618 619 620
	      Toggles the display of some comment lines in the output,
	      containing information about the packet header and
	      OPT pseudosection, and the names of the response
	      section.  The default is to print these comments.
	    </para>
	    <para>
	      Other types of comments in the output are not affected by
	      this option, but can be controlled using other command
	      line switches. These include <command>+[no]cmd</command>,
	      <command>+[no]question</command>,
	      <command>+[no]stats</command>, and
	      <command>+[no]rrcomments</command>.
621 622 623
	    </para>
	  </listitem>
	</varlistentry>
624

625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
	<varlistentry>
	  <term><option>+[no]cookie<optional>=####</optional></option></term>
	  <listitem>
	    <para>
	      Send a COOKIE EDNS option, with optional
	      value.  Replaying a COOKIE from a previous response will
	      allow the server to identify a previous client.  The
	      default is <option>+cookie</option>.
	    </para>
	    <para>
	      <command>+cookie</command> is also set when +trace
	      is set to better emulate the default queries from a
	      nameserver.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
642 643
	<varlistentry>
	  <term><option>+[no]crypto</option></term>
644 645 646 647 648 649 650 651 652 653 654 655 656
	  <listitem>
	    <para>
	      Toggle the display of cryptographic fields in DNSSEC
	      records.  The contents of these field are unnecessary
	      to debug most DNSSEC validation failures and removing
	      them makes it easier to see the common failures.  The
	      default is to display the fields.  When omitted they
	      are replaced by the string "[omitted]" or in the
	      DNSKEY case the key id is displayed as the replacement,
	      e.g. "[ key id = value ]".
	    </para>
	  </listitem>
	</varlistentry>
657

Mark Andrews's avatar
Mark Andrews committed
658 659
	<varlistentry>
	  <term><option>+[no]defname</option></term>
660 661 662 663 664 665 666
	  <listitem>
	    <para>
	      Deprecated, treated as a synonym for
	      <parameter>+[no]search</parameter>
	    </para>
	  </listitem>
	</varlistentry>
667

Mark Andrews's avatar
Mark Andrews committed
668 669
	<varlistentry>
	  <term><option>+[no]dnssec</option></term>
670 671
	  <listitem>
	    <para>
Mark Andrews's avatar
Mark Andrews committed
672 673 674
	      Requests DNSSEC records be sent by setting the DNSSEC
	      OK bit (DO) in the OPT record in the additional section
	      of the query.
675 676 677
	    </para>
	  </listitem>
	</varlistentry>
678

Mark Andrews's avatar
Mark Andrews committed
679 680
	<varlistentry>
	  <term><option>+domain=somename</option></term>
681 682
	  <listitem>
	    <para>
Mark Andrews's avatar
Mark Andrews committed
683 684 685 686 687 688
	      Set the search list to contain the single domain
	      <parameter>somename</parameter>, as if specified in
	      a <command>domain</command> directive in
	      <filename>/etc/resolv.conf</filename>, and enable
	      search list processing as if the
	      <parameter>+search</parameter> option were given.
689 690 691 692
	    </para>
	  </listitem>
	</varlistentry>

693 694 695 696 697
	<varlistentry>
	  <term><option>+dscp=value</option></term> <listitem>
	    <para>
	      Set the DSCP code point to be used when sending the
	      query.  Valid DSCP code points are in the range
Jeremy C. Reed's avatar
Jeremy C. Reed committed
698
	      [0..63].  By default no code point is explicitly set.
699 700 701 702
	    </para>
	  </listitem>
	</varlistentry>

703 704 705 706 707 708 709 710 711 712 713 714 715
	<varlistentry>
	  <term><option>+[no]edns[=#]</option></term>
	  <listitem>
	    <para>
	       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.  <option>+noedns</option>
	       clears the remembered EDNS version.  EDNS is set to
	       0 by default.
	    </para>
	  </listitem>
	</varlistentry>

716 717 718 719 720 721 722 723 724 725 726 727
	<varlistentry>
	  <term><option>+[no]ednsflags[=#]</option></term>
	  <listitem>
	    <para>
	      Set the must-be-zero EDNS flags bits (Z bits) to the
	      specified value. Decimal, hex and octal encodings are
	      accepted. Setting a named flag (e.g. DO) will silently be
	      ignored. By default, no Z bits are set.
	    </para>
	  </listitem>
	</varlistentry>

728 729 730 731 732 733 734 735 736 737
	<varlistentry>
	  <term><option>+[no]ednsnegotiation</option></term>
	  <listitem>
	    <para>
	      Enable / disable EDNS version negotiation. By default
	      EDNS version negotiation is enabled.
	    </para>
	  </listitem>
	</varlistentry>

738 739 740 741 742 743
	<varlistentry>
	  <term><option>+[no]ednsopt[=code[:value]]</option></term>
	  <listitem>
	    <para>
	      Specify EDNS option with code point <option>code</option>
	      and optionally payload of <option>value</option> as a
744
	      hexadecimal string.  <option>code</option> can be
745 746 747
	      either an EDNS option name (for example,
	      <literal>NSID</literal> or <literal>ECS</literal>),
	      or an arbitrary numeric value.  <option>+noednsopt</option>
Mark Andrews's avatar
grammar  
Mark Andrews committed
748
	      clears the EDNS options to be sent.
749 750 751
	    </para>
	  </listitem>
	</varlistentry>
752

Mark Andrews's avatar
Mark Andrews committed
753 754
	<varlistentry>
	  <term><option>+[no]expire</option></term>
755 756 757 758 759 760
	  <listitem>
	    <para>
	      Send an EDNS Expire option.
	    </para>
	  </listitem>
	</varlistentry>
761

762 763 764 765 766 767 768 769 770 771
	<varlistentry>
	  <term><option>+[no]expandaaaa</option></term>
	  <listitem>
	    <para>
	      When printing AAAA record print all zero nibbles rather
	      than the default RFC 5952 preferred presentation format.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
772 773
	<varlistentry>
	  <term><option>+[no]fail</option></term>
774 775 776 777 778 779 780 781
	  <listitem>
	    <para>
	      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.
	    </para>
	  </listitem>
	</varlistentry>
782

783 784 785 786 787 788 789 790 791 792 793
	<varlistentry>
	  <term><option>+[no]header-only</option></term>
	  <listitem>
	    <para>
	      Send a query with a DNS header without a question section.
	      The default is to add a question section.  The query type
	      and query name are ignored when this is set.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
794 795
	<varlistentry>
	  <term><option>+[no]identify</option></term>
796 797 798 799 800 801 802 803 804 805 806
	  <listitem>
	    <para>
	      Show [or do not show] the IP address and port number
	      that supplied the answer when the
	      <parameter>+short</parameter> 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.
	    </para>
	  </listitem>
	</varlistentry>
807

808 809 810 811 812 813
	<varlistentry>
	  <term><option>+[no]idnin</option></term>
	  <listitem>
	    <para>
	      Process [do not process] IDN domain names on input.
	      This requires IDN SUPPORT to have been enabled at
Ondřej Surý's avatar
Ondřej Surý committed
814 815 816 817 818 819 820
	      compile time.
	    </para>
	    <para>
	      The default is to process IDN input when standard output
	      is a tty.  The IDN processing on input is disabled when
	      dig output is redirected to files, pipes, and other
	      non-tty file descriptors.
821 822 823 824
	    </para>
	  </listitem>
	</varlistentry>

825 826 827 828 829 830
	<varlistentry>
	  <term><option>+[no]idnout</option></term>
	  <listitem>
	    <para>
	      Convert [do not convert] puny code on output.
	      This requires IDN SUPPORT to have been enabled at
Ondřej Surý's avatar
Ondřej Surý committed
831 832 833 834 835 836 837
	      compile time.
	    </para>
	    <para>
	      The default is to process puny code on output when
	      standard output is a tty.  The puny code processing on
	      output is disabled when dig output is redirected to
	      files, pipes, and other non-tty file descriptors.
838 839 840 841
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
842 843
	<varlistentry>
	  <term><option>+[no]ignore</option></term>
844 845 846 847 848 849 850
	  <listitem>
	    <para>
	      Ignore truncation in UDP responses instead of retrying
	      with TCP.  By default, TCP retries are performed.
	    </para>
	  </listitem>
	</varlistentry>
851

Evan Hunt's avatar
Evan Hunt committed
852 853 854 855 856 857 858 859 860
	<varlistentry>
	  <term><option>+[no]keepalive</option></term>
	  <listitem>
	    <para>
	      Send [or do not send] an EDNS Keepalive option.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
861 862
	<varlistentry>
	  <term><option>+[no]keepopen</option></term>
863 864 865 866 867 868 869 870
	  <listitem>
	    <para>
	      Keep the TCP socket open between queries and reuse
	      it rather than creating a new TCP socket for each
	      lookup.  The default is <option>+nokeepopen</option>.
	    </para>
	  </listitem>
	</varlistentry>
871

872 873 874 875 876 877 878 879 880 881
	<varlistentry>
	  <term><option>+[no]mapped</option></term>
	  <listitem>
	    <para>
	      Allow mapped IPv4 over IPv6 addresses to be used.  The
	      default is <option>+mapped</option>.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
882 883
	<varlistentry>
	  <term><option>+[no]multiline</option></term>
884 885 886 887 888 889 890 891 892 893
	  <listitem>
	    <para>
	      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 <command>dig</command>
	      output.
	    </para>
	  </listitem>
	</varlistentry>
894

Mark Andrews's avatar
Mark Andrews committed
895 896
	<varlistentry>
	  <term><option>+ndots=D</option></term>
897 898 899 900 901 902 903 904 905 906 907
	  <listitem>
	    <para>
	      Set the number of dots that have to appear in
	      <parameter>name</parameter> to <parameter>D</parameter>
	      for it to be considered absolute.  The default value
	      is that defined using the ndots statement in
	      <filename>/etc/resolv.conf</filename>, 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 <option>search</option>
	      or <option>domain</option> directive in
908 909
	      <filename>/etc/resolv.conf</filename> if
	      <option>+search</option> is set.
910 911 912
	    </para>
	  </listitem>
	</varlistentry>
913

Mark Andrews's avatar
Mark Andrews committed
914 915
	<varlistentry>
	  <term><option>+[no]nsid</option></term>
916 917 918 919 920 921 922 923
	  <listitem>
	    <para>
	      Include an EDNS name server ID request when sending
	      a query.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
924 925
	<varlistentry>
	  <term><option>+[no]nssearch</option></term>
926 927 928 929 930 931
	  <listitem>
	    <para>
	      When this option is set, <command>dig</command>
	      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
Evan Hunt's avatar
Evan Hunt committed
932 933
	      the zone. Addresses of servers that that did not
	      respond are also printed.
934 935 936 937 938 939 940 941 942 943 944 945 946 947
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><option>+[no]onesoa</option></term>
	  <listitem>
	    <para>
	      Print only one (starting) SOA record when performing
	      an AXFR. The default is to print both the starting
	      and ending SOA records.
	    </para>
	  </listitem>
	</varlistentry>
948

949 950 951 952 953 954 955 956 957 958
	<varlistentry>
	  <term><option>+[no]opcode=value</option></term>
	  <listitem>
	    <para>
	      Set [restore] the DNS message opcode to the specified
	      value.  The default value is QUERY (0).
	    </para>
	  </listitem>
	</varlistentry>

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
	<varlistentry>
	  <term><option>+padding=value</option></term>
	  <listitem>
	    <para>
	      Pad the size of the query packet using the EDNS Padding option
	      to blocks of <parameter>value</parameter> bytes. For example,
	      <option>+padding=32</option> would cause a 48-byte query to
	      be padded to 64 bytes.  The default block size is 0, which
	      disables padding. The maximum is 512. Values are
	      ordinarily expected to be powers of two, such as 128;
	      however, this is not mandatory.  Responses to
	      padded queries may also be padded, but only if the query
	      uses TCP or DNS COOKIE.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
976 977
	<varlistentry>
	  <term><option>+[no]qr</option></term>
978 979
	  <listitem>
	    <para>
980 981
	      Toggles the display of the query message as it is sent.
	      By default, the query is not printed.
982 983 984
	    </para>
	  </listitem>
	</varlistentry>
985

Mark Andrews's avatar
Mark Andrews committed
986 987
	<varlistentry>
	  <term><option>+[no]question</option></term>
988 989
	  <listitem>
	    <para>
990
	      Toggles the display of the question section of a query
991 992 993 994 995
	      when an answer is returned.  The default is to print
	      the question section as a comment.
	    </para>
	  </listitem>
	</varlistentry>
996

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
	<varlistentry>
	  <term><option>+[no]raflag</option></term>
	  <listitem>
	    <para>
	      Set [do not set] the RA (Recursion Available) bit in
	      the query. The default is +noraflag. This bit should
	      be ignored by the server for QUERY.
	    </para>
	  </listitem>
	</varlistentry>

Evan Hunt's avatar
Evan Hunt committed
1008 1009 1010 1011 1012 1013 1014 1015 1016
	<varlistentry>
	  <term><option>+[no]rdflag</option></term>
	  <listitem>
	    <para>
	      A synonym for <parameter>+[no]recurse</parameter>.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
1017 1018
	<varlistentry>
	  <term><option>+[no]recurse</option></term>
1019 1020 1021 1022 1023 1024
	  <listitem>
	    <para>
	      Toggle the setting of the RD (recursion desired) bit
	      in the query.  This bit is set by default, which means
	      <command>dig</command> normally sends recursive
	      queries.  Recursion is automatically disabled when
1025 1026 1027 1028
	      using the <parameter>+nssearch</parameter> option, and
	      when using <parameter>+trace</parameter> except for
	      an initial recursive query to get the list of root
	      servers.
1029 1030 1031
	    </para>
	  </listitem>
	</varlistentry>
1032

Mark Andrews's avatar
Mark Andrews committed
1033 1034
	<varlistentry>
	  <term><option>+retry=T</option></term>
1035 1036 1037 1038 1039 1040 1041 1042 1043
	  <listitem>
	    <para>
	      Sets the number of times to retry UDP queries to
	      server to <parameter>T</parameter> instead of the
	      default, 2.  Unlike <parameter>+tries</parameter>,
	      this does not include the initial query.
	    </para>
	  </listitem>
	</varlistentry>
1044

Mark Andrews's avatar
Mark Andrews committed
1045 1046
	<varlistentry>
	  <term><option>+[no]rrcomments</option></term>
1047 1048 1049 1050 1051 1052 1053 1054 1055
	  <listitem>
	    <para>
	      Toggle the display of per-record comments in the
	      output (for example, human-readable key information
	      about DNSKEY records).  The default is not to print
	      record comments unless multiline mode is active.
	    </para>
	  </listitem>
	</varlistentry>
1056

Mark Andrews's avatar
Mark Andrews committed
1057 1058
	<varlistentry>
	  <term><option>+[no]search</option></term>
1059 1060
	  <listitem>
	    <para>
1061 1062 1063 1064
	      Use [do not use] the search list defined by the
	      searchlist or domain directive in
	      <filename>resolv.conf</filename> (if any).  The search
	      list is not used by default.
1065
	    </para>
1066 1067 1068 1069 1070 1071 1072
	    <para>
	      'ndots' from <filename>resolv.conf</filename> (default 1)
	       which may be overridden by <parameter>+ndots</parameter>
	      determines if the name will be treated as relative
	      or not and hence whether a search is eventually
	      performed or not.
	    </para>
1073 1074 1075
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
1076 1077
	<varlistentry>
	  <term><option>+[no]short</option></term>
1078 1079
	  <listitem>
	    <para>
1080
	      Provide a terse answer.  The default is to print the
1081 1082 1083
	      answer in a verbose form.  This option always has global
	      effect; it cannot be set globally and then overridden on
	      a per-lookup basis.
1084 1085 1086 1087
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
1088 1089
	<varlistentry>
	  <term><option>+[no]showsearch</option></term>
1090 1091
	  <listitem>
	    <para>
1092 1093
	      Perform [do not perform] a search showing intermediate
	      results.
1094 1095 1096 1097
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
1098 1099
	<varlistentry>
	  <term><option>+[no]sigchase</option></term>
1100 1101
	  <listitem>
	    <para>
Evan Hunt's avatar
Evan Hunt committed
1102
	      This feature is now obsolete and has been removed;
1103
	      use <command>delv</command> instead.
1104 1105 1106
	    </para>
	  </listitem>
	</varlistentry>
1107

Mark Andrews's avatar
Mark Andrews committed
1108 1109
	<varlistentry>
	  <term><option>+split=W</option></term>
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
	  <listitem>
	    <para>
	      Split long hex- or base64-formatted fields in resource
	      records into chunks of <parameter>W</parameter>
	      characters (where <parameter>W</parameter> is rounded
	      up to the nearest multiple of 4).
	      <parameter>+nosplit</parameter> or
	      <parameter>+split=0</parameter> causes fields not to
	      be split at all.  The default is 56 characters, or
	      44 characters when multiline mode is active.
	    </para>
	  </listitem>
	</varlistentry>
1123

Mark Andrews's avatar
Mark Andrews committed
1124 1125
	<varlistentry>
	  <term><option>+[no]stats</option></term>
1126 1127
	  <listitem>
	    <para>
1128 1129 1130
	      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 as a comment after each lookup.
1131 1132 1133
	    </para>
	  </listitem>
	</varlistentry>
1134

Mark Andrews's avatar
Mark Andrews committed
1135
	<varlistentry>
Evan Hunt's avatar
Evan Hunt committed
1136
	  <term><option>+[no]subnet=addr[/prefix-length]</option></term>
1137
	  <listitem>
Mark Andrews's avatar
Mark Andrews committed
1138
	    <para>
1139
	      Send (don't send) an EDNS Client Subnet option with the
Evan Hunt's avatar
Evan Hunt committed
1140
	      specified IP address or network prefix.
1141 1142
	    </para>
	    <para>
1143 1144 1145 1146 1147 1148 1149
	      <command>dig +subnet=0.0.0.0/0</command>, or simply
	      <command>dig +subnet=0</command> for short, sends an EDNS
	      CLIENT-SUBNET option with an empty address and a source
	      prefix-length of zero, which signals a resolver that
	      the client's address information must
	      <emphasis>not</emphasis> be used when resolving
	      this query.
Mark Andrews's avatar
Mark Andrews committed
1150
	    </para>
1151 1152 1153
	  </listitem>
	</varlistentry>

1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
	<varlistentry>
	  <term><option>+[no]tcflag</option></term>
	  <listitem>
	    <para>
	      Set [do not set] the TC (TrunCation) bit in the query.
	      The default is +notcflag.  This bit should be ignored
	      by the server for QUERY.
	    </para>
	  </listitem>
	</varlistentry>

Mark Andrews's avatar
Mark Andrews committed
1165 1166
	<varlistentry>
	  <term><option>+[no]tcp</option></term>
1167
	  <listitem>
Mark Andrews's avatar
Mark Andrews committed
1168
	    <para>
1169
	      Use [do not use] TCP when querying name servers. The
1170 1171 1172 1173
	      default behavior is to use UDP unless a type
	      <literal>any</literal> or <literal>ixfr=N</literal>
	      query is requested, in which case the default is TCP.
	      AXFR queries always use TCP.
Mark Andrews's avatar
Mark Andrews committed
1174
	    </para>
1175 1176
	  </listitem>
	</varlistentry>
1177

Mark Andrews's avatar
Mark Andrews committed
1178
	<varlistentry>
Francis Dupont's avatar
Francis Dupont committed
1179
	  <term><option>+timeout=T</option></term>
1180 1181 1182
	  <listitem>
	    <para>

Mark Andrews's avatar
Mark Andrews committed
1183 1184
	      Sets the timeout for a query to
	      <parameter>T</parameter> seconds.  The default
1185
	      timeout is 5 seconds.
Mark Andrews's avatar
Mark Andrews committed
1186 1187 1188 1189 1190 1191 1192 1193 1194
	      An attempt to set <parameter>T</parameter> to less
	      than 1 will result
	      in a query timeout of 1 second being applied.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><option>+[no]topdown</option></term>