xref: /minix/external/bsd/bind/dist/bin/dig/nslookup.html (revision 00b67f09)
1<!--
2 - Copyright (C) 2004-2007, 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
3 -
4 - Permission to use, copy, modify, and/or distribute this software for any
5 - purpose with or without fee is hereby granted, provided that the above
6 - copyright notice and this permission notice appear in all copies.
7 -
8 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 - PERFORMANCE OF THIS SOFTWARE.
15-->
16<!-- Id -->
17<html>
18<head>
19<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
20<title>nslookup</title>
21<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
22</head>
23<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
24<a name="id2476283"></a><div class="titlepage"></div>
25<div class="refnamediv">
26<h2>Name</h2>
27<p>nslookup &#8212; query Internet name servers interactively</p>
28</div>
29<div class="refsynopsisdiv">
30<h2>Synopsis</h2>
31<div class="cmdsynopsis"><p><code class="command">nslookup</code>  [<code class="option">-option</code>] [name | -] [server]</p></div>
32</div>
33<div class="refsect1" lang="en">
34<a name="id2543442"></a><h2>DESCRIPTION</h2>
35<p><span><strong class="command">Nslookup</strong></span>
36      is a program to query Internet domain name servers.  <span><strong class="command">Nslookup</strong></span>
37      has two modes: interactive and non-interactive.  Interactive mode allows
38      the user to query name servers for information about various hosts and
39      domains or to print a list of hosts in a domain.  Non-interactive mode
40      is
41      used to print just the name and requested information for a host or
42      domain.
43    </p>
44</div>
45<div class="refsect1" lang="en">
46<a name="id2543458"></a><h2>ARGUMENTS</h2>
47<p>
48      Interactive mode is entered in the following cases:
49      </p>
50<div class="orderedlist"><ol type="a">
51<li><p>
52            when no arguments are given (the default name server will be used)
53          </p></li>
54<li><p>
55            when the first argument is a hyphen (-) and the second argument is
56            the host name or Internet address of a name server.
57          </p></li>
58</ol></div>
59<p>
60    </p>
61<p>
62      Non-interactive mode is used when the name or Internet address of the
63      host to be looked up is given as the first argument. The optional second
64      argument specifies the host name or address of a name server.
65    </p>
66<p>
67      Options can also be specified on the command line if they precede the
68      arguments and are prefixed with a hyphen.  For example, to
69      change the default query type to host information, and the initial
70      timeout to 10 seconds, type:
71
72        </p>
73<pre class="programlisting">
74nslookup -query=hinfo  -timeout=10
75</pre>
76<p>
77
78    </p>
79<p>
80      The <code class="option">-version</code> option causes
81      <span><strong class="command">nslookup</strong></span> to print the version
82      number and immediately exits.
83    </p>
84</div>
85<div class="refsect1" lang="en">
86<a name="id2543512"></a><h2>INTERACTIVE COMMANDS</h2>
87<div class="variablelist"><dl>
88<dt><span class="term"><code class="constant">host</code> [<span class="optional">server</span>]</span></dt>
89<dd>
90<p>
91            Look up information for host using the current default server or
92            using server, if specified.  If host is an Internet address and
93            the query type is A or PTR, the name of the host is returned.
94            If host is a name and does not have a trailing period, the
95            search list is used to qualify the name.
96          </p>
97<p>
98            To look up a host not in the current domain, append a period to
99            the name.
100          </p>
101</dd>
102<dt><span class="term"><code class="constant">server</code> <em class="replaceable"><code>domain</code></em></span></dt>
103<dd><p></p></dd>
104<dt><span class="term"><code class="constant">lserver</code> <em class="replaceable"><code>domain</code></em></span></dt>
105<dd><p>
106            Change the default server to <em class="replaceable"><code>domain</code></em>; <code class="constant">lserver</code> uses the initial
107            server to look up information about <em class="replaceable"><code>domain</code></em>, while <code class="constant">server</code> uses
108            the current default server.  If an authoritative answer can't be
109            found, the names of servers that might have the answer are
110            returned.
111          </p></dd>
112<dt><span class="term"><code class="constant">root</code></span></dt>
113<dd><p>
114            not implemented
115          </p></dd>
116<dt><span class="term"><code class="constant">finger</code></span></dt>
117<dd><p>
118            not implemented
119          </p></dd>
120<dt><span class="term"><code class="constant">ls</code></span></dt>
121<dd><p>
122            not implemented
123          </p></dd>
124<dt><span class="term"><code class="constant">view</code></span></dt>
125<dd><p>
126            not implemented
127          </p></dd>
128<dt><span class="term"><code class="constant">help</code></span></dt>
129<dd><p>
130            not implemented
131          </p></dd>
132<dt><span class="term"><code class="constant">?</code></span></dt>
133<dd><p>
134            not implemented
135          </p></dd>
136<dt><span class="term"><code class="constant">exit</code></span></dt>
137<dd><p>
138            Exits the program.
139          </p></dd>
140<dt><span class="term"><code class="constant">set</code>
141          <em class="replaceable"><code>keyword[<span class="optional">=value</span>]</code></em></span></dt>
142<dd>
143<p>
144            This command is used to change state information that affects
145            the lookups.  Valid keywords are:
146            </p>
147<div class="variablelist"><dl>
148<dt><span class="term"><code class="constant">all</code></span></dt>
149<dd><p>
150                    Prints the current values of the frequently used
151                    options to <span><strong class="command">set</strong></span>.
152                    Information about the  current default
153                    server and host is also printed.
154                  </p></dd>
155<dt><span class="term"><code class="constant">class=</code><em class="replaceable"><code>value</code></em></span></dt>
156<dd>
157<p>
158                    Change the query class to one of:
159                    </p>
160<div class="variablelist"><dl>
161<dt><span class="term"><code class="constant">IN</code></span></dt>
162<dd><p>
163                            the Internet class
164                          </p></dd>
165<dt><span class="term"><code class="constant">CH</code></span></dt>
166<dd><p>
167                            the Chaos class
168                          </p></dd>
169<dt><span class="term"><code class="constant">HS</code></span></dt>
170<dd><p>
171                            the Hesiod class
172                          </p></dd>
173<dt><span class="term"><code class="constant">ANY</code></span></dt>
174<dd><p>
175                            wildcard
176                          </p></dd>
177</dl></div>
178<p>
179                    The class specifies the protocol group of the information.
180
181                  </p>
182<p>
183                    (Default = IN; abbreviation = cl)
184                  </p>
185</dd>
186<dt><span class="term"><code class="constant">
187                    <em class="replaceable"><code>[<span class="optional">no</span>]</code></em>debug</code></span></dt>
188<dd>
189<p>
190		    Turn on or off the display of the full response packet and
191		    any intermediate response packets when searching.
192                  </p>
193<p>
194                    (Default = nodebug; abbreviation = [<span class="optional">no</span>]deb)
195                  </p>
196</dd>
197<dt><span class="term"><code class="constant">
198                    <em class="replaceable"><code>[<span class="optional">no</span>]</code></em>d2</code></span></dt>
199<dd>
200<p>
201                    Turn debugging mode on or off.  This displays more about
202	            what nslookup is doing.
203                  </p>
204<p>
205                    (Default = nod2)
206                  </p>
207</dd>
208<dt><span class="term"><code class="constant">domain=</code><em class="replaceable"><code>name</code></em></span></dt>
209<dd><p>
210                    Sets the search list to <em class="replaceable"><code>name</code></em>.
211                  </p></dd>
212<dt><span class="term"><code class="constant">
213                    <em class="replaceable"><code>[<span class="optional">no</span>]</code></em>search</code></span></dt>
214<dd>
215<p>
216                    If the lookup request contains at least one period but
217                    doesn't end with a trailing period, append the domain
218                    names in the domain search list to the request until an
219                    answer is received.
220                  </p>
221<p>
222                    (Default = search)
223                  </p>
224</dd>
225<dt><span class="term"><code class="constant">port=</code><em class="replaceable"><code>value</code></em></span></dt>
226<dd>
227<p>
228                    Change the default TCP/UDP name server port to <em class="replaceable"><code>value</code></em>.
229                  </p>
230<p>
231                    (Default = 53; abbreviation = po)
232                  </p>
233</dd>
234<dt><span class="term"><code class="constant">querytype=</code><em class="replaceable"><code>value</code></em></span></dt>
235<dd><p></p></dd>
236<dt><span class="term"><code class="constant">type=</code><em class="replaceable"><code>value</code></em></span></dt>
237<dd>
238<p>
239                    Change the type of the information query.
240                  </p>
241<p>
242                    (Default = A; abbreviations = q, ty)
243                  </p>
244</dd>
245<dt><span class="term"><code class="constant">
246                    <em class="replaceable"><code>[<span class="optional">no</span>]</code></em>recurse</code></span></dt>
247<dd>
248<p>
249                    Tell the name server to query other servers if it does not
250                    have the
251                    information.
252                  </p>
253<p>
254                    (Default = recurse; abbreviation = [no]rec)
255                  </p>
256</dd>
257<dt><span class="term"><code class="constant">ndots=</code><em class="replaceable"><code>number</code></em></span></dt>
258<dd><p>
259		    Set the number of dots (label separators) in a domain
260		    that will disable searching.  Absolute names always
261		    stop searching.
262                  </p></dd>
263<dt><span class="term"><code class="constant">retry=</code><em class="replaceable"><code>number</code></em></span></dt>
264<dd><p>
265                    Set the number of retries to number.
266                  </p></dd>
267<dt><span class="term"><code class="constant">timeout=</code><em class="replaceable"><code>number</code></em></span></dt>
268<dd><p>
269                    Change the initial timeout interval for waiting for a
270                    reply to number seconds.
271                  </p></dd>
272<dt><span class="term"><code class="constant">
273                    <em class="replaceable"><code>[<span class="optional">no</span>]</code></em>vc</code></span></dt>
274<dd>
275<p>
276                    Always use a virtual circuit when sending requests to the
277                    server.
278                  </p>
279<p>
280                    (Default = novc)
281                  </p>
282</dd>
283<dt><span class="term"><code class="constant">
284                    <em class="replaceable"><code>[<span class="optional">no</span>]</code></em>fail</code></span></dt>
285<dd>
286<p>
287		    Try the next nameserver if a nameserver responds with
288		    SERVFAIL or a referral (nofail) or terminate query
289		    (fail) on such a response.
290		  </p>
291<p>
292                    (Default = nofail)
293                  </p>
294</dd>
295</dl></div>
296<p>
297          </p>
298</dd>
299</dl></div>
300</div>
301<div class="refsect1" lang="en">
302<a name="id2546326"></a><h2>FILES</h2>
303<p><code class="filename">/etc/resolv.conf</code>
304    </p>
305</div>
306<div class="refsect1" lang="en">
307<a name="id2546338"></a><h2>SEE ALSO</h2>
308<p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>,
309      <span class="citerefentry"><span class="refentrytitle">host</span>(1)</span>,
310      <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>.
311    </p>
312</div>
313<div class="refsect1" lang="en">
314<a name="id2546372"></a><h2>Author</h2>
315<p>
316      Andrew Cherenson
317    </p>
318</div>
319</div></body>
320</html>
321