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. 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.\" @(#)initgroups.3 8.1 (Berkeley) 6/4/93 33.\" $FreeBSD$ 34.\" 35.Dd June 4, 1993 36.Dt INITGROUPS 3 37.Os 38.Sh NAME 39.Nm initgroups 40.Nd initialize group access list 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.In unistd.h 45.Ft int 46.Fn initgroups "const char *name" "gid_t basegid" 47.Sh DESCRIPTION 48The 49.Fn initgroups 50function 51uses the 52.Xr getgrouplist 3 53function to calculate the group access list for the user 54specified in 55.Fa name . 56This group list is then setup for the current process using 57.Xr setgroups 2 . 58The 59.Fa basegid 60is automatically included in the groups list. 61Typically this value is given as 62the group number from the password file. 63.Sh RETURN VALUES 64.Rv -std initgroups 65.Sh ERRORS 66The 67.Fn initgroups 68function may fail and set 69.Va errno 70for any of the errors specified for the library function 71.Xr setgroups 2 . 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.Sh BUGS 81The 82.Fn getgrouplist 83function called by 84.Fn initgroups 85uses the routines based on 86.Xr getgrent 3 . 87If the invoking program uses any of these routines, 88the group structure will 89be overwritten in the call to 90.Fn initgroups . 91