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 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 49uses the 50.Xr getgrouplist 3 51function to calculate the group access list for the user 52specified in 53.Fa name . 54This group list is then setup for the current process using 55.Xr setgroups 2 . 56The 57.Fa basegid 58is automatically included in the groups list. 59Typically this value is given as 60the group number from the password file. 61.Sh RETURN VALUES 62The 63.Fn initgroups 64function 65returns \-1 if it was not invoked by the super-user. 66.Sh SEE ALSO 67.Xr setgroups 2 , 68.Xr getgrouplist 3 69.Sh HISTORY 70The 71.Fn initgroups 72function appeared in 73.Bx 4.2 . 74.Sh BUGS 75The 76.Fn getgrouplist 77function called by 78.Fn initgroups 79uses the routines based on 80.Xr getgrent 3 . 81If the invoking program uses any of these routines, 82the group structure will 83be overwritten in the call to 84.Fn initgroups . 85