nslookup.docbook revision 33d96fbbc8aa221508f3c780539bf44810fd2c9c
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
206a2ec1714a36057227ad8ebafd23cd4972f21fMark Andrews<!--
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - Copyright (C) 2000-2002 Internet Software Consortium.
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews -
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - Permission to use, copy, modify, and distribute this software for any
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - purpose with or without fee is hereby granted, provided that the above
7d8b12117d49b4ebe24841c857f2b87b2056ae88Mark Andrews - copyright notice and this permission notice appear in all copies.
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews -
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7d8b12117d49b4ebe24841c857f2b87b2056ae88Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f89ccd99a4c1f3fa8e0d610463fb9afad4174c5cMark Andrews - PERFORMANCE OF THIS SOFTWARE.
f89ccd99a4c1f3fa8e0d610463fb9afad4174c5cMark Andrews-->
f89ccd99a4c1f3fa8e0d610463fb9afad4174c5cMark Andrews
f89ccd99a4c1f3fa8e0d610463fb9afad4174c5cMark Andrews<!-- $Id: nslookup.docbook,v 1.2 2004/08/16 04:31:01 marka Exp $ -->
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews<--
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - Copyright (c) 1985, 1989
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - The Regents of the University of California. All rights reserved.
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews -
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - Redistribution and use in source and binary forms, with or without
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - modification, are permitted provided that the following conditions
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - are met:
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - 1. Redistributions of source code must retain the above copyright
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - notice, this list of conditions and the following disclaimer.
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - 2. Redistributions in binary form must reproduce the above copyright
a963386d02b0b21d26a50fce1ef442602c81377bMark Andrews - notice, this list of conditions and the following disclaimer in the
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - documentation and/or other materials provided with the distribution.
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - 3. All advertising materials mentioning features or use of this software
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - must display the following acknowledgement:
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - This product includes software developed by the University of
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - California, Berkeley and its contributors.
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - 4. Neither the name of the University nor the names of its contributors
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - may be used to endorse or promote products derived from this software
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews - without specific prior written permission.
9a2a12db5a179ff7b9711a0c035036223f6fae79Mark Andrews -
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
9213ea3cec20ddb6a305f4d877b75eaa8100c02dMark Andrews - ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
9213ea3cec20ddb6a305f4d877b75eaa8100c02dMark Andrews - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
9213ea3cec20ddb6a305f4d877b75eaa8100c02dMark Andrews - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews - OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
206a2ec1714a36057227ad8ebafd23cd4972f21fMark Andrews - HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
9213ea3cec20ddb6a305f4d877b75eaa8100c02dMark Andrews - LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
206a2ec1714a36057227ad8ebafd23cd4972f21fMark Andrews - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews - SUCH DAMAGE.
88a44b0542f5544bc2c29ed64540e4ddfe6eed87Mark Andrews-->
206a2ec1714a36057227ad8ebafd23cd4972f21fMark Andrews
206a2ec1714a36057227ad8ebafd23cd4972f21fMark Andrews<refentry>
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews
393fd55d91306e6def3a3d06748eee031f57bd17Mark Andrews<refentryinfo>
206a2ec1714a36057227ad8ebafd23cd4972f21fMark Andrews<date>Jun 30, 2000</date>
</refentryinfo>
<refmeta>
<refentrytitle>nslookup</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>BIND9</refmiscinfo>
</refmeta>
<refnamediv>
<refname>nslookup</refname>
<refpurpose>query Internet name servers interactively</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>nslookup</command>
<arg><option>-option</option></arg>
<arg choice=opt>name | -</arg>
<arg choice=opt>server</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command>Nslookup</command>
is a program to query Internet domain name servers. <command>Nslookup</command>
has two modes: interactive and non-interactive. Interactive mode allows
the user to query name servers for information about various hosts and
domains or to print a list of hosts in a domain. Non-interactive mode is
used to print just the name and requested information for a host or
domain.
</para>
</refsect1>
<refsect1>
<title>ARGUMENTS</title>
<para>
Interactive mode is entered in the following cases:
<OrderedList Numeration=Loweralpha>
<Listitem>
<para>
when no arguments are given (the default name server will be used)
</para>
</Listitem>
<Listitem>
<para>
when the first argument is a hyphen (-) and the second argument is
the host name or Internet address of a name server.
</para>
</Listitem>
</OrderedList>
</para>
<para>
Non-interactive mode is used when the name or Internet address of the
host to be looked up is given as the first argument. The optional second
argument specifies the host name or address of a name server.
</para>
<para>
Options can also be specified on the command line if they precede the
arguments and are prefixed with a hyphen. For example, to
change the default query type to host information, and the initial timeout to 10 seconds, type:
<InformalExample>
<PROGRAMLISTING>
nslookup -query=hinfo -timeout=10
</PROGRAMLISTING>
</InformalExample>
</para>
</refsect1>
<refsect1>
<title>INTERACTIVE COMMANDS</title>
<variablelist>
<varlistentry><term>host <optional>server</optional></term>
<listitem><para>
Look up information for host using the current default server or
using server, if specified. If host is an Internet address and
the query type is A or PTR, the name of the host is returned.
If host is a name and does not have a trailing period, the
search list is used to qualify the name.
</para>
<para>
To look up a host not in the current domain, append a period to
the name.
</para></listitem></varlistentry>
<varlistentry><term><constant>server</constant> <replaceable class="parameter">domain</replaceable></term>
<listitem><para></para></listitem>
<varlistentry><term><constant>lserver</constant> <replaceable class="parameter">domain</replaceable></term>
<listitem><para>
Change the default server to <replaceable>domain</replaceable>; <constant>lserver</constant> uses the initial
server to look up information about <replaceable>domain</replaceable>, while <constant>server</constant> uses
the current default server. If an authoritative answer can't be
found, the names of servers that might have the answer are
returned.
</para></listitem></varlistentry>
<varlistentry><term><constant>root</constant></term>
<listitem><para>not implemented</para></listitem></varlistentry>
<varlistentry><term><constant>finger</constant></term>
<listitem><para>not implemented</para></listitem></varlistentry>
<varlistentry><term><constant>ls</constant></term>
<listitem><para>not implemented</para></listitem></varlistentry>
<varlistentry><term><constant>view</constant></term>
<listitem><para>not implemented</para></listitem></varlistentry>
<varlistentry><term><constant>help</constant></term>
<listitem><para>not implemented</para></listitem></varlistentry>
<varlistentry><term><constant>?</constant></term>
<listitem><para>not implemented</para></listitem></varlistentry>
<varlistentry><term><constant>exit</constant></term>
<listitem><para>Exits the program.</para></listitem></varlistentry>
<varlistentry><term><constant>set</constant> <replaceable>keyword<optional>=value</optional></replaceable></term>
<listitem><para>This command is used to change state information that affects
the lookups. Valid keywords are:
<variablelist>
<varlistentry><term><constant>all</constant></term>
<listitem>
<para>Prints the current values of the frequently used
options to <command>set</command>. Information about the current default
server and host is also printed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><constant>class=</constant><replaceable>value</replaceable></term>
<listitem><para>
Change the query class to one of:
<variablelist>
<varlistentry><term><constant>IN</constant></term>
<listitem><para>the Internet class</para></listitem></varlistentry>
<varlistentry><term><constant>CH</constant></term>
<listitem><para>the Chaos class</para></listitem></varlistentry>
<varlistentry><term><constant>HS</constant></term>
<listitem><para>the Hesiod class</para></listitem></varlistentry>
<varlistentry><term><constant>ANY</constant></term>
<listitem><para>wildcard</para></listitem></varlistentry>
</variablelist>
The class specifies the protocol group of the information.
</para><para>
(Default = IN; abbreviation = cl)
</para></listitem>
</varlistentry>
<varlistentry><term><constant><replaceable><optional>no</optional></replaceable>debug</constant></term>
<listitem><para>
Turn debugging mode on. A lot more information is
printed about the packet sent to the server and the
resulting answer.
</para><para>
(Default = nodebug; abbreviation = <optional>no</optional>deb)
</para></listitem>
<varlistentry><term><constant><replaceable><optional>no</optional></replaceable>d2</constant></term>
<listitem><para>
Turn debugging mode on. A lot more information is
printed about the packet sent to the server and the
resulting answer.
</para><para>
(Default = nod2)
</para></listitem>
<varlistentry><term><constant>domain=</constant><replaceable>name</replaceable></term>
<listitem><para>
Sets the search list to <replaceable>name</replaceable>.
</para></listitem></varlistentry>
<varlistentry><term><constant><replaceable><optional>no</optional></replaceable>search</constant></term>
<listitem><para>
If the lookup request contains at least one period but
doesn't end with a trailing period, append the domain
names in the domain search list to the request until an
answer is received.
</para><para>
(Default = search)
</para></listitem>
<varlistentry><term><constant>port=</constant><replaceable>value</replaceable></term>
<listitem><para>
Change the default TCP/UDP name server port to <replaceable>value</replaceable>.
</para><para>
(Default = 53; abbreviation = po)
</para></listitem></varlistentry>
<varlistentry><term><constant>querytype=</constant><replaceable>value</replaceable></term>
<listitem><para></para></listitem></varlistentry>
<varlistentry><term><constant>type=</constant><replaceable>value</replaceable></term>
<listitem><para>
Change the top of the information query.
</para><para>
(Default = A; abbreviations = q, ty)
</para></listitem></varlistentry>
<varlistentry><term><constant><replaceable><optional>no</optional></replaceable>recurse</constant></term>
<listitem><para>
Tell the name server to query other servers if it does not have the
information.
</para><para>
(Default = recurse; abbreviation = [no]rec)
</para></listitem>
<varlistentry><term><constant>retry=</constant><replaceable>number</replaceable></term>
<listitem><para>
Set the number of retries to number.
</para></listitem></varlistentry>
<varlistentry><term><constant>timeout=</constant><replaceable>number</replaceable></term>
<listitem><para>
Change the initial timeout interval for waiting for a
reply to number seconds.
</para></listitem></varlistentry>
<varlistentry><term><constant><replaceable><optional>no</optional></replaceable>vc</constant></term>
<listitem><para>
Always use a virtual circuit when sending requests to the server.
</para><para>
(Default = novc)
</para></listitem>
</variablelist>
</para></listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para>
<filename>/etc/resolv.conf</filename>
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>dig</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>host</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>.
</para>
</refsect1>
<refsect1>
</refsect1>
<title>Author</title>
<para>
Andrew Cherenson
</para>
</refentry>