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. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)initgroups.3 8.1 (Berkeley) 6/4/93 29.\" $FreeBSD: src/lib/libc/gen/initgroups.3,v 1.6.2.4 2001/12/14 18:33:51 ru Exp $ 30.\" $DragonFly: src/lib/libc/gen/initgroups.3,v 1.2 2003/06/17 04:26:42 dillon Exp $ 31.\" 32.Dd June 4, 1993 33.Dt INITGROUPS 3 34.Os 35.Sh NAME 36.Nm initgroups 37.Nd initialize group access list 38.Sh LIBRARY 39.Lb libc 40.Sh SYNOPSIS 41.In unistd.h 42.Ft int 43.Fn initgroups "const char *name" "gid_t 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 61.Rv -std initgroups 62.Sh ERRORS 63The 64.Fn initgroups 65function may fail and set 66.Va errno 67for any of the errors specified for the library function 68.Xr setgroups 2 . 69.Sh SEE ALSO 70.Xr setgroups 2 , 71.Xr getgrouplist 3 72.Sh HISTORY 73The 74.Fn initgroups 75function appeared in 76.Bx 4.2 . 77.Sh BUGS 78The 79.Fn getgrouplist 80function called by 81.Fn initgroups 82uses the routines based on 83.Xr getgrent 3 . 84If the invoking program uses any of these routines, 85the group structure will 86be overwritten in the call to 87.Fn initgroups . 88