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