1.\" Copyright (c) 1992, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)getnetgrent.3 8.1 (Berkeley) 6/4/93 33.\" $FreeBSD$ 34.\" 35.Dd June 4, 1993 36.Dt GETNETGRENT 3 37.Os 38.Sh NAME 39.Nm getnetgrent , 40.Nm innetgr , 41.Nm setnetgrent , 42.Nm endnetgrent 43.Nd netgroup database operations 44.Sh LIBRARY 45.Lb libc 46.Sh SYNOPSIS 47.Ft int 48.Fn getnetgrent "char **host" "char **user" "char **domain" 49.Ft int 50.Fn innetgr "const char *netgroup" "const char *host" "const char *user" "const char *domain" 51.Ft void 52.Fn setnetgrent "const char *netgroup" 53.Ft void 54.Fn endnetgrent void 55.Sh DESCRIPTION 56These functions operate on the netgroup database file 57.Pa /etc/netgroup 58which is described 59in 60.Xr netgroup 5 . 61The database defines a set of netgroups, each made up of one or more triples: 62.Bd -literal -offset indent 63(host, user, domain) 64.Ed 65that defines a combination of host, user and domain. 66Any of the three fields may be specified as ``wildcards'' that match any 67string. 68.Pp 69The function 70.Fn getnetgrent 71sets the three pointer arguments to the strings of the next member of the 72current netgroup. 73If any of the string pointers are 74.Sy (char *)0 75that field is considered a wildcard. 76.Pp 77The functions 78.Fn setnetgrent 79and 80.Fn endnetgrent 81set the current netgroup and terminate the current netgroup respectively. 82If 83.Fn setnetgrent 84is called with a different netgroup than the previous call, an implicit 85.Fn endnetgrent 86is implied. 87.Fn Setnetgrent 88also sets the offset to the first member of the netgroup. 89.Pp 90The function 91.Fn innetgr 92searches for a match of all fields within the specified group. 93If any of the 94.Sy host , 95.Sy user , 96or 97.Sy domain 98arguments are 99.Sy (char *)0 100those fields will match any string value in the netgroup member. 101.Sh RETURN VALUES 102The function 103.Fn getnetgrent 104returns 0 for ``no more netgroup members'' and 1 otherwise. 105The function 106.Fn innetgr 107returns 1 for a successful match and 0 otherwise. 108The functions 109.Fn setnetgrent 110and 111.Fn endnetgrent 112have no return value. 113.Sh FILES 114.Bl -tag -width /etc/netgroup -compact 115.It Pa /etc/netgroup 116netgroup database file 117.El 118.Sh SEE ALSO 119.Xr netgroup 5 120.Sh COMPATIBILITY 121The netgroup members have three string fields to maintain compatibility 122with other vendor implementations, however it is not obvious what use the 123.Sy domain 124string has within BSD. 125.Sh BUGS 126The function 127.Fn getnetgrent 128returns pointers to dynamically allocated data areas that are freed when 129the function 130.Fn endnetgrent 131is called. 132