contrib/bind9/bin/dig/nslookup.docbook

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