lib/libc/rpc/netconfig.5

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