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.\" @(#)initgroups.3 8.1 (Berkeley) 6/4/93 29.\" $FreeBSD$ 30.\" 31.Dd October 26, 2014 32.Dt INITGROUPS 3 33.Os 34.Sh NAME 35.Nm initgroups 36.Nd initialize group access list 37.Sh LIBRARY 38.Lb libc 39.Sh SYNOPSIS 40.In unistd.h 41.Ft int 42.Fn initgroups "const char *name" "gid_t basegid" 43.Sh DESCRIPTION 44The 45.Fn initgroups 46function 47uses the 48.Xr getgrouplist 3 49function to calculate the group access list for the user 50specified in 51.Fa name . 52This group list is then setup for the current process using 53.Xr setgroups 2 . 54The 55.Fa basegid 56is automatically included in the groups list. 57Typically this value is given as 58the group number from the password file. 59.Sh RETURN VALUES 60.Rv -std initgroups 61.Sh ERRORS 62The 63.Fn initgroups 64function may fail and set 65.Va errno 66for any of the errors specified for the library function 67.Xr setgroups 2 . 68It may also return: 69.Bl -tag -width Er 70.It Bq Er ENOMEM 71The 72.Fn initgroups 73function was unable to allocate temporary storage. 74.El 75.Sh SEE ALSO 76.Xr setgroups 2 , 77.Xr getgrouplist 3 78.Sh HISTORY 79The 80.Fn initgroups 81function appeared in 82.Bx 4.2 . 83