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 SYNOPSIS 45.Ft int 46.Fn getnetgrent "char **host" "char **user" "char **domain" 47.Ft int 48.Fn innetgr "const char *netgroup" "const char *host" "const char *user" "const char *domain" 49.Ft void 50.Fn setnetgrent "const char *netgroup" 51.Ft void 52.Fn endnetgrent void 53.Sh DESCRIPTION 54These functions operate on the netgroup database file 55.Pa /etc/netgroup 56which is described 57in 58.Xr netgroup 5 . 59The database defines a set of netgroups, each made up of one or more triples: 60.Bd -literal -offset indent 61(host, user, domain) 62.Ed 63that defines a combination of host, user and domain. 64Any of the three fields may be specified as ``wildcards'' that match any 65string. 66.Pp 67The function 68.Fn getnetgrent 69sets the three pointer arguments to the strings of the next member of the 70current netgroup. 71If any of the string pointers are 72.Sy (char *)0 73that field is considered a wildcard. 74.Pp 75The functions 76.Fn setnetgrent 77and 78.Fn endnetgrent 79set the current netgroup and terminate the current netgroup respectively. 80If 81.Fn setnetgrent 82is called with a different netgroup than the previous call, an implicit 83.Fn endnetgrent 84is implied. 85.Fn Setnetgrent 86also sets the offset to the first member of the netgroup. 87.Pp 88The function 89.Fn innetgr 90searches for a match of all fields within the specified group. 91If any of the 92.Sy host , 93.Sy user , 94or 95.Sy domain 96arguments are 97.Sy (char *)0 98those fields will match any string value in the netgroup member. 99.Sh RETURN VALUES 100The function 101.Fn getnetgrent 102returns 0 for ``no more netgroup members'' and 1 otherwise. 103The function 104.Fn innetgr 105returns 1 for a successful match and 0 otherwise. 106The functions 107.Fn setnetgrent 108and 109.Fn endnetgrent 110have no return value. 111.Sh FILES 112.Bl -tag -width /etc/netgroup -compact 113.It Pa /etc/netgroup 114netgroup database file 115.El 116.Sh SEE ALSO 117.Xr netgroup 5 118.Sh COMPATIBILITY 119The netgroup members have three string fields to maintain compatibility 120with other vendor implementations, however it is not obvious what use the 121.Sy domain 122string has within BSD. 123.Sh BUGS 124The function 125.Fn getnetgrent 126returns pointers to dynamically allocated data areas that are freed when 127the function 128.Fn endnetgrent 129is called. 130