nslookup.docbook revision 8afea636ab0c07399aa3e2410b2cfbd41099df98
148N/A<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
148N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
148N/A [<!ENTITY mdash "&#8212;">]>
148N/A<!--
148N/A - Copyright (C) 2004-2007, 2010 Internet Systems Consortium, Inc. ("ISC")
148N/A -
148N/A - Permission to use, copy, modify, and/or distribute this software for any
148N/A - purpose with or without fee is hereby granted, provided that the above
148N/A - copyright notice and this permission notice appear in all copies.
148N/A -
148N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
148N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
148N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
148N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
148N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
148N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
148N/A - PERFORMANCE OF THIS SOFTWARE.
148N/A-->
148N/A
148N/A<!-- $Id: nslookup.docbook,v 1.18 2010/02/22 23:49:11 tbox Exp $ -->
148N/A<!--
148N/A - Copyright (c) 1985, 1989
3996N/A - The Regents of the University of California. All rights reserved.
148N/A -
148N/A - Redistribution and use in source and binary forms, with or without
148N/A - modification, are permitted provided that the following conditions
148N/A - are met:
148N/A - 1. Redistributions of source code must retain the above copyright
5251N/A - notice, this list of conditions and the following disclaimer.
618N/A - 2. Redistributions in binary form must reproduce the above copyright
148N/A - notice, this list of conditions and the following disclaimer in the
148N/A - documentation and/or other materials provided with the distribution.
844N/A - 3. All advertising materials mentioning features or use of this software
5251N/A - must display the following acknowledgement:
148N/A - This product includes software developed by the University of
1273N/A - California, Berkeley and its contributors.
148N/A - 4. Neither the name of the University nor the names of its contributors
1002N/A - may be used to endorse or promote products derived from this software
1316N/A - without specific prior written permission.
1002N/A -
1316N/A - THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1002N/A - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1002N/A - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
5251N/A - ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
3510N/A - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3996N/A - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3996N/A - OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3996N/A - HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3996N/A - LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
148N/A - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
5252N/A - SUCH DAMAGE.
5252N/A-->
148N/A<refentry>
148N/A
148N/A <refentryinfo>
3985N/A <date>Jun 30, 2000</date>
3985N/A </refentryinfo>
3985N/A
148N/A <refmeta>
148N/A <refentrytitle>nslookup</refentrytitle>
148N/A <manvolnum>1</manvolnum>
148N/A <refmiscinfo>BIND9</refmiscinfo>
3510N/A </refmeta>
1316N/A
1316N/A <refnamediv>
148N/A <refname>nslookup</refname>
148N/A <refpurpose>query Internet name servers interactively</refpurpose>
148N/A </refnamediv>
690N/A
148N/A <docinfo>
3781N/A <copyright>
3781N/A <year>2004</year>
3781N/A <year>2005</year>
3781N/A <year>2006</year>
3781N/A <year>2007</year>
3781N/A <year>2010</year>
3781N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
3781N/A </copyright>
3781N/A </docinfo>
3781N/A
3781N/A <refsynopsisdiv>
3783N/A <cmdsynopsis>
3783N/A <command>nslookup</command>
3781N/A <arg><option>-option</option></arg>
3781N/A <arg choice="opt">name | -</arg>
3781N/A <arg choice="opt">server</arg>
3781N/A </cmdsynopsis>
3783N/A </refsynopsisdiv>
3783N/A
3783N/A <refsect1>
3783N/A <title>DESCRIPTION</title>
3781N/A <para><command>Nslookup</command>
3781N/A is a program to query Internet domain name servers. <command>Nslookup</command>
727N/A has two modes: interactive and non-interactive. Interactive mode allows
727N/A the user to query name servers for information about various hosts and
3781N/A domains or to print a list of hosts in a domain. Non-interactive mode
727N/A is
3781N/A used to print just the name and requested information for a host or
3781N/A domain.
3781N/A </para>
727N/A </refsect1>
3781N/A
1822N/A <refsect1>
3781N/A <title>ARGUMENTS</title>
3781N/A <para>
3781N/A Interactive mode is entered in the following cases:
1822N/A <orderedlist numeration="loweralpha">
1822N/A <listitem>
1822N/A <para>
1822N/A when no arguments are given (the default name server will be used)
1822N/A </para>
3781N/A </listitem>
3781N/A <listitem>
3781N/A <para>
1822N/A when the first argument is a hyphen (-) and the second argument is
3781N/A the host name or Internet address of a name server.
3781N/A </para>
1822N/A </listitem>
1822N/A </orderedlist>
1822N/A </para>
727N/A
148N/A <para>
5252N/A Non-interactive mode is used when the name or Internet address of the
5252N/A host to be looked up is given as the first argument. The optional second
148N/A argument specifies the host name or address of a name server.
148N/A </para>
148N/A
560N/A <para>
727N/A Options can also be specified on the command line if they precede the
3781N/A arguments and are prefixed with a hyphen. For example, to
148N/A change the default query type to host information, and the initial
181N/A timeout to 10 seconds, type:
148N/A <!-- <informalexample> produces bad nroff. -->
148N/A <programlisting>
3996N/Anslookup -query=hinfo -timeout=10
3996N/A</programlisting>
3996N/A <!-- </informalexample> -->
3996N/A </para>
3996N/A
3996N/A </refsect1>
3996N/A
3996N/A <refsect1>
3996N/A <title>INTERACTIVE COMMANDS</title>
<variablelist>
<varlistentry>
<term><constant>host</constant> <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/>
</listitem>
</varlistentry>
<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 on or off the display of the full response packet and
any intermediate response packets when searching.
</para>
<para>
(Default = nodebug; abbreviation = <optional>no</optional>deb)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>
<replaceable><optional>no</optional></replaceable>d2</constant></term>
<listitem>
<para>
Turn debugging mode on or off. This displays more about
what nslookup is doing.
</para>
<para>
(Default = nod2)
</para>
</listitem>
</varlistentry>
<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>
<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/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>type=</constant><replaceable>value</replaceable></term>
<listitem>
<para>
Change the type 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>
<varlistentry>
<term><constant>ndots=</constant><replaceable>number</replaceable></term>
<listitem>
<para>
Set the number of dots (label separators) in a domain
that will disable searching. Absolute names always
stop searching.
</para>
</listitem>
</varlistentry>
<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>
</varlistentry>
<varlistentry>
<term><constant>
<replaceable><optional>no</optional></replaceable>fail</constant></term>
<listitem>
<para>
Try the next nameserver if a nameserver responds with
SERVFAIL or a referral (nofail) or terminate query
(fail) on such a response.
</para>
<para>
(Default = nofail)
</para>
</listitem>
</varlistentry>
</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>
<title>Author</title>
<para>
Andrew Cherenson
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->