xref: /freebsd/lib/libc/gen/initgroups.3 (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
1.\" Copyright (c) 1983, 1991, 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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd October 26, 2014
29.Dt INITGROUPS 3
30.Os
31.Sh NAME
32.Nm initgroups
33.Nd initialize group access list
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In unistd.h
38.Ft int
39.Fn initgroups "const char *name" "gid_t basegid"
40.Sh DESCRIPTION
41The
42.Fn initgroups
43function
44uses the
45.Xr getgrouplist 3
46function to calculate the group access list for the user
47specified in
48.Fa name .
49This group list is then setup for the current process using
50.Xr setgroups 2 .
51The
52.Fa basegid
53is automatically included in the groups list.
54Typically this value is given as
55the group number from the password file.
56.Sh RETURN VALUES
57.Rv -std initgroups
58.Sh ERRORS
59The
60.Fn initgroups
61function may fail and set
62.Va errno
63for any of the errors specified for the library function
64.Xr setgroups 2 .
65It may also return:
66.Bl -tag -width Er
67.It Bq Er ENOMEM
68The
69.Fn initgroups
70function was unable to allocate temporary storage.
71.El
72.Sh SEE ALSO
73.Xr setgroups 2 ,
74.Xr getgrouplist 3
75.Sh HISTORY
76The
77.Fn initgroups
78function appeared in
79.Bx 4.2 .
80