external/bsd/bind/dist/bin/dig/nslookup.docbook

   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 "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004-2007, 2010, 2013, 2014  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <!--
  21  - Copyright (c) 1985, 1989
  22  -    The Regents of the University of California.  All rights reserved.
  23  -
  24  - Redistribution and use in source and binary forms, with or without
  25  - modification, are permitted provided that the following conditions
  26  - are met:
  27  - 1. Redistributions of source code must retain the above copyright
  28  -    notice, this list of conditions and the following disclaimer.
  29  - 2. Redistributions in binary form must reproduce the above copyright
  30  -    notice, this list of conditions and the following disclaimer in the
  31  -    documentation and/or other materials provided with the distribution.
  32  - 3. Neither the name of the University nor the names of its contributors
  33  -    may be used to endorse or promote products derived from this software
  34  -    without specific prior written permission.
  35  -
  36  - THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  37  - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  38  - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  39  - ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  40  - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  41  - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  42  - OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  - HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  44  - LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  45  - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  - SUCH DAMAGE.
  47 -->
  48 <refentry>
  49
  50   <refentryinfo>
  51     <date>January 24, 2014</date>
  52   </refentryinfo>
  53
  54   <refmeta>
  55     <refentrytitle>nslookup</refentrytitle>
  56     <manvolnum>1</manvolnum>
  57     <refmiscinfo>BIND9</refmiscinfo>
  58   </refmeta>
  59
  60   <refnamediv>
  61     <refname>nslookup</refname>
  62     <refpurpose>query Internet name servers interactively</refpurpose>
  63   </refnamediv>
  64
  65   <docinfo>
  66     <copyright>
  67       <year>2004</year>
  68       <year>2005</year>
  69       <year>2006</year>
  70       <year>2007</year>
  71       <year>2010</year>
  72       <year>2013</year>
  73       <year>2014</year>
  74       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  75     </copyright>
  76   </docinfo>
  77
  78   <refsynopsisdiv>
  79     <cmdsynopsis>
  80       <command>nslookup</command>
  81       <arg><option>-option</option></arg>
  82       <arg choice="opt">name | -</arg>
  83       <arg choice="opt">server</arg>
  84     </cmdsynopsis>
  85   </refsynopsisdiv>
  86
  87   <refsect1>
  88     <title>DESCRIPTION</title>
  89     <para><command>Nslookup</command>
  90       is a program to query Internet domain name servers.  <command>Nslookup</command>
  91       has two modes: interactive and non-interactive.  Interactive mode allows
  92       the user to query name servers for information about various hosts and
  93       domains or to print a list of hosts in a domain.  Non-interactive mode
  94       is
  95       used to print just the name and requested information for a host or
  96       domain.
  97     </para>
  98   </refsect1>
  99
 100   <refsect1>
 101     <title>ARGUMENTS</title>
 102     <para>
 103       Interactive mode is entered in the following cases:
 104       <orderedlist numeration="loweralpha">
 105         <listitem>
 106           <para>
 107             when no arguments are given (the default name server will be used)
 108           </para>
 109         </listitem>
 110         <listitem>
 111           <para>
 112             when the first argument is a hyphen (-) and the second argument is
 113             the host name or Internet address of a name server.
 114           </para>
 115         </listitem>
 116       </orderedlist>
 117     </para>
 118
 119     <para>
 120       Non-interactive mode is used when the name or Internet address of the
 121       host to be looked up is given as the first argument. The optional second
 122       argument specifies the host name or address of a name server.
 123     </para>
 124
 125     <para>
 126       Options can also be specified on the command line if they precede the
 127       arguments and are prefixed with a hyphen.  For example, to
 128       change the default query type to host information, and the initial
 129       timeout to 10 seconds, type:
 130       <!-- <informalexample> produces bad nroff. -->
 131         <programlisting>
 132 nslookup -query=hinfo  -timeout=10
 133 </programlisting>
 134       <!-- </informalexample> -->
 135     </para>
 136     <para>
 137       The <option>-version</option> option causes
 138       <command>nslookup</command> to print the version
 139       number and immediately exits.
 140     </para>
 141
 142   </refsect1>
 143
 144   <refsect1>
 145     <title>INTERACTIVE COMMANDS</title>
 146     <variablelist>
 147       <varlistentry>
 148         <term><constant>host</constant> <optional>server</optional></term>
 149         <listitem>
 150           <para>
 151             Look up information for host using the current default server or
 152             using server, if specified.  If host is an Internet address and
 153             the query type is A or PTR, the name of the host is returned.
 154             If host is a name and does not have a trailing period, the
 155             search list is used to qualify the name.
 156           </para>
 157
 158           <para>
 159             To look up a host not in the current domain, append a period to
 160             the name.
 161           </para>
 162         </listitem>
 163       </varlistentry>
 164
 165       <varlistentry>
 166         <term><constant>server</constant> <replaceable class="parameter">domain</replaceable></term>
 167         <listitem>
 168           <para/>
 169         </listitem>
 170       </varlistentry>
 171       <varlistentry>
 172         <term><constant>lserver</constant> <replaceable class="parameter">domain</replaceable></term>
 173         <listitem>
 174           <para>
 175             Change the default server to <replaceable>domain</replaceable>; <constant>lserver</constant> uses the initial
 176             server to look up information about <replaceable>domain</replaceable>, while <constant>server</constant> uses
 177             the current default server.  If an authoritative answer can't be
 178             found, the names of servers that might have the answer are
 179             returned.
 180           </para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term><constant>root</constant></term>
 186         <listitem>
 187           <para>
 188             not implemented
 189           </para>
 190         </listitem>
 191       </varlistentry>
 192
 193       <varlistentry>
 194         <term><constant>finger</constant></term>
 195         <listitem>
 196           <para>
 197             not implemented
 198           </para>
 199         </listitem>
 200       </varlistentry>
 201
 202       <varlistentry>
 203         <term><constant>ls</constant></term>
 204         <listitem>
 205           <para>
 206             not implemented
 207           </para>
 208         </listitem>
 209       </varlistentry>
 210
 211       <varlistentry>
 212         <term><constant>view</constant></term>
 213         <listitem>
 214           <para>
 215             not implemented
 216           </para>
 217         </listitem>
 218       </varlistentry>
 219
 220       <varlistentry>
 221         <term><constant>help</constant></term>
 222         <listitem>
 223           <para>
 224             not implemented
 225           </para>
 226         </listitem>
 227       </varlistentry>
 228
 229       <varlistentry>
 230         <term><constant>?</constant></term>
 231         <listitem>
 232           <para>
 233             not implemented
 234           </para>
 235         </listitem>
 236       </varlistentry>
 237
 238       <varlistentry>
 239         <term><constant>exit</constant></term>
 240         <listitem>
 241           <para>
 242             Exits the program.
 243           </para>
 244         </listitem>
 245       </varlistentry>
 246
 247       <varlistentry>
 248         <term><constant>set</constant>
 249           <replaceable>keyword<optional>=value</optional></replaceable></term>
 250         <listitem>
 251           <para>
 252             This command is used to change state information that affects
 253             the lookups.  Valid keywords are:
 254             <variablelist>
 255               <varlistentry>
 256                 <term><constant>all</constant></term>
 257                 <listitem>
 258                   <para>
 259                     Prints the current values of the frequently used
 260                     options to <command>set</command>.
 261                     Information about the  current default
 262                     server and host is also printed.
 263                   </para>
 264                 </listitem>
 265               </varlistentry>
 266
 267               <varlistentry>
 268                 <term><constant>class=</constant><replaceable>value</replaceable></term>
 269                 <listitem>
 270                   <para>
 271                     Change the query class to one of:
 272                     <variablelist>
 273                       <varlistentry>
 274                         <term><constant>IN</constant></term>
 275                         <listitem>
 276                           <para>
 277                             the Internet class
 278                           </para>
 279                         </listitem>
 280                       </varlistentry>
 281                       <varlistentry>
 282                         <term><constant>CH</constant></term>
 283                         <listitem>
 284                           <para>
 285                             the Chaos class
 286                           </para>
 287                         </listitem>
 288                       </varlistentry>
 289                       <varlistentry>
 290                         <term><constant>HS</constant></term>
 291                         <listitem>
 292                           <para>
 293                             the Hesiod class
 294                           </para>
 295                         </listitem>
 296                       </varlistentry>
 297                       <varlistentry>
 298                         <term><constant>ANY</constant></term>
 299                         <listitem>
 300                           <para>
 301                             wildcard
 302                           </para>
 303                         </listitem>
 304                       </varlistentry>
 305                     </variablelist>
 306                     The class specifies the protocol group of the information.
 307
 308                   </para>
 309                   <para>
 310                     (Default = IN; abbreviation = cl)
 311                   </para>
 312                 </listitem>
 313               </varlistentry>
 314
 315               <varlistentry>
 316                 <term><constant>
 317                     <replaceable><optional>no</optional></replaceable>debug</constant></term>
 318                 <listitem>
 319                   <para>
 320                     Turn on or off the display of the full response packet and
 321                     any intermediate response packets when searching.
 322                   </para>
 323                   <para>
 324                     (Default = nodebug; abbreviation = <optional>no</optional>deb)
 325                   </para>
 326                 </listitem>
 327               </varlistentry>
 328
 329               <varlistentry>
 330                 <term><constant>
 331                     <replaceable><optional>no</optional></replaceable>d2</constant></term>
 332                 <listitem>
 333                   <para>
 334                     Turn debugging mode on or off.  This displays more about
 335                     what nslookup is doing.
 336                   </para>
 337                   <para>
 338                     (Default = nod2)
 339                   </para>
 340                 </listitem>
 341               </varlistentry>
 342
 343               <varlistentry>
 344                 <term><constant>domain=</constant><replaceable>name</replaceable></term>
 345                 <listitem>
 346                   <para>
 347                     Sets the search list to <replaceable>name</replaceable>.
 348                   </para>
 349                 </listitem>
 350               </varlistentry>
 351
 352               <varlistentry>
 353                 <term><constant>
 354                     <replaceable><optional>no</optional></replaceable>search</constant></term>
 355                 <listitem>
 356                   <para>
 357                     If the lookup request contains at least one period but
 358                     doesn't end with a trailing period, append the domain
 359                     names in the domain search list to the request until an
 360                     answer is received.
 361                   </para>
 362                   <para>
 363                     (Default = search)
 364                   </para>
 365                 </listitem>
 366               </varlistentry>
 367
 368               <varlistentry>
 369                 <term><constant>port=</constant><replaceable>value</replaceable></term>
 370                 <listitem>
 371                   <para>
 372                     Change the default TCP/UDP name server port to <replaceable>value</replaceable>.
 373                   </para>
 374                   <para>
 375                     (Default = 53; abbreviation = po)
 376                   </para>
 377                 </listitem>
 378               </varlistentry>
 379
 380               <varlistentry>
 381                 <term><constant>querytype=</constant><replaceable>value</replaceable></term>
 382                 <listitem>
 383                   <para/>
 384                 </listitem>
 385               </varlistentry>
 386
 387               <varlistentry>
 388                 <term><constant>type=</constant><replaceable>value</replaceable></term>
 389                 <listitem>
 390                   <para>
 391                     Change the type of the information query.
 392                   </para>
 393                   <para>
 394                     (Default = A; abbreviations = q, ty)
 395                   </para>
 396                 </listitem>
 397               </varlistentry>
 398
 399               <varlistentry>
 400                 <term><constant>
 401                     <replaceable><optional>no</optional></replaceable>recurse</constant></term>
 402                 <listitem>
 403                   <para>
 404                     Tell the name server to query other servers if it does not
 405                     have the
 406                     information.
 407                   </para>
 408                   <para>
 409                     (Default = recurse; abbreviation = [no]rec)
 410                   </para>
 411                 </listitem>
 412               </varlistentry>
 413
 414               <varlistentry>
 415                 <term><constant>ndots=</constant><replaceable>number</replaceable></term>
 416                 <listitem>
 417                   <para>
 418                     Set the number of dots (label separators) in a domain
 419                     that will disable searching.  Absolute names always
 420                     stop searching.
 421                   </para>
 422                 </listitem>
 423               </varlistentry>
 424
 425               <varlistentry>
 426                 <term><constant>retry=</constant><replaceable>number</replaceable></term>
 427                 <listitem>
 428                   <para>
 429                     Set the number of retries to number.
 430                   </para>
 431                 </listitem>
 432               </varlistentry>
 433
 434               <varlistentry>
 435                 <term><constant>timeout=</constant><replaceable>number</replaceable></term>
 436                 <listitem>
 437                   <para>
 438                     Change the initial timeout interval for waiting for a
 439                     reply to number seconds.
 440                   </para>
 441                 </listitem>
 442               </varlistentry>
 443
 444               <varlistentry>
 445                 <term><constant>
 446                     <replaceable><optional>no</optional></replaceable>vc</constant></term>
 447                 <listitem>
 448                   <para>
 449                     Always use a virtual circuit when sending requests to the
 450                     server.
 451                   </para>
 452                   <para>
 453                     (Default = novc)
 454                   </para>
 455                 </listitem>
 456               </varlistentry>
 457
 458               <varlistentry>
 459                 <term><constant>
 460                     <replaceable><optional>no</optional></replaceable>fail</constant></term>
 461                 <listitem>
 462                   <para>
 463                     Try the next nameserver if a nameserver responds with
 464                     SERVFAIL or a referral (nofail) or terminate query
 465                     (fail) on such a response.
 466                   </para>
 467                   <para>
 468                     (Default = nofail)
 469                   </para>
 470                 </listitem>
 471               </varlistentry>
 472
 473             </variablelist>
 474           </para>
 475         </listitem>
 476       </varlistentry>
 477     </variablelist>
 478   </refsect1>
 479
 480   <refsect1>
 481     <title>FILES</title>
 482     <para><filename>/etc/resolv.conf</filename>
 483     </para>
 484   </refsect1>
 485
 486   <refsect1>
 487     <title>SEE ALSO</title>
 488     <para><citerefentry>
 489         <refentrytitle>dig</refentrytitle><manvolnum>1</manvolnum>
 490       </citerefentry>,
 491       <citerefentry>
 492         <refentrytitle>host</refentrytitle><manvolnum>1</manvolnum>
 493       </citerefentry>,
 494       <citerefentry>
 495         <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
 496       </citerefentry>.
 497     </para>
 498   </refsect1>
 499
 500   <refsect1>
 501     <title>Author</title>
 502     <para>
 503       Andrew Cherenson
 504     </para>
 505   </refsect1>
 506 </refentry><!--
 507  - Local variables:
 508  - mode: sgml
 509  - End:
 510 -->