contrib/bind/doc/man/host.1

   1 .\" ++Copyright++ 1993
   2 .\" -
   3 .\" Copyright (c) 1993
   4 .\"    The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\" -
  34 .\" Portions Copyright (c) 1993 by Digital Equipment Corporation.
  35 .\"
  36 .\" Permission to use, copy, modify, and distribute this software for any
  37 .\" purpose with or without fee is hereby granted, provided that the above
  38 .\" copyright notice and this permission notice appear in all copies, and that
  39 .\" the name of Digital Equipment Corporation not be used in advertising or
  40 .\" publicity pertaining to distribution of the document or software without
  41 .\" specific, written prior permission.
  42 .\"
  43 .\" THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
  44 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
  45 .\" OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
  46 .\" CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  47 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  48 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  49 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  50 .\" SOFTWARE.
  51 .\" -
  52 .\" --Copyright--
  53 .\" $Id: host.1,v 8.2 1997/03/14 02:29:44 vixie Exp $
  54 .Dd December 15, 1994
  55 .Dt HOST @CMD_EXT_U@
  56 .Os BSD 4
  57 .Sh NAME
  58 .Nm host
  59 .Nd look up host names using domain server
  60 .Sh SYNOPSIS
  61 .Nm host
  62 .Op Fl l
  63 .Op Fl v
  64 .Op Fl w
  65 .Op Fl r
  66 .Op Fl d
  67 .Op Fl t Ar querytype
  68 .Op Fl a
  69 .Ar host
  70 .Op Ar server
  71 .Sh DESCRIPTION
  72 .Ic Host
  73 looks for information about Internet hosts.  It gets this information
  74 from a set of interconnected servers that are spread across the
  75 country.  By default, it simply converts between host names and
  76 Internet addresses.  However, with the
  77 .Dq Fl t
  78 or
  79 .Dq Fl a
  80 options, it can be used
  81 to find all of the information about this host that is maintained
  82 by the domain server.
  83 .Pp
  84 The arguments can be either host names or host numbers.  The program
  85 first attempts to interpret them as host numbers.  If this fails,
  86 it will treat them as host names.  A host number consists of
  87 four decimal numbers separated by dots, e.g. 128.6.4.194
  88 A host name consists of names separated by dots, e.g. topaz.rutgers.edu.
  89 Unless the name ends in a dot, the local domain
  90 is automatically tacked on the end.  Thus, a Rutgers user can say
  91 .Pp
  92 .D1 Ic host topaz
  93 .Pp
  94 and it will actually look up "topaz.rutgers.edu".
  95 If this fails, the name is tried unchanged (in this case, "topaz").
  96 This same convention is used for mail and other network utilities.
  97 The actual suffix to tack on the end is obtained
  98 by looking at the results of a
  99 .Xr hostname @CMD_EXT@
 100 call, and using everything
 101 starting at the first dot.  (See below for a description of
 102 .Sx CUSTOMIZING HOST NAME LOOKUP . )
 103 .Pp
 104 The first argument is the host name you want to look up.
 105 If this is a number, an
 106 .Dq inverse query
 107 is done, i.e. the domain
 108 system looks in a separate set of databases used to convert numbers
 109 to names.
 110 .Pp
 111 The second argument is optional.  It
 112 allows you to specify a particular server to query.  If you don't
 113 specify this argument, the default server (normally the local machine)
 114 is used.
 115 .Pp
 116 If a name is specified, you may see output of three different kinds.
 117 Here is an example that shows all of them:
 118 .Pp
 119 .D1 Ic % host sun4
 120 .Dl sun4.rutgers.edu is a nickname for ATHOS.RUTGERS.EDU
 121 .Dl ATHOS.RUTGERS.EDU has address 128.6.5.46
 122 .Dl ATHOS.RUTGERS.EDU has address 128.6.4.4
 123 .Dl ATHOS.RUTGERS.EDU mail is handled by ARAMIS.RUTGERS.EDU
 124 .Pp
 125 The user has typed the command
 126 .Dq Ic host sun4 .
 127 The first line indicates that the name
 128 .Dq Li sun4.rutgers.edu
 129 is actually a nickname.  The official host name is
 130 .Dq Li ATHOS.RUTGERS.EDU .
 131 The next two lines show the
 132 address.  If a system has more than one network interface, there
 133 will be a separate address for each.  The last line indicates
 134 that
 135 .Li ATHOS.RUTGERS.EDU
 136 does not receive its own mail.  Mail for
 137 it is taken by
 138 .Li ARAMIS.RUTGERS.EDU .
 139 There may be more than one
 140 such line, since some systems have more than one other system
 141 that will handle mail for them.  Technically, every system that
 142 can receive mail is supposed to have an entry of this kind.  If
 143 the system receives its own mail, there should be an entry
 144 the mentions the system itself; for example,
 145 .Pp
 146 .D1 Li XXX mail is handled by XXX
 147 .Pp
 148 However, many systems that receive
 149 their own mail do not bother to mention that fact.  If a system
 150 has a
 151 .Dq Li mail is handled by
 152 entry, but no address, this indicates
 153 that it is not really part of the Internet, but a system that is
 154 on the network will forward mail to it.  Systems on Usenet, Bitnet,
 155 and a number of other networks have entries of this kind.
 156 .Sh OPTIONS
 157 There are a number of options that can be used before the
 158 host name.  Most of these options are meaningful only to the
 159 staff who have to maintain the domain database.
 160 .Bl -tag -width Fl
 161 .It Fl w
 162 This causes
 163 .Ic host
 164 to wait forever for a response.  Normally
 165 it will time out after approximate one minute.
 166 .It Fl v
 167 Use "verbose" format for printout.  This
 168 is the official domain master file format, which is documented
 169 in the man page for
 170 .Xr @INDOT@named @SYS_OPS_EXT@ .
 171 Without this option, output still follows
 172 this format in general terms, but some attempt is made to make it
 173 more intelligible to normal users.  Without
 174 .Dq Fl v ,
 175 any "a", "mx", and "cname" records
 176 are written out as "has address", "mail is handled by", and
 177 "is a nickname for" (respectively), and TTL and class fields are not shown.
 178 .It Fl r
 179 Turn off recursion in the request.
 180 This means that the name server will return only data it has in
 181 its own database.  It will not ask other servers for more
 182 information.
 183 .It Fl d
 184 Turn on debugging.  Network transactions are shown in detail.
 185 .It Fl t Ar querytype
 186 Allows you to specify a particular
 187 .Ar querytype
 188 of information
 189 to be looked up.  The arguments are defined in the man page for
 190 .Xr @INDOT@named @SYS_OPS_EXT@ .
 191 Currently-supported types include:
 192 .Dq Cm a ,
 193 .Dq Cm ns ,
 194 .Dq Cm md ,
 195 .Dq Cm mf ,
 196 .Dq Cm cname ,
 197 .Dq Cm soa ,
 198 .Dq Cm mb ,
 199 .Dq Cm mg ,
 200 .Dq Cm mr ,
 201 .Dq Cm null ,
 202 .Dq Cm wks ,
 203 .Dq Cm ptr ,
 204 .Dq Cm hinfo ,
 205 .Dq Cm minfo ,
 206 .Dq Cm mx ,
 207 .Dq Cm uinfo ,
 208 .Dq Cm uid ,
 209 .Dq Cm gid ,
 210 .Dq Cm unspec .
 211 Additionally, the wildcard, which may be written
 212 as either
 213 .Dq Cm any
 214 or
 215 .Dq Cm * ,
 216 can be used to specify any (all) of the above types.
 217 Types must be given in lower case.
 218 Note that the default is to look first for
 219 .Dq Cm a ,
 220 and then
 221 .Dq Cm mx ,
 222 except that if the verbose option is turned on, the default is only
 223 .Dq Cm a .
 224 The
 225 .Dq Fl t
 226 option is particularly useful for filtering information returned by
 227 .Ic host ;
 228 see the explanation of the
 229 .Dq Fl l
 230 option, below, for more information.
 231 .It Fl a
 232 .Dq all ;
 233 this is equivalent to
 234 .Dq Fl v Fl t Cm any .
 235 .It Fl l
 236 List a complete domain; e.g.:
 237 .Pp
 238 .D1 Ic host -l rutgers.edu
 239 .Pp
 240 will give a listing of all hosts in the rutgers.edu domain.  The
 241 .Dq Fl t
 242 option is used to filter what information is presented, as you
 243 would expect.  The default is address information, which also
 244 include PTR and NS records.  The command
 245 .Pp
 246 .D1 Ic host -l -v -t any rutgers.edu
 247 .Pp
 248 will give a complete download of the zone data for rutgers.edu,
 249 in the official master file format.  (However the SOA record is
 250 listed twice, for arcane reasons.)
 251 .Pp
 252 .Sy NOTE:
 253 .Dq Fl l
 254 is implemented by
 255 doing a complete zone transfer and then filtering out the information
 256 that you have asked for.  This command should be used only if it
 257 is absolutely necessary.
 258 .Sh CUSTOMIZING HOST NAME LOOKUP
 259 In general, if the name supplied by the user does not
 260 have any dots in it, a default domain is appended to the end.
 261 This domain can be defined in
 262 .Pa /etc/resolv.conf ,
 263 but is normally derived
 264 by taking the local hostname after its first dot.  The user can override
 265 this, and specify a different default domain, using the environment
 266 variable
 267 .Ev LOCALDOMAIN .
 268 In addition, the user can supply his own abbreviations for host names.
 269 They should be in a file consisting of one line per abbreviation.
 270 Each line contains an abbreviation, a space, and then the full
 271 host name.  The name file must be contained in the
 272 .Ev HOSTALIASES
 273 environment variable.
 274 .Sh ENVIRONMENT
 275 .Bl -tag -width "/etc/resolv.conf  " -compress
 276 .It Ev HOSTALIASES
 277 Name of file containing
 278 .Pq Ar host alias , full hostname
 279 pairs.
 280 .El
 281 .Sh FILES
 282 .Bl -tag -width "/etc/resolv.conf  " -compress
 283 .It Pa /etc/resolv.conf
 284 See
 285 .Xr resolver @FORMAT_EXT@ .
 286 .It Ev HOSTALIASES
 287 Name of file containing
 288 .Pq Ar host alias , full hostname
 289 pairs.
 290 .El
 291 .Sh SEE ALSO
 292 .Xr @INDOT@named  @SYS_OPS_EXT@ ,
 293 .Xr resolver @FORMAT_EXT@ .
 294 .Sh BUGS
 295 Unexpected effects can happen when you type a name that is not
 296 part of the local domain.  Please always keep in mind the
 297 fact that the local domain name is tacked onto the end of every
 298 name, unless it ends in a dot.  Only if this fails is the name
 299 used unchanged.
 300 .Pp
 301 The
 302 .Dq Fl l
 303 option only tries the first name server listed for the
 304 domain that you have requested.  If this server is dead, you
 305 may need to specify a server manually. E.g., to get a listing
 306 of foo.edu, you could try
 307 .Pp
 308 .D1 Ic host -t ns foo.edu
 309 .Pp
 310 to get a list of all the name servers for foo.edu, and then try
 311 .Pp
 312 .D1 Ic host -l foo.edu xxx
 313 .Pp
 314 for all
 315 .Dq Ic xxx
 316 on the list of name servers, until you find one that works.