1.\" $NetBSD: getnetgrent.3,v 1.10 2002/02/07 07:00:13 ross Exp $ 2.\" 3.\" Copyright (c) 1992, 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.\" @(#)getnetgrent.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd January 16, 1999 37.Dt GETNETGRENT 3 38.Os 39.Sh NAME 40.Nm getnetgrent , 41.Nm innetgr , 42.Nm setnetgrent , 43.Nm endnetgrent 44.Nd netgroup database operations 45.Sh LIBRARY 46.Lb libc 47.Sh SYNOPSIS 48.Fd #include \*[Lt]netgroup.h\*[Gt] 49.Ft int 50.Fn getnetgrent "const char **host" "const char **user" "const char **domain" 51.Ft int 52.Fn innetgr "const char *netgroup" "const char *host" "const char *user" "const char *domain" 53.Ft void 54.Fn setnetgrent "const char *netgroup" 55.Ft void 56.Fn endnetgrent void 57.Sh DESCRIPTION 58These functions operate on the netgroup database file which is described in 59.Xr netgroup 5 . 60.Pp 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 65.Pp 66that defines a combination of host, user and domain. 67Any of the three fields may be specified as ``wildcards'' that match any 68string. 69.Pp 70The function 71.Fn getnetgrent 72sets the three pointer arguments to the strings of the next member of the 73current netgroup. 74If any of the string pointers are 75.Dv NULL 76that field is considered a wildcard. 77.Pp 78The functions 79.Fn setnetgrent 80and 81.Fn endnetgrent 82set the current netgroup and terminate the current netgroup respectively. 83If 84.Fn setnetgrent 85is called with a different netgroup than the previous call, an implicit 86.Fn endnetgrent 87is implied. 88.Fn setnetgrent 89also sets the offset to the first member of the netgroup. 90.Pp 91The function 92.Fn innetgr 93searches for a match of all fields within the specified group. 94If any of the 95.Sy host , 96.Sy user , 97or 98.Sy domain 99arguments are 100.Dv NULL 101those fields will match any string value in the netgroup member. 102.Sh RETURN VALUES 103The function 104.Fn getnetgrent 105returns 0 for ``no more netgroup members'' and 1 otherwise. 106The function 107.Fn innetgr 108returns 1 for a successful match and 0 otherwise. 109The functions 110.Fn setnetgrent 111and 112.Fn endnetgrent 113have no return value. 114.Sh FILES 115.Bl -tag -width /etc/netgroup -compact 116.It Pa /etc/netgroup 117netgroup database file 118.El 119.Sh SEE ALSO 120.Xr netgroup 5 , 121.Xr nsswitch.conf 5 122.Sh BUGS 123The function 124.Fn getnetgrent 125returns pointers to dynamically allocated data areas that are free'd when 126the function 127.Fn endnetgrent 128is called. 129