share/man/man5/netconfig.5

   1 .\"     $NetBSD: netconfig.5,v 1.6 2002/01/21 17:44:45 wiz Exp $
   2 .Dd November 17, 2000
   3 .Dt NETCONFIG 5
   4 .Os
   5 .Sh NAME
   6 .Nm netconfig
   7 .Nd network configuration data base
   8 .Sh SYNOPSIS
   9 .Fa /etc/netconfig
  10 .Sh DESCRIPTION
  11 The
  12 .Nm
  13 file defines a list of
  14 .Dq transport names ,
  15 describing their semantics and protocol. In
  16 .Nx ,
  17 this file is only used by the RPC library code.
  18 .Pp
  19 Entries have the following format:
  20 .Dl network_id semantics flags family protoname device libraries
  21 .Pp
  22 Entries consist of the following fields:
  23 .Pp
  24 .Bl -tag -width network_id
  25 .It Em network_id
  26 The name of the transport described.
  27 .It Em semantics
  28 Describes the semantics of the transport. This can be one of:
  29 .Bl -tag -width tpi_cots_ord -offset indent
  30 .It Sy tpi_clts
  31 Connectionless transport.
  32 .It Sy tpi_cots
  33 Connection-oriented transport
  34 .It Sy tpi_cots_ord
  35 Connection-oriented, ordered transport.
  36 .It Sy tpi_raw
  37 A raw connection.
  38 .El
  39 .It Em flags
  40 This field is  either blank (specified by
  41 .Dq \&- ) ,
  42 or contains a
  43 .Dq v ,
  44 meaning visible to the
  45 .Xr getnetconfig 3
  46 function.
  47 .It Em family
  48 The protocol family of the transport. This is currently one of:
  49 .Bl -tag -width loopback -offset indent
  50 .It Sy inet6
  51 The IPv6
  52 .Pq Dv PF_INET6
  53 family of protocols.
  54 .It Sy inet
  55 The IPv4
  56 .Pq Dv PF_INET
  57 family of protocols.
  58 .It Sy loopback
  59 The
  60 .Dv PF_LOCAL
  61 protocol family.
  62 .El
  63 .It Em protoname
  64 The name of the protocol used for this transport. Can currently be either
  65 .Nm udp ,
  66 .Nm tcp
  67 or empty.
  68 .It Em device
  69 This field is always empty in
  70 .Nx .
  71 .It Em libraries
  72 This field is always empty in
  73 .Nx .
  74 .El
  75 .Pp
  76 The order of entries in this file will determine which transport will
  77 be preferred by the RPC library code, given a match on a specified
  78 network type. For example, if a sample network config file would
  79 look like this:
  80 .Pp
  81 .Bd -literal -offset indent
  82 udp6       tpi_clts      v     inet6    udp     -       -
  83 tcp6       tpi_cots_ord  v     inet6    tcp     -       -
  84 udp        tpi_clts      v     inet     udp     -       -
  85 tcp        tpi_cots_ord  v     inet     tcp     -       -
  86 rawip      tpi_raw       -     inet      -      -       -
  87 local      tpi_cots_ord  -     loopback  -      -       -
  88 .Ed
  89 .Pp
  90 then using the network type
  91 .Nm udp
  92 in calls to the RPC library function (see
  93 .Xr rpc 3 )
  94 will make the code first try
  95 .Nm udp6 ,
  96 and then
  97 .Nm udp .
  98 .Pp
  99 .Xr getnetconfig 3
 100 and associated functions will parse this file and return structures of
 101 the following format:
 102 .Bd -literal
 103 struct netconfig {
 104     char *nc_netid;              /* Network ID */
 105     unsigned long nc_semantics;  /* Semantics (see below) */
 106     unsigned long nc_flag;       /* Flags (see below) */
 107     char *nc_protofmly;          /* Protocol family */
 108     char *nc_proto;              /* Protocol name */
 109     char *nc_device;             /* Network device pathname (unused) */
 110     unsigned long nc_nlookups;   /* Number of lookup libs (unused) */
 111     char **nc_lookups;           /* Names of the libraries (unused) */
 112     unsigned long nc_unused[9];  /* reserved */
 113 };
 114 .Ed
 115 .Sh FILES
 116 .Nm /etc/netconfig
 117 .Sh SEE ALSO
 118 .Xr getnetconfig 3 ,
 119 .Xr getnetpath 3