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