[apple/libc.git] / gen / getnetgrent.3

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