share/man/man5/hosts.5

   1 .\"     $OpenBSD: hosts.5,v 1.19 2011/10/16 15:07:28 lum Exp $
   2 .\"     $NetBSD: hosts.5,v 1.4 1994/11/30 19:31:20 jtc Exp $
   3 .\"
   4 .\" Copyright (c) 1983, 1991, 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)hosts.5     8.2 (Berkeley) 12/11/93
  32 .\"
  33 .Dd $Mdocdate: October 16 2011 $
  34 .Dt HOSTS 5
  35 .Os
  36 .Sh NAME
  37 .Nm hosts
  38 .Nd host name database
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 file contains information regarding the known hosts on the network.
  43 For each host, a single line should be present with the following information:
  44 .Bd -unfilled -offset indent
  45 Internet address
  46 Official host name
  47 Aliases
  48 .Ed
  49 .Pp
  50 Items are separated by any number of blanks and/or tab characters.
  51 A
  52 .Ql #
  53 indicates the beginning of a comment; characters up to the end of the line
  54 are not interpreted by routines which search the file.
  55 .Pp
  56 The system configuration file
  57 .Xr resolv.conf 5
  58 controls where host name information will be searched for.
  59 The mechanism provided permits the administrator to describe the
  60 databases to search; the databases currently known include
  61 .Xr yp 8 ,
  62 DNS
  63 and the
  64 .Nm hosts
  65 database.
  66 .Pp
  67 When using the name server
  68 .Xr named 8 ,
  69 this file provides a backup when the name server is not running.
  70 For the name server, it is suggested that only a few addresses
  71 be included in this file.
  72 These include addresses for the local interfaces that
  73 .Xr ifconfig 8
  74 needs at boot time and a few machines on the local network.
  75 .Pp
  76 Internet addresses are specified using either
  77 dot notation (IPv4)
  78 or colon separated notation (IPv6).
  79 Further information on network addressing is contained in
  80 .Xr inet 3 .
  81 Host names may contain any printable character other than a field delimiter,
  82 newline, or comment character.
  83 .Sh FILES
  84 .Bl -tag -width /etc/hosts -compact
  85 .It Pa /etc/hosts
  86 .El
  87 .Sh SEE ALSO
  88 .Xr getaddrinfo 3 ,
  89 .Xr gethostbyname 3 ,
  90 .Xr getnameinfo 3 ,
  91 .Xr inet 3 ,
  92 .Xr resolv.conf 5 ,
  93 .Xr ifconfig 8 ,
  94 .Xr named 8
  95 .Rs
  96 .%T "Name Server Operations Guide for BIND"
  97 .Re
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 file format appeared in
 102 .Bx 4.2 .
 103 .Pp
 104 An official host database used to be maintained at
 105 the Network Information Control Center
 106 .Pq Tn NIC .
 107 .Sh BUGS
 108 A name server should be used instead of a static file.
 109 .Pp
 110 Lines in
 111 .Pa /etc/hosts
 112 are limited to
 113 .Dv BUFSIZ
 114 characters
 115 .Pq currently 1024 .
 116 Longer lines will be ignored.