lib/libc/net/getnetent.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)getnetent.3 8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/net/getnetent.3,v 1.23 2007/01/09 00:28:02 imp Exp $
  30 .\" $DragonFly: src/lib/libc/net/getnetent.3,v 1.2 2003/06/17 04:26:44 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt GETNETENT 3
  34 .Os
  35 .Sh NAME
  36 .Nm getnetent ,
  37 .Nm getnetbyaddr ,
  38 .Nm getnetbyname ,
  39 .Nm setnetent ,
  40 .Nm endnetent
  41 .Nd get network entry
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In netdb.h
  46 .Ft struct netent *
  47 .Fn getnetent void
  48 .Ft struct netent *
  49 .Fn getnetbyname "const char *name"
  50 .Ft struct netent *
  51 .Fn getnetbyaddr "uint32_t net" "int type"
  52 .Ft void
  53 .Fn setnetent "int stayopen"
  54 .Ft void
  55 .Fn endnetent void
  56 .Sh DESCRIPTION
  57 The
  58 .Fn getnetent ,
  59 .Fn getnetbyname ,
  60 and
  61 .Fn getnetbyaddr
  62 functions
  63 each return a pointer to an object with the
  64 following structure describing an internet network.
  65 This structure contains either the information obtained
  66 from the nameserver,
  67 .Xr named 8 ,
  68 broken-out fields of a line in the network data base
  69 .Pa /etc/networks ,
  70 or entries supplied by the
  71 .Xr yp 8
  72 system.
  73 The order of the lookups is controlled by the
  74 `networks' entry in
  75 .Xr nsswitch.conf 5 .
  76 .Pp
  77 .Bd -literal -offset indent
  78 struct  netent {
  79         char            *n_name;        /* official name of net */
  80         char            **n_aliases;    /* alias list */
  81         int             n_addrtype;     /* net number type */
  82         uint32_t        n_net;          /* net number */
  83 };
  84 .Ed
  85 .Pp
  86 The members of this structure are:
  87 .Bl -tag -width n_addrtype
  88 .It Fa n_name
  89 The official name of the network.
  90 .It Fa n_aliases
  91 A zero terminated list of alternate names for the network.
  92 .It Fa n_addrtype
  93 The type of the network number returned; currently only AF_INET.
  94 .It Fa n_net
  95 The network number.
  96 Network numbers are returned in machine byte
  97 order.
  98 .El
  99 .Pp
 100 The
 101 .Fn getnetent
 102 function
 103 reads the next line of the file, opening the file if necessary.
 104 .Pp
 105 The
 106 .Fn setnetent
 107 function
 108 opens and rewinds the file.
 109 If the
 110 .Fa stayopen
 111 flag is non-zero,
 112 the net data base will not be closed after each call to
 113 .Fn getnetbyname
 114 or
 115 .Fn getnetbyaddr .
 116 .Pp
 117 The
 118 .Fn endnetent
 119 function
 120 closes the file.
 121 .Pp
 122 The
 123 .Fn getnetbyname
 124 function
 125 and
 126 .Fn getnetbyaddr
 127 sequentially search from the beginning
 128 of the file until a matching
 129 net name or
 130 net address and type is found,
 131 or until
 132 .Dv EOF
 133 is encountered.
 134 The
 135 .Fa type
 136 argument
 137 must be
 138 .Dv AF_INET .
 139 Network numbers are supplied in host order.
 140 .Sh FILES
 141 .Bl -tag -width /etc/nsswitch.conf -compact
 142 .It Pa /etc/networks
 143 .It Pa /etc/nsswitch.conf
 144 .It Pa /etc/resolv.conf
 145 .El
 146 .Sh DIAGNOSTICS
 147 Null pointer
 148 (0) returned on
 149 .Dv EOF
 150 or error.
 151 .Sh SEE ALSO
 152 .Xr networks 5
 153 .Pp
 154 .%T RFC 1101
 155 .Sh HISTORY
 156 The
 157 .Fn getnetent ,
 158 .Fn getnetbyaddr ,
 159 .Fn getnetbyname ,
 160 .Fn setnetent ,
 161 and
 162 .Fn endnetent
 163 functions appeared in
 164 .Bx 4.2 .
 165 .Sh BUGS
 166 The data space used by
 167 these functions is thread-specific; if future use requires the data, it should be
 168 copied before any subsequent calls to these functions overwrite it.
 169 Only Internet network
 170 numbers are currently understood.
 171 Expecting network numbers to fit
 172 in no more than 32 bits is probably
 173 naive.