1.\" $NetBSD: initgroups.3,v 1.6 1995/10/12 15:39:26 jtc Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)initgroups.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt INITGROUPS 3 38.Os BSD 4.2 39.Sh NAME 40.Nm initgroups 41.Nd initialize supplementary group IDs 42.Sh SYNOPSIS 43.Fd #include <unistd.h> 44.Ft int 45.Fn initgroups "const char *name" "gid_t basegid" 46.Sh DESCRIPTION 47The 48.Fn initgroups 49function 50uses the 51.Xr getgrouplist 3 52function to calculate the supplementary group IDs for the user 53specified in 54.Fa name . 55This group list then set up for the current process using 56.Xr setgroups 2 . 57The 58.Fa basegid 59is automatically included in the group list. 60Typically this value is given as 61the group number from the password file. 62.Sh RETURN VALUES 63The 64.Fn initgroups 65function 66returns \-1 if it was not invoked by the super-user. 67.Sh SEE ALSO 68.Xr setgroups 2 , 69.Xr getgrouplist 3 70.Sh HISTORY 71The 72.Fn initgroups 73function appeared in 74.Bx 4.2 . 75.Sh BUGS 76The 77.Fn getgrouplist 78function called by 79.Fn initgroups 80uses the routines based on 81.Xr getgrent 3 . 82If the invoking program uses any of these routines, 83the group structure will 84be overwritten in the call to 85.Fn initgroups . 86