diff options
Diffstat (limited to 'src/lib/libc/net/getprotoent.3')
| -rw-r--r-- | src/lib/libc/net/getprotoent.3 | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/src/lib/libc/net/getprotoent.3 b/src/lib/libc/net/getprotoent.3 new file mode 100644 index 0000000000..f67987954f --- /dev/null +++ b/src/lib/libc/net/getprotoent.3 | |||
| @@ -0,0 +1,144 @@ | |||
| 1 | .\" $OpenBSD: getprotoent.3,v 1.2 1996/08/19 08:28:50 tholo Exp $ | ||
| 2 | .\" | ||
| 3 | .\" Copyright (c) 1983, 1991, 1993 | ||
| 4 | .\" The Regents of the University of California. All rights reserved. | ||
| 5 | .\" | ||
| 6 | .\" Redistribution and use in source and binary forms, with or without | ||
| 7 | .\" modification, are permitted provided that the following conditions | ||
| 8 | .\" are met: | ||
| 9 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 10 | .\" notice, this list of conditions and the following disclaimer. | ||
| 11 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer in the | ||
| 13 | .\" documentation and/or other materials provided with the distribution. | ||
| 14 | .\" 3. All advertising materials mentioning features or use of this software | ||
| 15 | .\" must display the following acknowledgement: | ||
| 16 | .\" This product includes software developed by the University of | ||
| 17 | .\" California, Berkeley and its contributors. | ||
| 18 | .\" 4. Neither the name of the University nor the names of its contributors | ||
| 19 | .\" may be used to endorse or promote products derived from this software | ||
| 20 | .\" without specific prior written permission. | ||
| 21 | .\" | ||
| 22 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 23 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 24 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 25 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 26 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 27 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 28 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 29 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 30 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 31 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 32 | .\" SUCH DAMAGE. | ||
| 33 | .\" | ||
| 34 | .Dd June 4, 1993 | ||
| 35 | .Dt GETPROTOENT 3 | ||
| 36 | .Os BSD 4.2 | ||
| 37 | .Sh NAME | ||
| 38 | .Nm getprotoent , | ||
| 39 | .Nm getprotobynumber , | ||
| 40 | .Nm getprotobyname , | ||
| 41 | .Nm setprotoent , | ||
| 42 | .Nm endprotoent | ||
| 43 | .Nd get protocol entry | ||
| 44 | .Sh SYNOPSIS | ||
| 45 | .Fd #include <netdb.h> | ||
| 46 | .Ft struct protoent * | ||
| 47 | .Fn getprotoent | ||
| 48 | .Ft struct protoent * | ||
| 49 | .Fn getprotobyname "char *name" | ||
| 50 | .Ft struct protoent * | ||
| 51 | .Fn getprotobynumber "int proto" | ||
| 52 | .Fn setprotoent "int stayopen" | ||
| 53 | .Fn endprotoent | ||
| 54 | .Sh DESCRIPTION | ||
| 55 | The | ||
| 56 | .Fn getprotoent , | ||
| 57 | .Fn getprotobyname , | ||
| 58 | and | ||
| 59 | .Fn getprotobynumber | ||
| 60 | functions | ||
| 61 | each return a pointer to an object with the | ||
| 62 | following structure | ||
| 63 | containing the broken-out | ||
| 64 | fields of a line in the network protocol data base, | ||
| 65 | .Pa /etc/protocols . | ||
| 66 | .Bd -literal -offset indent | ||
| 67 | .Pp | ||
| 68 | struct protoent { | ||
| 69 | char *p_name; /* official name of protocol */ | ||
| 70 | char **p_aliases; /* alias list */ | ||
| 71 | int p_proto; /* protocol number */ | ||
| 72 | }; | ||
| 73 | .Ed | ||
| 74 | .Pp | ||
| 75 | The members of this structure are: | ||
| 76 | .Bl -tag -width p_aliases | ||
| 77 | .It Fa p_name | ||
| 78 | The official name of the protocol. | ||
| 79 | .It Fa p_aliases | ||
| 80 | A zero terminated list of alternate names for the protocol. | ||
| 81 | .It Fa p_proto | ||
| 82 | The protocol number. | ||
| 83 | .El | ||
| 84 | .Pp | ||
| 85 | The | ||
| 86 | .Fn getprotoent | ||
| 87 | function | ||
| 88 | reads the next line of the file, opening the file if necessary. | ||
| 89 | .Pp | ||
| 90 | The | ||
| 91 | .Fn setprotoent | ||
| 92 | function | ||
| 93 | opens and rewinds the file. If the | ||
| 94 | .Fa stayopen | ||
| 95 | flag is non-zero, | ||
| 96 | the net data base will not be closed after each call to | ||
| 97 | .Fn getprotobyname | ||
| 98 | or | ||
| 99 | .Fn getprotobynumber . | ||
| 100 | .Pp | ||
| 101 | The | ||
| 102 | .Fn endprotoent | ||
| 103 | function | ||
| 104 | closes the file. | ||
| 105 | .Pp | ||
| 106 | The | ||
| 107 | .Fn getprotobyname | ||
| 108 | function | ||
| 109 | and | ||
| 110 | .Fn getprotobynumber | ||
| 111 | sequentially search from the beginning | ||
| 112 | of the file until a matching | ||
| 113 | protocol name or | ||
| 114 | protocol number is found, | ||
| 115 | or until | ||
| 116 | .Dv EOF | ||
| 117 | is encountered. | ||
| 118 | .Sh RETURN VALUES | ||
| 119 | Null pointer | ||
| 120 | (0) returned on | ||
| 121 | .Dv EOF | ||
| 122 | or error. | ||
| 123 | .Sh FILES | ||
| 124 | .Bl -tag -width /etc/protocols -compact | ||
| 125 | .It Pa /etc/protocols | ||
| 126 | .El | ||
| 127 | .Sh SEE ALSO | ||
| 128 | .Xr protocols 5 | ||
| 129 | .Sh HISTORY | ||
| 130 | The | ||
| 131 | .Fn getprotoent , | ||
| 132 | .Fn getprotobynumber , | ||
| 133 | .Fn getprotobyname , | ||
| 134 | .Fn setprotoent , | ||
| 135 | and | ||
| 136 | .Fn endprotoent | ||
| 137 | functions appeared in | ||
| 138 | .Bx 4.2 . | ||
| 139 | .Sh BUGS | ||
| 140 | These functions use a static data space; | ||
| 141 | if the data is needed for future use, it should be | ||
| 142 | copied before any subsequent calls overwrite it. | ||
| 143 | Only the Internet | ||
| 144 | protocols are currently understood. | ||
