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.\" 34.Dd June 4, 1993 35.Dt INITGROUPS 3 36.Os BSD 4.2 37.Sh NAME 38.Nm initgroups 39.Nd initialize group access list 40.Sh SYNOPSIS 41.Fd #include <unistd.h> 42.Ft int 43.Fn initgroups "const char *name" "int basegid" 44.Sh DESCRIPTION 45The 46.Fn initgroups 47function 48uses the 49.Xr getgrouplist 3 50function to calculate the group access list for the user 51specified in 52.Fa name . 53This group list is then setup for the current process using 54.Xr setgroups 2 . 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 SEE ALSO 66.Xr setgroups 2 , 67.Xr getgrouplist 3 68.Sh HISTORY 69The 70.Fn initgroups 71function appeared in 72.Bx 4.2 . 73.Sh BUGS 74The 75.Fn getgrouplist 76function called by 77.Fn initgroups 78uses the routines based on 79.Xr getgrent 3 . 80If the invoking program uses any of these routines, 81the group structure will 82be overwritten in the call to 83.Fn initgroups . 84