xref: /netbsd-src/lib/libc/gen/initgroups.3 (revision cda4f8f6ee55684e8d311b86c99ea59191e6b74f)
1.\" Copyright (c) 1983, 1991 Regents of the University of California.
2.\" 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: @(#)initgroups.3	6.3 (Berkeley) 4/19/91
33.\"	$Id: initgroups.3,v 1.2 1993/07/30 08:36:59 mycroft Exp $
34.\"
35.Dd April 19, 1991
36.Dt INITGROUPS 3
37.Os BSD 4.2
38.Sh NAME
39.Nm initgroups
40.Nd initialize group access list
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft int
44.Fn initgroups "const char *name" "int basegid"
45.Sh DESCRIPTION
46The
47.Fn initgroups
48function
49reads through the group file and sets up,
50using the
51.Xr setgroups 2
52call, the group access list for the user
53specified in
54.Fa name .
55The
56.Fa basegid
57is automatically included in the groups list.
58Typically this value is given as
59the group number from the password file.
60.Sh RETURN VALUES
61The
62.Fn initgroups
63function
64returns \-1 if it was not invoked by the super-user.
65.Sh FILES
66.Bl -tag -width /etc/group -compact
67.It Pa /etc/group
68.El
69.Sh SEE ALSO
70.Xr setgroups 2
71.Sh HISTORY
72The
73.Nm
74function appeared in
75.Bx 4.2 .
76.Sh BUGS
77The
78.Fn initgroups
79function
80uses the routines based on
81.Xr getgrent 3 .
82If the invoking program uses any of these routines,
83the group structure will
84be overwritten in the call to
85.Fn initgroups .
86