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 .\" 3. 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 .Bd -literal -offset indent
  77 struct  netent {
  78         char            *n_name;        /* official name of net */
  79         char            **n_aliases;    /* alias list */
  80         int             n_addrtype;     /* net number type */
  81         uint32_t        n_net;          /* net number */
  82 };
  83 .Ed
  84 .Pp
  85 The members of this structure are:
  86 .Bl -tag -width n_addrtype
  87 .It Fa n_name
  88 The official name of the network.
  89 .It Fa n_aliases
  90 A zero terminated list of alternate names for the network.
  91 .It Fa n_addrtype
  92 The type of the network number returned; currently only AF_INET.
  93 .It Fa n_net
  94 The network number.
  95 Network numbers are returned in machine byte
  96 order.
  97 .El
  98 .Pp
  99 The
 100 .Fn getnetent
 101 function
 102 reads the next line of the file, opening the file if necessary.
 103 .Pp
 104 The
 105 .Fn setnetent
 106 function
 107 opens and rewinds the file.
 108 If the
 109 .Fa stayopen
 110 flag is non-zero,
 111 the net data base will not be closed after each call to
 112 .Fn getnetbyname
 113 or
 114 .Fn getnetbyaddr .
 115 .Pp
 116 The
 117 .Fn endnetent
 118 function
 119 closes the file.
 120 .Pp
 121 The
 122 .Fn getnetbyname
 123 function
 124 and
 125 .Fn getnetbyaddr
 126 sequentially search from the beginning
 127 of the file until a matching
 128 net name or
 129 net address and type is found,
 130 or until
 131 .Dv EOF
 132 is encountered.
 133 The
 134 .Fa type
 135 argument
 136 must be
 137 .Dv AF_INET .
 138 Network numbers are supplied in host order.
 139 .Sh FILES
 140 .Bl -tag -width /etc/nsswitch.conf -compact
 141 .It Pa /etc/networks
 142 .It Pa /etc/nsswitch.conf
 143 .It Pa /etc/resolv.conf
 144 .El
 145 .Sh DIAGNOSTICS
 146 Null pointer
 147 (0) returned on
 148 .Dv EOF
 149 or error.
 150 .Sh SEE ALSO
 151 .Xr networks 5
 152 .Pp
 153 .%T RFC 1101
 154 .Sh HISTORY
 155 The
 156 .Fn getnetent ,
 157 .Fn getnetbyaddr ,
 158 .Fn getnetbyname ,
 159 .Fn setnetent ,
 160 and
 161 .Fn endnetent
 162 functions appeared in
 163 .Bx 4.2 .
 164 .Sh BUGS
 165 The data space used by
 166 these functions is thread-specific; if future use requires the data, it should be
 167 copied before any subsequent calls to these functions overwrite it.
 168 Only Internet network
 169 numbers are currently understood.
 170 Expecting network numbers to fit
 171 in no more than 32 bits is probably
 172 naive.