contrib/bind9/bin/dig/nslookup.html

   1 <!--
   2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  -
   4  - Permission to use, copy, modify, and 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
  17 <!-- $Id: nslookup.html,v 1.1.6.3 2004/08/22 23:38:58 marka Exp $ -->
  18
  19 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  20 <HTML
  21 ><HEAD
  22 ><TITLE
  23 >nslookup</TITLE
  24 ><META
  25 NAME="GENERATOR"
  26 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
  27 ><BODY
  28 CLASS="REFENTRY"
  29 BGCOLOR="#FFFFFF"
  30 TEXT="#000000"
  31 LINK="#0000FF"
  32 VLINK="#840084"
  33 ALINK="#0000FF"
  34 ><H1
  35 ><A
  36 NAME="AEN1"
  37 ></A
  38 >nslookup</H1
  39 ><DIV
  40 CLASS="REFNAMEDIV"
  41 ><A
  42 NAME="AEN8"
  43 ></A
  44 ><H2
  45 >Name</H2
  46 >nslookup&nbsp;--&nbsp;query Internet name servers interactively</DIV
  47 ><DIV
  48 CLASS="REFSYNOPSISDIV"
  49 ><A
  50 NAME="AEN11"
  51 ></A
  52 ><H2
  53 >Synopsis</H2
  54 ><P
  55 ><B
  56 CLASS="COMMAND"
  57 >nslookup</B
  58 >  [<VAR
  59 CLASS="OPTION"
  60 >-option</VAR
  61 >] [name | -] [server]</P
  62 ></DIV
  63 ><DIV
  64 CLASS="REFSECT1"
  65 ><A
  66 NAME="AEN18"
  67 ></A
  68 ><H2
  69 >DESCRIPTION</H2
  70 ><P
  71 ><B
  72 CLASS="COMMAND"
  73 >Nslookup</B
  74 >
  75 is a program to query Internet domain name servers.  <B
  76 CLASS="COMMAND"
  77 >Nslookup</B
  78 >
  79 has two modes: interactive and non-interactive.  Interactive mode allows
  80 the user to query name servers for information about various hosts and
  81 domains or to print a list of hosts in a domain.  Non-interactive mode is
  82 used to print just the name and requested information for a host or
  83 domain.</P
  84 ></DIV
  85 ><DIV
  86 CLASS="REFSECT1"
  87 ><A
  88 NAME="AEN23"
  89 ></A
  90 ><H2
  91 >ARGUMENTS</H2
  92 ><P
  93 >Interactive mode is entered in the following cases:
  94 <P
  95 ></P
  96 ><OL
  97 TYPE="a"
  98 ><LI
  99 ><P
 100 >when no arguments are given (the default name server will be used)</P
 101 ></LI
 102 ><LI
 103 ><P
 104 >when the first argument is a hyphen (-) and the second argument is
 105 the host name or Internet address of a name server.</P
 106 ></LI
 107 ></OL
 108 ></P
 109 ><P
 110 >Non-interactive mode is used when the name or Internet address of the
 111 host to be looked up is given as the first argument. The optional second
 112 argument specifies the host name or address of a name server.</P
 113 ><P
 114 >Options can also be specified on the command line if they precede the
 115 arguments and are prefixed with a hyphen.  For example, to
 116 change the default query type to host information, and the initial timeout to 10 seconds, type:
 117 <DIV
 118 CLASS="INFORMALEXAMPLE"
 119 ><P
 120 ></P
 121 ><A
 122 NAME="AEN33"
 123 ></A
 124 ><PRE
 125 CLASS="PROGRAMLISTING"
 126 >nslookup -query=hinfo  -timeout=10</PRE
 127 ><P
 128 ></P
 129 ></DIV
 130 ></P
 131 ></DIV
 132 ><DIV
 133 CLASS="REFSECT1"
 134 ><A
 135 NAME="AEN35"
 136 ></A
 137 ><H2
 138 >INTERACTIVE COMMANDS</H2
 139 ><P
 140 ></P
 141 ><DIV
 142 CLASS="VARIABLELIST"
 143 ><DL
 144 ><DT
 145 >host [<SPAN
 146 CLASS="OPTIONAL"
 147 >server</SPAN
 148 >]</DT
 149 ><DD
 150 ><P
 151 >Look up information for host using the current default server or
 152 using server, if specified.  If host is an Internet address and
 153 the query type is A or PTR, the name of the host is returned.
 154 If host is a name and does not have a trailing period, the
 155 search list is used to qualify the name.</P
 156 ><P
 157 >To look up a host not in the current domain, append a period to
 158 the name.</P
 159 ></DD
 160 ><DT
 161 ><CODE
 162 CLASS="CONSTANT"
 163 >server</CODE
 164 > <VAR
 165 CLASS="REPLACEABLE"
 166 >domain</VAR
 167 ></DT
 168 ><DD
 169 ><P
 170 ></P
 171 ></DD
 172 ><DT
 173 ><CODE
 174 CLASS="CONSTANT"
 175 >lserver</CODE
 176 > <VAR
 177 CLASS="REPLACEABLE"
 178 >domain</VAR
 179 ></DT
 180 ><DD
 181 ><P
 182 >Change the default server to <VAR
 183 CLASS="REPLACEABLE"
 184 >domain</VAR
 185 >; <CODE
 186 CLASS="CONSTANT"
 187 >lserver</CODE
 188 > uses the initial
 189 server to look up information about <VAR
 190 CLASS="REPLACEABLE"
 191 >domain</VAR
 192 >, while <CODE
 193 CLASS="CONSTANT"
 194 >server</CODE
 195 > uses
 196 the current default server.  If an authoritative answer can't be
 197 found, the names of servers that might have the answer are
 198 returned.</P
 199 ></DD
 200 ><DT
 201 ><CODE
 202 CLASS="CONSTANT"
 203 >root</CODE
 204 ></DT
 205 ><DD
 206 ><P
 207 >not implemented</P
 208 ></DD
 209 ><DT
 210 ><CODE
 211 CLASS="CONSTANT"
 212 >finger</CODE
 213 ></DT
 214 ><DD
 215 ><P
 216 >not implemented</P
 217 ></DD
 218 ><DT
 219 ><CODE
 220 CLASS="CONSTANT"
 221 >ls</CODE
 222 ></DT
 223 ><DD
 224 ><P
 225 >not implemented</P
 226 ></DD
 227 ><DT
 228 ><CODE
 229 CLASS="CONSTANT"
 230 >view</CODE
 231 ></DT
 232 ><DD
 233 ><P
 234 >not implemented</P
 235 ></DD
 236 ><DT
 237 ><CODE
 238 CLASS="CONSTANT"
 239 >help</CODE
 240 ></DT
 241 ><DD
 242 ><P
 243 >not implemented</P
 244 ></DD
 245 ><DT
 246 ><CODE
 247 CLASS="CONSTANT"
 248 >?</CODE
 249 ></DT
 250 ><DD
 251 ><P
 252 >not implemented</P
 253 ></DD
 254 ><DT
 255 ><CODE
 256 CLASS="CONSTANT"
 257 >exit</CODE
 258 ></DT
 259 ><DD
 260 ><P
 261 >Exits the program.</P
 262 ></DD
 263 ><DT
 264 ><CODE
 265 CLASS="CONSTANT"
 266 >set</CODE
 267 > <VAR
 268 CLASS="REPLACEABLE"
 269 >keyword[<SPAN
 270 CLASS="OPTIONAL"
 271 >=value</SPAN
 272 >]</VAR
 273 ></DT
 274 ><DD
 275 ><P
 276 >This command is used to change state information that affects
 277 the lookups.  Valid keywords are:
 278  <P
 279 ></P
 280 ><DIV
 281 CLASS="VARIABLELIST"
 282 ><DL
 283 ><DT
 284 ><CODE
 285 CLASS="CONSTANT"
 286 >all</CODE
 287 ></DT
 288 ><DD
 289 ><P
 290 >Prints the current values of the frequently used
 291   options to <B
 292 CLASS="COMMAND"
 293 >set</B
 294 >.  Information about the  current default
 295   server and host is also printed.
 296   </P
 297 ></DD
 298 ><DT
 299 ><CODE
 300 CLASS="CONSTANT"
 301 >class=</CODE
 302 ><VAR
 303 CLASS="REPLACEABLE"
 304 >value</VAR
 305 ></DT
 306 ><DD
 307 ><P
 308 >   Change the query class to one of:
 309    <P
 310 ></P
 311 ><DIV
 312 CLASS="VARIABLELIST"
 313 ><DL
 314 ><DT
 315 ><CODE
 316 CLASS="CONSTANT"
 317 >IN</CODE
 318 ></DT
 319 ><DD
 320 ><P
 321 >the Internet class</P
 322 ></DD
 323 ><DT
 324 ><CODE
 325 CLASS="CONSTANT"
 326 >CH</CODE
 327 ></DT
 328 ><DD
 329 ><P
 330 >the Chaos class</P
 331 ></DD
 332 ><DT
 333 ><CODE
 334 CLASS="CONSTANT"
 335 >HS</CODE
 336 ></DT
 337 ><DD
 338 ><P
 339 >the Hesiod class</P
 340 ></DD
 341 ><DT
 342 ><CODE
 343 CLASS="CONSTANT"
 344 >ANY</CODE
 345 ></DT
 346 ><DD
 347 ><P
 348 >wildcard</P
 349 ></DD
 350 ></DL
 351 ></DIV
 352 >
 353    The class specifies the protocol group of the information.
 354    </P
 355 ><P
 356 >   (Default = IN; abbreviation = cl)
 357    </P
 358 ></DD
 359 ><DT
 360 ><CODE
 361 CLASS="CONSTANT"
 362 ><VAR
 363 CLASS="REPLACEABLE"
 364 >[<SPAN
 365 CLASS="OPTIONAL"
 366 >no</SPAN
 367 >]</VAR
 368 >debug</CODE
 369 ></DT
 370 ><DD
 371 ><P
 372 >  Turn debugging mode on.  A lot more information is
 373   printed about the packet sent to the server and the
 374   resulting answer.
 375   </P
 376 ><P
 377 >  (Default = nodebug; abbreviation = [<SPAN
 378 CLASS="OPTIONAL"
 379 >no</SPAN
 380 >]deb)
 381   </P
 382 ></DD
 383 ><DT
 384 ><CODE
 385 CLASS="CONSTANT"
 386 ><VAR
 387 CLASS="REPLACEABLE"
 388 >[<SPAN
 389 CLASS="OPTIONAL"
 390 >no</SPAN
 391 >]</VAR
 392 >d2</CODE
 393 ></DT
 394 ><DD
 395 ><P
 396 >  Turn debugging mode on.  A lot more information is
 397   printed about the packet sent to the server and the
 398   resulting answer.
 399   </P
 400 ><P
 401 >  (Default = nod2)
 402   </P
 403 ></DD
 404 ><DT
 405 ><CODE
 406 CLASS="CONSTANT"
 407 >domain=</CODE
 408 ><VAR
 409 CLASS="REPLACEABLE"
 410 >name</VAR
 411 ></DT
 412 ><DD
 413 ><P
 414 >  Sets the search list to <VAR
 415 CLASS="REPLACEABLE"
 416 >name</VAR
 417 >.
 418   </P
 419 ></DD
 420 ><DT
 421 ><CODE
 422 CLASS="CONSTANT"
 423 ><VAR
 424 CLASS="REPLACEABLE"
 425 >[<SPAN
 426 CLASS="OPTIONAL"
 427 >no</SPAN
 428 >]</VAR
 429 >search</CODE
 430 ></DT
 431 ><DD
 432 ><P
 433 >  If the lookup request contains at least one period but
 434   doesn't end with a trailing period, append the domain
 435   names in the domain search list to the request until an
 436   answer is received.
 437   </P
 438 ><P
 439 >  (Default = search)
 440   </P
 441 ></DD
 442 ><DT
 443 ><CODE
 444 CLASS="CONSTANT"
 445 >port=</CODE
 446 ><VAR
 447 CLASS="REPLACEABLE"
 448 >value</VAR
 449 ></DT
 450 ><DD
 451 ><P
 452 >  Change the default TCP/UDP name server port to <VAR
 453 CLASS="REPLACEABLE"
 454 >value</VAR
 455 >.
 456   </P
 457 ><P
 458 >  (Default = 53; abbreviation = po)
 459   </P
 460 ></DD
 461 ><DT
 462 ><CODE
 463 CLASS="CONSTANT"
 464 >querytype=</CODE
 465 ><VAR
 466 CLASS="REPLACEABLE"
 467 >value</VAR
 468 ></DT
 469 ><DD
 470 ><P
 471 ></P
 472 ></DD
 473 ><DT
 474 ><CODE
 475 CLASS="CONSTANT"
 476 >type=</CODE
 477 ><VAR
 478 CLASS="REPLACEABLE"
 479 >value</VAR
 480 ></DT
 481 ><DD
 482 ><P
 483 >  Change the top of the information query.
 484   </P
 485 ><P
 486 >  (Default = A; abbreviations = q, ty)
 487   </P
 488 ></DD
 489 ><DT
 490 ><CODE
 491 CLASS="CONSTANT"
 492 ><VAR
 493 CLASS="REPLACEABLE"
 494 >[<SPAN
 495 CLASS="OPTIONAL"
 496 >no</SPAN
 497 >]</VAR
 498 >recurse</CODE
 499 ></DT
 500 ><DD
 501 ><P
 502 >  Tell the name server to query other servers if it does not have the
 503   information.
 504   </P
 505 ><P
 506 >  (Default = recurse; abbreviation = [no]rec)
 507   </P
 508 ></DD
 509 ><DT
 510 ><CODE
 511 CLASS="CONSTANT"
 512 >retry=</CODE
 513 ><VAR
 514 CLASS="REPLACEABLE"
 515 >number</VAR
 516 ></DT
 517 ><DD
 518 ><P
 519 >  Set the number of retries to number.
 520   </P
 521 ></DD
 522 ><DT
 523 ><CODE
 524 CLASS="CONSTANT"
 525 >timeout=</CODE
 526 ><VAR
 527 CLASS="REPLACEABLE"
 528 >number</VAR
 529 ></DT
 530 ><DD
 531 ><P
 532 >  Change the initial timeout interval for waiting for a
 533   reply to number seconds.
 534   </P
 535 ></DD
 536 ><DT
 537 ><CODE
 538 CLASS="CONSTANT"
 539 ><VAR
 540 CLASS="REPLACEABLE"
 541 >[<SPAN
 542 CLASS="OPTIONAL"
 543 >no</SPAN
 544 >]</VAR
 545 >vc</CODE
 546 ></DT
 547 ><DD
 548 ><P
 549 >  Always use a virtual circuit when sending requests to the server.
 550   </P
 551 ><P
 552 >  (Default = novc)
 553   </P
 554 ></DD
 555 ></DL
 556 ></DIV
 557 ></P
 558 ></DD
 559 ></DL
 560 ></DIV
 561 ></DIV
 562 ><DIV
 563 CLASS="REFSECT1"
 564 ><A
 565 NAME="AEN218"
 566 ></A
 567 ><H2
 568 >FILES</H2
 569 ><P
 570 ><TT
 571 CLASS="FILENAME"
 572 >/etc/resolv.conf</TT
 573 ></P
 574 ></DIV
 575 ><DIV
 576 CLASS="REFSECT1"
 577 ><A
 578 NAME="AEN222"
 579 ></A
 580 ><H2
 581 >SEE ALSO</H2
 582 ><P
 583 ><SPAN
 584 CLASS="CITEREFENTRY"
 585 ><SPAN
 586 CLASS="REFENTRYTITLE"
 587 >dig</SPAN
 588 >(1)</SPAN
 589 >,
 590 <SPAN
 591 CLASS="CITEREFENTRY"
 592 ><SPAN
 593 CLASS="REFENTRYTITLE"
 594 >host</SPAN
 595 >(1)</SPAN
 596 >,
 597 <SPAN
 598 CLASS="CITEREFENTRY"
 599 ><SPAN
 600 CLASS="REFENTRYTITLE"
 601 >named</SPAN
 602 >(8)</SPAN
 603 >.</P
 604 ></DIV
 605 ><DIV
 606 CLASS="REFSECT1"
 607 ><A
 608 NAME="AEN234"
 609 ></A
 610 ><H2
 611 >Author</H2
 612 ><P
 613 >Andrew Cherenson</P
 614 ></DIV
 615 ></BODY
 616 ></HTML
 617 >