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, 2005  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.5 2005/05/13 01:22:33 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       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  72     </copyright>
  73   </docinfo>
  74
  75 <refnamediv>
  76 <refname>nslookup</refname>
  77 <refpurpose>query Internet name servers interactively</refpurpose>
  78 </refnamediv>
  79
  80 <refsynopsisdiv>
  81 <cmdsynopsis>
  82   <command>nslookup</command>
  83   <arg><option>-option</option></arg>
  84   <arg choice="opt">name | -</arg>
  85   <arg choice="opt">server</arg>
  86 </cmdsynopsis>
  87 </refsynopsisdiv>
  88
  89 <refsect1>
  90 <title>DESCRIPTION</title>
  91 <para>
  92 <command>Nslookup</command>
  93 is a program to query Internet domain name servers.  <command>Nslookup</command>
  94 has two modes: interactive and non-interactive.  Interactive mode allows
  95 the user to query name servers for information about various hosts and
  96 domains or to print a list of hosts in a domain.  Non-interactive mode is
  97 used to print just the name and requested information for a host or
  98 domain.
  99 </para>
 100 </refsect1>
 101
 102 <refsect1>
 103 <title>ARGUMENTS</title>
 104 <para>
 105 Interactive mode is entered in the following cases:
 106 <orderedlist numeration="loweralpha">
 107 <listitem>
 108 <para>
 109 when no arguments are given (the default name server will be used)
 110 </para>
 111 </listitem>
 112 <listitem>
 113 <para>
 114 when the first argument is a hyphen (-) and the second argument is
 115 the host name or Internet address of a name server.
 116 </para>
 117 </listitem>
 118 </orderedlist>
 119 </para>
 120
 121 <para>
 122 Non-interactive mode is used when the name or Internet address of the
 123 host to be looked up is given as the first argument. The optional second
 124 argument specifies the host name or address of a name server.
 125 </para>
 126
 127 <para>
 128 Options can also be specified on the command line if they precede the
 129 arguments and are prefixed with a hyphen.  For example, to
 130 change the default query type to host information, and the initial timeout to 10 seconds, type:
 131 <informalexample>
 132 <programlisting>
 133 nslookup -query=hinfo  -timeout=10
 134 </programlisting>
 135 </informalexample>
 136 </para>
 137
 138 </refsect1>
 139
 140 <refsect1>
 141 <title>INTERACTIVE COMMANDS</title>
 142 <variablelist>
 143 <varlistentry><term>host <optional>server</optional></term>
 144 <listitem><para>
 145 Look up information for host using the current default server or
 146 using server, if specified.  If host is an Internet address and
 147 the query type is A or PTR, the name of the host is returned.
 148 If host is a name and does not have a trailing period, the
 149 search list is used to qualify the name.
 150 </para>
 151
 152 <para>
 153 To look up a host not in the current domain, append a period to
 154 the name.
 155 </para></listitem></varlistentry>
 156
 157 <varlistentry><term><constant>server</constant> <replaceable class="parameter">domain</replaceable></term>
 158 <listitem><para></para></listitem></varlistentry>
 159 <varlistentry><term><constant>lserver</constant> <replaceable class="parameter">domain</replaceable></term>
 160 <listitem><para>
 161 Change the default server to <replaceable>domain</replaceable>; <constant>lserver</constant> uses the initial
 162 server to look up information about <replaceable>domain</replaceable>, while <constant>server</constant> uses
 163 the current default server.  If an authoritative answer can't be
 164 found, the names of servers that might have the answer are
 165 returned.
 166 </para></listitem></varlistentry>
 167
 168 <varlistentry><term><constant>root</constant></term>
 169 <listitem><para>not implemented</para></listitem></varlistentry>
 170
 171 <varlistentry><term><constant>finger</constant></term>
 172 <listitem><para>not implemented</para></listitem></varlistentry>
 173
 174 <varlistentry><term><constant>ls</constant></term>
 175 <listitem><para>not implemented</para></listitem></varlistentry>
 176
 177 <varlistentry><term><constant>view</constant></term>
 178 <listitem><para>not implemented</para></listitem></varlistentry>
 179
 180 <varlistentry><term><constant>help</constant></term>
 181 <listitem><para>not implemented</para></listitem></varlistentry>
 182
 183 <varlistentry><term><constant>?</constant></term>
 184 <listitem><para>not implemented</para></listitem></varlistentry>
 185
 186 <varlistentry><term><constant>exit</constant></term>
 187 <listitem><para>Exits the program.</para></listitem></varlistentry>
 188
 189 <varlistentry><term><constant>set</constant> <replaceable>keyword<optional>=value</optional></replaceable></term>
 190 <listitem><para>This command is used to change state information that affects
 191 the lookups.  Valid keywords are:
 192  <variablelist>
 193   <varlistentry><term><constant>all</constant></term>
 194   <listitem>
 195   <para>Prints the current values of the frequently used
 196   options to <command>set</command>.  Information about the  current default
 197   server and host is also printed.
 198   </para>
 199   </listitem>
 200   </varlistentry>
 201
 202   <varlistentry><term><constant>class=</constant><replaceable>value</replaceable></term>
 203   <listitem><para>
 204    Change the query class to one of:
 205    <variablelist>
 206     <varlistentry><term><constant>IN</constant></term>
 207     <listitem><para>the Internet class</para></listitem></varlistentry>
 208     <varlistentry><term><constant>CH</constant></term>
 209     <listitem><para>the Chaos class</para></listitem></varlistentry>
 210     <varlistentry><term><constant>HS</constant></term>
 211     <listitem><para>the Hesiod class</para></listitem></varlistentry>
 212     <varlistentry><term><constant>ANY</constant></term>
 213     <listitem><para>wildcard</para></listitem></varlistentry>
 214    </variablelist>
 215    The class specifies the protocol group of the information.
 216    </para><para>
 217    (Default = IN; abbreviation = cl)
 218    </para></listitem>
 219   </varlistentry>
 220
 221   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>debug</constant></term>
 222   <listitem><para>
 223   Turn debugging mode on.  A lot more information is
 224   printed about the packet sent to the server and the
 225   resulting answer.
 226   </para><para>
 227   (Default = nodebug; abbreviation = <optional>no</optional>deb)
 228   </para></listitem></varlistentry>
 229
 230   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>d2</constant></term>
 231   <listitem><para>
 232   Turn debugging mode on.  A lot more information is
 233   printed about the packet sent to the server and the
 234   resulting answer.
 235   </para><para>
 236   (Default = nod2)
 237   </para></listitem></varlistentry>
 238
 239   <varlistentry><term><constant>domain=</constant><replaceable>name</replaceable></term>
 240   <listitem><para>
 241   Sets the search list to <replaceable>name</replaceable>.
 242   </para></listitem></varlistentry>
 243
 244   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>search</constant></term>
 245   <listitem><para>
 246   If the lookup request contains at least one period but
 247   doesn't end with a trailing period, append the domain
 248   names in the domain search list to the request until an
 249   answer is received.
 250   </para><para>
 251   (Default = search)
 252   </para></listitem></varlistentry>
 253
 254   <varlistentry><term><constant>port=</constant><replaceable>value</replaceable></term>
 255   <listitem><para>
 256   Change the default TCP/UDP name server port to <replaceable>value</replaceable>.
 257   </para><para>
 258   (Default = 53; abbreviation = po)
 259   </para></listitem></varlistentry>
 260
 261   <varlistentry><term><constant>querytype=</constant><replaceable>value</replaceable></term>
 262   <listitem><para></para></listitem></varlistentry>
 263
 264   <varlistentry><term><constant>type=</constant><replaceable>value</replaceable></term>
 265   <listitem><para>
 266   Change the top of the information query.
 267   </para><para>
 268   (Default = A; abbreviations = q, ty)
 269   </para></listitem></varlistentry>
 270
 271   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>recurse</constant></term>
 272   <listitem><para>
 273   Tell the name server to query other servers if it does not have the
 274   information.
 275   </para><para>
 276   (Default = recurse; abbreviation = [no]rec)
 277   </para></listitem></varlistentry>
 278
 279   <varlistentry><term><constant>retry=</constant><replaceable>number</replaceable></term>
 280   <listitem><para>
 281   Set the number of retries to number.
 282   </para></listitem></varlistentry>
 283
 284   <varlistentry><term><constant>timeout=</constant><replaceable>number</replaceable></term>
 285   <listitem><para>
 286   Change the initial timeout interval for waiting for a
 287   reply to number seconds.
 288   </para></listitem></varlistentry>
 289
 290   <varlistentry><term><constant><replaceable><optional>no</optional></replaceable>vc</constant></term>
 291   <listitem><para>
 292   Always use a virtual circuit when sending requests to the server.
 293   </para><para>
 294   (Default = novc)
 295   </para></listitem></varlistentry>
 296
 297   </variablelist>
 298 </para></listitem></varlistentry>
 299 </variablelist>
 300 </refsect1>
 301
 302 <refsect1>
 303 <title>FILES</title>
 304 <para>
 305 <filename>/etc/resolv.conf</filename>
 306 </para>
 307 </refsect1>
 308
 309 <refsect1>
 310 <title>SEE ALSO</title>
 311 <para>
 312 <citerefentry>
 313 <refentrytitle>dig</refentrytitle><manvolnum>1</manvolnum>
 314 </citerefentry>,
 315 <citerefentry>
 316 <refentrytitle>host</refentrytitle><manvolnum>1</manvolnum>
 317 </citerefentry>,
 318 <citerefentry>
 319 <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
 320 </citerefentry>.
 321 </para>
 322 </refsect1>
 323
 324 <refsect1>
 325 <title>Author</title>
 326 <para>
 327 Andrew Cherenson
 328 </para>
 329 </refsect1>
 330 </refentry>