1.\" $NetBSD: getservent.3,v 1.12 2002/02/07 07:00:20 ross 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.\" @(#)getservent.3 8.4 (Berkeley) 5/25/95 35.\" 36.Dd May 25, 1995 37.Dt GETSERVENT 3 38.Os 39.Sh NAME 40.Nm getservent , 41.Nm getservbyport , 42.Nm getservbyname , 43.Nm setservent , 44.Nm endservent 45.Nd get service entry 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.Fd #include \*[Lt]netdb.h\*[Gt] 50.Ft struct servent * 51.Fn getservent 52.Ft struct servent * 53.Fn getservbyname "const char *name" "const char *proto" 54.Ft struct servent * 55.Fn getservbyport "int port" "const char *proto" 56.Ft void 57.Fn setservent "int stayopen" 58.Ft void 59.Fn endservent void 60.Sh DESCRIPTION 61The 62.Fn getservent , 63.Fn getservbyname , 64and 65.Fn getservbyport 66functions 67each return a pointer to an object with the 68following structure 69containing the broken-out 70fields of a line in the network services data base, 71.Pa /etc/services . 72.Bd -literal -offset indent 73struct servent { 74 char *s_name; /* official name of service */ 75 char **s_aliases; /* alias list */ 76 int s_port; /* port service resides at */ 77 char *s_proto; /* protocol to use */ 78}; 79.Ed 80.Pp 81The members of this structure are: 82.Bl -tag -width s_aliases 83.It Fa s_name 84The official name of the service. 85.It Fa s_aliases 86A NULL terminated list of alternative names for the service. 87.It Fa s_port 88The port number at which the service resides. 89Port numbers must be given and are returned in network byte order. 90.It Fa s_proto 91The name of the protocol to use when contacting the 92service. 93.El 94.Pp 95The 96.Fn getservent 97function 98reads the next line of the file, opening the file if necessary. 99.Pp 100The 101.Fn setservent 102function 103opens and rewinds the file. If the 104.Fa stayopen 105flag is non-zero, 106the net data base will not be closed after each call to 107.Fn getservbyname 108or 109.Fn getservbyport . 110.Pp 111The 112.Fn endservent 113function 114closes the file. 115.Pp 116The 117.Fn getservbyname 118and 119.Fn getservbyport 120functions 121sequentially search from the beginning 122of the file until a matching 123protocol name or 124port number is found, 125or until 126.Dv EOF 127is encountered. 128If a protocol name is also supplied (non-\c 129.Dv NULL ) , 130searches must also match the protocol. 131.Sh FILES 132.Bl -tag -width /etc/services -compact 133.It Pa /etc/services 134.El 135.Sh DIAGNOSTICS 136Null pointer 137(0) returned on 138.Dv EOF 139or error. 140.Sh SEE ALSO 141.Xr getprotoent 3 , 142.Xr services 5 143.Sh HISTORY 144The 145.Fn getservent , 146.Fn getservbyport , 147.Fn getservbyname , 148.Fn setservent , 149and 150.Fn endservent 151functions appeared in 152.Bx 4.2 . 153.Sh BUGS 154These functions use static data storage; 155if the data is needed for future use, it should be 156copied before any subsequent calls overwrite it. 157Expecting port numbers to fit in a 32 bit 158quantity is probably naive. 159