[src/trunk]: src/share/man The rpc and netconfig files belong in section 5, n...

[fvdl <fvdl%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/039df8638cd6
branches:  trunk
changeset: 487954:039df8638cd6
user:      fvdl <fvdl%NetBSD.org@localhost>
date:      Thu Jun 15 20:05:51 2000 +0000

description:
The rpc and netconfig files belong in section 5, not 4 (that's where they
are under Solaris). Pointed out by several people. Also, describe
struct netconfig in netconfig(5), as pointed out by Matt Green.

diffstat:

 share/man/man4/netconfig.4 |   89 -------------------------------------
 share/man/man4/rpc.4       |   48 --------------------
 share/man/man5/netconfig.5 |  106 +++++++++++++++++++++++++++++++++++++++++++++
 share/man/man5/rpc.5       |   79 +++++++++++----------------------
 4 files changed, 133 insertions(+), 189 deletions(-)

diffs (truncated from 361 to 300 lines):

diff -r 0f93a54d2442 -r 039df8638cd6 share/man/man4/netconfig.4
--- a/share/man/man4/netconfig.4        Thu Jun 15 19:55:27 2000 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,89 +0,0 @@
-.\"    $NetBSD: netconfig.4,v 1.1 2000/06/02 23:18:31 fvdl Exp $
-.Dd June 2, 2000
-.Dt NETCONFIG 4
-.Sh NAME
-.Nm netconfig
-.Nd network configuration data base
-.Sh SYNOPSIS
-.Fa /etc/netconfig
-.Sh DESCRIPTION
-The
-.Nm
-file defines a list of ``transport names'', describing their semantics
-and protocol. In NetBSD, this file is only used by the RPC library code.
-Entries consist of the following fields:
-.Pp
-.Bl -tag -width indent
-.It network_id
-The name of the transport described.
-.It semantics
-Describes the semantics of the transport. This can be one of:
-.Bl -tag -width ident
-.It Nm tpi_clts
-Connectionless transport.
-.It Nm tpi_cots
-Connection-oriented transport
-.It Nm tpi_cots_ord
-Connection-oriented, ordered transport.
-.It Nm tpi_raw
-A raw connection.
-.El
-.It flags
-This field is  either blank (``-''), or contains a ``v'', meaning visible
-to the
-.Xr getnetconfig 3
-function.
-.It protofamily
-The protocol family of the transport. This is currently one of:
-.Bl -tag -width indent
-.It Nm inet6
-The IPv6 (
-.Dv PF_INET6 )
-family of protocols.
-.It Nm inet
-The IPv4 (
-.Dv PF_INET )
-family of protocols.
-.It Nm loopback
-The
-.Dv PF_LOCAL
-protocol family.
-.El
-.It protoname
-The name of the protocol used for this transport. Can currently be either
-.Nm udp ,
-.Nm tcp 
-or empty.
-.It device
-This field is always empty in NetBSD.
-.It nametoaddr_libs
-This field is always empty in NetBSD.
-.El
-.Pp
-The order of entries in this file will determine which transport will
-be preferred by the RPC library code, given a match on a specified
-network type. For example, if a sample network config file would
-look like this:
-.Pp
-.Bd -literal
-udp6       tpi_clts      v     inet6    udp     -       -
-tcp6       tpi_cots_ord  v     inet6    tcp     -       -
-udp        tpi_clts      v     inet     udp     -       -
-tcp        tpi_cots_ord  v     inet     tcp     -       -
-rawip      tpi_raw       -     inet      -      -       -
-local      tpi_cots_ord  -     loopback  -      -       -
-.Ed
-.Pp
-then using the network type
-.Nm udp
-in calls to the RPC library function (see
-.Xr rpc 3
-) will make the code first try
-.Nm udp6 ,
-and then
-.Nm udp .
-.Sh SEE ALSO
-.Xr getnetconfig 3 ,
-.Xr getnetpath 3
-.Sh FILES
-.Nm /etc/netconfig
diff -r 0f93a54d2442 -r 039df8638cd6 share/man/man4/rpc.4
--- a/share/man/man4/rpc.4      Thu Jun 15 19:55:27 2000 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,48 +0,0 @@
-.\" $NetBSD: rpc.4,v 1.1 2000/06/02 23:18:31 fvdl Exp $
-.\" @(#)rpc.4 1.17 93/08/30 SMI; from SVr4
-.\" Copyright 1989 AT&T
-.Dd December 10, 1991
-.Dt RPC 4
-.Sh NAME
-.Nm rpc
-.Nd rpc program number data base
-.Sh SYNOPSIS
-.Fa /etc/rpc
-.Sh DESCRIPTION
-The 
-.Nm
- file is a local source containing user readable names that
-can be used in place of RPC program numbers. 
-.Pp
-The rpc file has one line for each RPC
-program name. The line has the following format:
-.Pp
-.I name-of-the-RPC-program     RPC-program-number      aliases
-.Pp
-Items are separated by any number of blanks and/or
-tab characters.
-A ``#'' indicates the beginning of a comment;
-characters up to the end of the line are not interpreted
-by routines which search the file.
-.Sh EXAMPLES
-.Pp
-Below is an example of an RPC database:
-.Pp
-.Bd -literal
-#
-#      rpc
-#
-rpcbind                100000  portmap sunrpc portmapper
-rusersd                100002  rusers
-nfs            100003  nfsprog
-mountd         100005  mount   showmount
-walld          100008  rwall   shutdown
-sprayd         100012  spray
-llockmgr       100020
-nlockmgr       100021
-status         100024
-bootparam      100026
-keyserv                100029  keyserver
-.Ed
-.Sh FILES
-.Nm /etc/nsswitch.conf
diff -r 0f93a54d2442 -r 039df8638cd6 share/man/man5/netconfig.5
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man5/netconfig.5        Thu Jun 15 20:05:51 2000 +0000
@@ -0,0 +1,106 @@
+.\"    $NetBSD: netconfig.5,v 1.1 2000/06/15 20:05:54 fvdl Exp $
+.Dd June 2, 2000
+.Dt NETCONFIG 5
+.Sh NAME
+.Nm netconfig
+.Nd network configuration data base
+.Sh SYNOPSIS
+.Fa /etc/netconfig
+.Sh DESCRIPTION
+The
+.Nm
+file defines a list of ``transport names'', describing their semantics
+and protocol. In NetBSD, this file is only used by the RPC library code.
+Entries consist of the following fields:
+.Pp
+.Bl -tag -width indent
+.It network_id
+The name of the transport described.
+.It semantics
+Describes the semantics of the transport. This can be one of:
+.Bl -tag -width ident
+.It Nm tpi_clts
+Connectionless transport.
+.It Nm tpi_cots
+Connection-oriented transport
+.It Nm tpi_cots_ord
+Connection-oriented, ordered transport.
+.It Nm tpi_raw
+A raw connection.
+.El
+.It flags
+This field is  either blank (``-''), or contains a ``v'', meaning visible
+to the
+.Xr getnetconfig 3
+function.
+.It protofamily
+The protocol family of the transport. This is currently one of:
+.Bl -tag -width indent
+.It Nm inet6
+The IPv6 (
+.Dv PF_INET6 )
+family of protocols.
+.It Nm inet
+The IPv4 (
+.Dv PF_INET )
+family of protocols.
+.It Nm loopback
+The
+.Dv PF_LOCAL
+protocol family.
+.El
+.It protoname
+The name of the protocol used for this transport. Can currently be either
+.Nm udp ,
+.Nm tcp 
+or empty.
+.It device
+This field is always empty in NetBSD.
+.It nametoaddr_libs
+This field is always empty in NetBSD.
+.El
+.Pp
+The order of entries in this file will determine which transport will
+be preferred by the RPC library code, given a match on a specified
+network type. For example, if a sample network config file would
+look like this:
+.Pp
+.Bd -literal
+udp6       tpi_clts      v     inet6    udp     -       -
+tcp6       tpi_cots_ord  v     inet6    tcp     -       -
+udp        tpi_clts      v     inet     udp     -       -
+tcp        tpi_cots_ord  v     inet     tcp     -       -
+rawip      tpi_raw       -     inet      -      -       -
+local      tpi_cots_ord  -     loopback  -      -       -
+.Ed
+.Pp
+then using the network type
+.Nm udp
+in calls to the RPC library function (see
+.Xr rpc 3
+) will make the code first try
+.Nm udp6 ,
+and then
+.Nm udp .
+.Pp
+.Xr getnetconfig 3
+and associated functions will parse this file and return structures of
+the following format:
+.Bd -literal
+struct netconfig {
+    char *nc_netid;              /* Network ID */
+    unsigned long nc_semantics;  /* Semantics (see below) */
+    unsigned long nc_flag;       /* Flags (see below) */
+    char *nc_protofmly;          /* Protocol family */
+    char *nc_proto;              /* Protocol name */
+    char *nc_device;             /* Network device pathname (unused) */
+    unsigned long nc_nlookups;   /* Number of lookup libs (unused) */
+    char **nc_lookups;           /* Names of the libraries (unused) */
+    unsigned long nc_unused[9];  /* reserved */
+};
+.Ed
+.Sh SEE ALSO
+.Xr getnetconfig 3 ,
+.Xr getnetpath 3
+.Sh FILES
+.Nm /etc/netconfig
diff -r 0f93a54d2442 -r 039df8638cd6 share/man/man5/rpc.5
--- a/share/man/man5/rpc.5      Thu Jun 15 19:55:27 2000 +0000
+++ b/share/man/man5/rpc.5      Thu Jun 15 20:05:51 2000 +0000
@@ -1,75 +1,50 @@
-.\"    $NetBSD: rpc.5,v 1.2 1994/11/30 19:31:30 jtc Exp $
-.\"    @(#)rpc.5       2.2 88/08/03 4.0 RPCSRC; from 1.4 87/11/27 SMI;
-.\"
-.\"    See the DISCLAIMER and README files in /usr/src/lib/libc/rpc for
-.\"    more information about this file.
-.\"
-.Dd September 26, 1985
+.\" $NetBSD: rpc.5,v 1.3 2000/06/15 20:05:54 fvdl Exp $
+.\" @(#)rpc.4 1.17 93/08/30 SMI; from SVr4
+.\" Copyright 1989 AT&T
+.Dd December 10, 1991
 .Dt RPC 5
-.Os
 .Sh NAME
 .Nm rpc
 .Nd rpc program number data base
+.Sh SYNOPSIS
+.Fa /etc/rpc
 .Sh DESCRIPTION
-The
-.Nm rpc
-file contains user readable names that
-can be used in place of rpc program numbers.
-Each line has the following information:
+The 
+.Nm
+ file is a local source containing user readable names that
+can be used in place of RPC program numbers. 
 .Pp
-.Bl -item -offset indent -compact
-.It
-name of server for the rpc program
-.It
-rpc program number
-.It
-aliases
-.El
+The rpc file has one line for each RPC
+program name. The line has the following format:
+.Pp
+.I name-of-the-RPC-program     RPC-program-number      aliases