contrib/bind9/bin/dig/nslookup.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004-2006  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and 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 <!-- $Id: nslookup.docbook,v 1.3.6.7 2006/01/06 00:01:42 marka Exp $ -->
  21
  22 <!--
  23  - Copyright (c) 1985, 1989
  24  -    The Regents of the University of California.  All rights reserved.
  25  -
  26  - Redistribution and use in source and binary forms, with or without
  27  - modification, are permitted provided that the following conditions
  28  - are met:
  29  - 1. Redistributions of source code must retain the above copyright
  30  -    notice, this list of conditions and the following disclaimer.
  31  - 2. Redistributions in binary form must reproduce the above copyright
  32  -    notice, this list of conditions and the following disclaimer in the
  33  -    documentation and/or other materials provided with the distribution.
  34  - 3. All advertising materials mentioning features or use of this software
  35  -    must display the following acknowledgement:
  36  -     This product includes software developed by the University of
  37  -     California, Berkeley and its contributors.
  38  - 4. Neither the name of the University nor the names of its contributors
  39  -    may be used to endorse or promote products derived from this software
  40  -    without specific prior written permission.
  41  -
  42  - THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  - ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  - OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  - HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  - LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  - SUCH DAMAGE.
  53 -->
  54
  55 <refentry>
  56
  57 <refentryinfo>
  58 <date>Jun 30, 2000</date>
  59 </refentryinfo>
  60
  61 <refmeta>
  62 <refentrytitle>nslookup</refentrytitle>
  63 <manvolnum>1</manvolnum>
  64 <refmiscinfo>BIND9</refmiscinfo>
  65 </refmeta>
  66
  67   <docinfo>
  68     <copyright>
  69       <year>2004</year>
  70       <year>2005</year>
  71       <year>2006</year>
  72       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  73     </copyright>
  74   </docinfo>
  75
  76 <refnamediv>
  77 <refname>nslookup</refname>
  78 <refpurpose>query Internet name servers interactively</refpurpose>
  79 </refnamediv>
  80
  81 <refsynopsisdiv>
  82 <cmdsynopsis>
  83   <command>nslookup</command>
  84   <arg><option>-option</option></arg>
  85   <arg choice="opt">name | -</arg>
  86   <arg choice="opt">server</arg>
  87 </cmdsynopsis>
  88 </refsynopsisdiv>
  89
  90 <refsect1>
  91 <title>DESCRIPTION</title>
  92 <para>
  93 <command>Nslookup</command>
  94 is a program to query Internet domain name servers.  <command>Nslookup</command>
  95 has two modes: interactive and non-interactive.  Interactive mode allows
  96 the user to query name servers for information about various hosts and
  97 domains or to print a list of hosts in a domain.  Non-interactive mode is
  98 used to print just the name and requested information for a host or
  99 domain.
 100 </para>
 101 </refsect1>
 102
 103 <refsect1>
 104 <title>ARGUMENTS</title>
 105 <para>
 106 Interactive mode is entered in the following cases:
 107 <orderedlist numeration="loweralpha">
 108 <listitem>
 109 <para>
 110 when no arguments are given (the default name server will be used)
 111 </para>
 112 </listitem>
 113 <listitem>
 114 <para>
 115 when the first argument is a hyphen (-) and the second argument is
 116 the host name or Internet address of a name server.
 117 </para>
 118 </listitem>
 119 </orderedlist>
 120 </para>
 121
 122 <para>
 123 Non-interactive mode is used when the name or Internet address of the
 124 host to be looked up is given as the first argument. The optional second
 125 argument specifies the host name or address of a name server.
 126 </para>
 127
 128 <para>
 129 Options can also be specified on the command line if they precede the
 130 arguments and are prefixed with a hyphen.  For example, to
 131 change the default query type to host information, and the initial timeout to 10 seconds, type:
 132 <informalexample>
 133 <programlisting>
 134 nslookup -query=hinfo  -timeout=10
 135 </programlisting>
 136 </informalexample>
 137 </para>
 138
 139 </refsect1>
 140
 141 <refsect1>
 142 <title>INTERACTIVE COMMANDS</title>
 143 <variablelist>
 144 <varlistentry><term>host <optional>server</optional></term>
 145 <listitem><para>
 146 Look up information for host using the current default server or
 147 using server, if specified.  If host is an Internet address and
 148 the query type is A or PTR, the name of the host is returned.
 149 If host is a name and does not have a trailing period, the
 150 search list is used to qualify the name.
 151 </para>
 152
 153 <para>
 154 To look up a host not in the current domain, append a period to
 155 the name.
 156 </para></listitem></varlistentry>
 157
 158 <varlistentry><term><constant>server</constant> <replaceable class="parameter">domain</replaceable></term>
 159 <listitem><para></para></listitem></varlistentry>
 160 <varlistentry><term><constant>lserver</constant> <replaceable class="parameter">domain</replaceable></term>
 161 <listitem><para>
 162 Change the default server to <replaceable>domain</replaceable>; <constant>lserver</constant> uses the initial
 163 server to look up information about <replaceable>domain</replaceable>, while <constant>server</constant> uses
 164 the current default server.  If an authoritative answer can't be
 165 found, the names of servers that might have the answer are
 166 returned.
 167 </para></listitem></varlistentry>
 168
 169 <varlistentry><term><constant>root</constant></term>
 170 <listitem><para>not implemented</para></listitem></varlistentry>
 171
 172 <varlistentry><term><constant>finger</constant></term>
 173 <listitem><para>not implemented</para></listitem></varlistentry>
 174
 175 <varlistentry><term><constant>ls</constant></term>
 176 <listitem><para>not implemented</para></listitem></varlistentry>
 177
 178 <varlistentry><term><constant>view</constant></term>
 179 <listitem><para>not implemented</para></listitem></varlistentry>
 180
 181 <varlistentry><term><constant>help</constant></term>
 182 <listitem><para>not implemented</para></listitem></varlistentry>
 183
 184 <varlistentry><term><constant>?</constant></term>
 185 <listitem><para>not implemented</para></listitem></varlistentry>
 186
 187 <varlistentry><term><constant>exit</constant></term>
 188 <listitem><para>Exits the program.</para></listitem></varlistentry>
 189
 190 <varlistentry><term><constant>set</constant> <replaceable>keyword<optional>=value</optional></replaceable></term>
 191 <listitem><para>This command is used to change state information that affects
 192 the lookups.  Valid keywords are:
 193  <variablelist>
 194   <varlistentry><term><constant>all</constant></term>
 195   <listitem>
 196   <para>Prints the current values of the frequently used
 197   options to <command>set</command>.  Information about the  current default
 198   server and host is also printed.
 199   </para>
 200   </listitem>
 201   </varlistentry>
 202
 203   <varlistentry><term><constant>class=</constant><replaceable>value</replaceable></term>
 204   <listitem><para>
 205    Change the query class to one of:
 206    <variablelist>
 207     <varlistentry><term><constant>IN</constant></term>
 208     <listitem><para>the Internet class</para></listitem></varlistentry>
 209     <varlistentry><term><constant>CH</constant></term>
 210     <listitem><para>the Chaos class</para></listitem></varlistentry>
 211     <varlistentry><term><constant>HS</constant></term>
 212     <listitem><para>the Hesiod class</para></listitem></varlistentry>
 213     <varlistentry><term><constant>ANY</constant></term>
 214     <listitem><para>wildcard</para></listitem></varlistentry>
 215    </variablelist>
 216    The class specifies the protocol group of the information.
 217    </para><para>
 218    (Default = IN; abbreviation = cl)
 219    </para></listitem>
 220   </varlistentry>
 221
 222   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>debug</constant></term>
 223   <listitem><para>
 224   Turn debugging mode on.  A lot more information is
 225   printed about the packet sent to the server and the
 226   resulting answer.
 227   </para><para>
 228   (Default = nodebug; abbreviation = <optional>no</optional>deb)
 229   </para></listitem></varlistentry>
 230
 231   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>d2</constant></term>
 232   <listitem><para>
 233   Turn debugging mode on.  A lot more information is
 234   printed about the packet sent to the server and the
 235   resulting answer.
 236   </para><para>
 237   (Default = nod2)
 238   </para></listitem></varlistentry>
 239
 240   <varlistentry><term><constant>domain=</constant><replaceable>name</replaceable></term>
 241   <listitem><para>
 242   Sets the search list to <replaceable>name</replaceable>.
 243   </para></listitem></varlistentry>
 244
 245   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>search</constant></term>
 246   <listitem><para>
 247   If the lookup request contains at least one period but
 248   doesn't end with a trailing period, append the domain
 249   names in the domain search list to the request until an
 250   answer is received.
 251   </para><para>
 252   (Default = search)
 253   </para></listitem></varlistentry>
 254
 255   <varlistentry><term><constant>port=</constant><replaceable>value</replaceable></term>
 256   <listitem><para>
 257   Change the default TCP/UDP name server port to <replaceable>value</replaceable>.
 258   </para><para>
 259   (Default = 53; abbreviation = po)
 260   </para></listitem></varlistentry>
 261
 262   <varlistentry><term><constant>querytype=</constant><replaceable>value</replaceable></term>
 263   <listitem><para></para></listitem></varlistentry>
 264
 265   <varlistentry><term><constant>type=</constant><replaceable>value</replaceable></term>
 266   <listitem><para>
 267   Change the type of the information query.
 268   </para><para>
 269   (Default = A; abbreviations = q, ty)
 270   </para></listitem></varlistentry>
 271
 272   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>recurse</constant></term>
 273   <listitem><para>
 274   Tell the name server to query other servers if it does not have the
 275   information.
 276   </para><para>
 277   (Default = recurse; abbreviation = [no]rec)
 278   </para></listitem></varlistentry>
 279
 280   <varlistentry><term><constant>retry=</constant><replaceable>number</replaceable></term>
 281   <listitem><para>
 282   Set the number of retries to number.
 283   </para></listitem></varlistentry>
 284
 285   <varlistentry><term><constant>timeout=</constant><replaceable>number</replaceable></term>
 286   <listitem><para>
 287   Change the initial timeout interval for waiting for a
 288   reply to number seconds.
 289   </para></listitem></varlistentry>
 290
 291   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>vc</constant></term>
 292   <listitem><para>
 293   Always use a virtual circuit when sending requests to the server.
 294   </para><para>
 295   (Default = novc)
 296   </para></listitem></varlistentry>
 297
 298   </variablelist>
 299 </para></listitem></varlistentry>
 300 </variablelist>
 301 </refsect1>
 302
 303 <refsect1>
 304 <title>FILES</title>
 305 <para>
 306 <filename>/etc/resolv.conf</filename>
 307 </para>
 308 </refsect1>
 309
 310 <refsect1>
 311 <title>SEE ALSO</title>
 312 <para>
 313 <citerefentry>
 314 <refentrytitle>dig</refentrytitle><manvolnum>1</manvolnum>
 315 </citerefentry>,
 316 <citerefentry>
 317 <refentrytitle>host</refentrytitle><manvolnum>1</manvolnum>
 318 </citerefentry>,
 319 <citerefentry>
 320 <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
 321 </citerefentry>.
 322 </para>
 323 </refsect1>
 324
 325 <refsect1>
 326 <title>Author</title>
 327 <para>
 328 Andrew Cherenson
 329 </para>
 330 </refsect1>
 331 </refentry>