projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BSD 4_3_Net_2 release
[unix-history] / usr / src / lib / libc / net / getprotoent.3
diff --git a/usr/src/lib/libc/net/getprotoent.3 b/usr/src/lib/libc/net/getprotoent.3
index 87e622f..e897a5b 100644 (file)
--- a/usr/src/lib/libc/net/getprotoent.3
+++ b/usr/src/lib/libc/net/getprotoent.3
@@ -1,117 +1,144 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.\"    @(#)getprotoent.3       6.5 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
 .\"
 .\"
-.TH GETPROTOENT 3 "June 23, 1990"
-.UC 5
-.SH NAME
-getprotoent, getprotobynumber, getprotobyname, setprotoent,
-endprotoent \- get protocol entry
-.SH SYNOPSIS
-.nf
-.ft B
-.B #include <netdb.h>
-.PP
-.ft B
-struct protoent *getprotoent()
-.PP
-.ft B
-struct protoent *getprotobyname(name)
-char *name;
-.PP
-.ft B
-struct protoent *getprotobynumber(proto)
-int proto;
-.PP
-.ft B
-setprotoent(stayopen)
-int stayopen
-.PP
-.ft B
-endprotoent()
-.fi
-.SH DESCRIPTION
-.IR Getprotoent ,
-.IR getprotobyname ,
+.\"     @(#)getprotoent.3      6.6 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt GETPROTOENT 3
+.Os BSD 4.2
+.Sh NAME
+.Nm getprotoent ,
+.Nm getprotobynumber ,
+.Nm getprotobyname ,
+.Nm setprotoent ,
+.Nm endprotoent
+.Nd get protocol entry
+.Sh SYNOPSIS
+.Fd #include <netdb.h>
+.Ft struct protoent *
+.Fn getprotoent 
+.Ft struct protoent *
+.Fn getprotobyname "char *name"
+.Ft struct protoent *
+.Fn getprotobynumber "int proto"
+.Fn setprotoent "int stayopen"
+.Fn endprotoent 
+.Sh DESCRIPTION
+The
+.Fn getprotoent ,
+.Fn getprotobyname ,
 and
 and
-.I getprotobynumber
+.Fn getprotobynumber
+functions
 each return a pointer to an object with the
 following structure
 containing the broken-out
 fields of a line in the network protocol data base,
 each return a pointer to an object with the
 following structure
 containing the broken-out
 fields of a line in the network protocol data base,
-.IR /etc/protocols .
-.RS
-.PP
-.nf
+.Pa /etc/protocols .
+.Bd -literal -offset indent
+.Pp
 struct protoent {
        char    *p_name;        /* official name of protocol */
        char    **p_aliases;    /* alias list */
        int     p_proto;        /* protocol number */
 };
 struct protoent {
        char    *p_name;        /* official name of protocol */
        char    **p_aliases;    /* alias list */
        int     p_proto;        /* protocol number */
 };
-.ft R
-.ad
-.fi
-.RE
-.PP
+.Ed
+.Pp
 The members of this structure are:
 The members of this structure are:
-.TP \w'p_aliases'u+2n
-p_name
+.Bl -tag -width p_aliases
+.It Fa p_name
 The official name of the protocol.
 The official name of the protocol.
-.TP \w'p_aliases'u+2n
-p_aliases
+.It Fa p_aliases
 A zero terminated list of alternate names for the protocol.
 A zero terminated list of alternate names for the protocol.
-.TP \w'p_aliases'u+2n
-p_proto
+.It Fa p_proto
 The protocol number.
 The protocol number.
-.PP
-.I Getprotoent
+.El
+.Pp
+The
+.Fn getprotoent
+function
 reads the next line of the file, opening the file if necessary.
 reads the next line of the file, opening the file if necessary.
-.PP
-.I Setprotoent
+.Pp
+The
+.Fn setprotoent
+function
 opens and rewinds the file.  If the
 opens and rewinds the file.  If the
-.I stayopen
+.Fa stayopen
 flag is non-zero,
 the net data base will not be closed after each call to 
 flag is non-zero,
 the net data base will not be closed after each call to 
-.I getprotobyname
+.Fn getprotobyname
 or
 or
-.IR getprotobynumber .
-.PP
-.I Endprotoent
+.Fn getprotobynumber .
+.Pp
+The
+.Fn endprotoent
+function
 closes the file.
 closes the file.
-.PP
-.I Getprotobyname
+.Pp
+The
+.Fn getprotobyname
+function
 and
 and
-.I getprotobynumber
+.Fn getprotobynumber
 sequentially search from the beginning
 of the file until a matching
 protocol name or
 protocol number is found,
 sequentially search from the beginning
 of the file until a matching
 protocol name or
 protocol number is found,
-or until EOF is encountered.
-.SH FILES
-/etc/protocols
-.SH "SEE ALSO"
-protocols(5)
-.SH DIAGNOSTICS
+or until
+.Dv EOF
+is encountered.
+.Sh RETURN VALUES
 Null pointer
 Null pointer
-(0) returned on EOF or error.
-.SH BUGS
-All information
-is contained in a static area
-so it must be copied if it is
-to be saved.  Only the Internet
+(0) returned on
+.Dv EOF
+or error.
+.Sh FILES
+.Bl -tag -width /etc/protocols -compact
+.It Pa /etc/protocols
+.El
+.Sh SEE ALSO
+.Xr protocols 5
+.Sh HISTORY
+The
+.Fn getprotoent ,
+.Fn getprotobynumber ,
+.Fn getprotobyname ,
+.Fn setprotoent ,
+and
+.Fn endprotoent
+functions appeared in 
+.Bx 4.2 .
+.Sh BUGS
+These functions use a static data space;
+if the data is needed for future use, it should be
+copied before any subsequent calls overwrite it.
+Only the Internet
 protocols are currently understood.
 protocols are currently understood.
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.