1.\" $NetBSD: initgroups.3,v 1.12 2002/08/10 09:17:49 wiz 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 August 10, 2002 37.Dt INITGROUPS 3 38.Os 39.Sh NAME 40.Nm initgroups 41.Nd initialize supplementary group IDs 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include \*[Lt]unistd.h\*[Gt] 46.Ft int 47.Fn initgroups "const char *name" "gid_t basegid" 48.Sh DESCRIPTION 49The 50.Fn initgroups 51function 52uses the 53.Xr getgrouplist 3 54function to calculate the supplementary group IDs for the user 55specified in 56.Fa name . 57This group list then set up for the current process using 58.Xr setgroups 2 . 59The 60.Fa basegid 61is automatically included in the group list. 62Typically this value is given as 63the group number from the password file. 64.Pp 65If the groups database lists more than 66.Ev NGROUPS 67groups for 68.Fa name 69(including one for 70.Fa basegid ) , 71the later groups are ignored. 72.Sh RETURN VALUES 73The 74.Fn initgroups 75function 76returns \-1 if it was not invoked by the super-user. 77.Sh SEE ALSO 78.Xr setgroups 2 , 79.Xr getgrouplist 3 80.Sh HISTORY 81The 82.Fn initgroups 83function appeared in 84.Bx 4.2 . 85.Sh BUGS 86The 87.Fn getgrouplist 88function called by 89.Fn initgroups 90uses the routines based on 91.Xr getgrent 3 . 92If the invoking program uses any of these routines, 93the group structure will 94be overwritten in the call to 95.Fn initgroups . 96