xref: /netbsd-src/lib/libc/gen/getnetgrent.3 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
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.\"     from: @(#)getnetgrent.3	8.1 (Berkeley) 6/4/93
33.\"	$Id: getnetgrent.3,v 1.3 1994/12/11 22:47:06 christos Exp $
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.db
56which is described
57in
58.Xr netgroup 5 .
59If that file does not exist, and the system supports
60.Sy YP,
61then the
62.Sy netgroup
63.Sy YP
64databases are used instead.
65The database defines a set of netgroups, each made up of one or more triples:
66.Bd -literal -offset indent
67(host, user, domain)
68.Ed
69.Pp
70that defines a combination of host, user and domain.
71Any of the three fields may be specified as ``wildcards'' that match any
72string.
73.Pp
74The function
75.Fn getnetgrent
76sets the three pointer arguments to the strings of the next member of the
77current netgroup.
78If any of the string pointers are
79.Sy (char *)0
80that field is considered a wildcard.
81.Pp
82The functions
83.Fn setnetgrent
84and
85.Fn endnetgrent
86set the current netgroup and terminate the current netgroup respectively.
87If
88.Fn setnetgrent
89is called with a different netgroup than the previous call, an implicit
90.Fn endnetgrent
91is implied.
92.Fn Setnetgrent
93also sets the offset to the first member of the netgroup.
94.Pp
95The function
96.Fn innetgr
97searches for a match of all fields within the specified group.
98If any of the
99.Sy host ,
100.Sy user ,
101or
102.Sy domain
103arguments are
104.Sy (char *)0
105those fields will match any string value in the netgroup member.
106.Sh RETURN VALUES
107The function
108.Fn getnetgrent
109returns 0 for ``no more netgroup members'' and 1 otherwise.
110The function
111.Fn innetgr
112returns 1 for a successful match and 0 otherwise.
113The functions
114.Fn setnetgrent
115and
116.Fn endnetgrent
117have no return value.
118.Sh FILES
119.Bl -tag -width /etc/netgroup -compact
120.It Pa /etc/netgroup
121netgroup database file
122.El
123.Sh SEE ALSO
124.Fn netgroup 5
125.Sh BUGS
126The function
127.Fn getnetgrent
128returns pointers to dynamically allocated data areas that are free'd when
129the function
130.Fn endnetgrent
131is called.
132