1.\" Copyright (c) 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.\" @(#)getgrouplist.3 8.1 (Berkeley) 6/9/93 33.\" $FreeBSD$ 34.\" 35.Dd June 9, 1993 36.Dt GETGROUPLIST 3 37.Os 38.Sh NAME 39.Nm getgrouplist 40.Nd calculate group access list 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.In unistd.h 45.Ft int 46.Fn getgrouplist "const char *name" "gid_t basegid" "gid_t *groups" "int *ngroups" 47.Sh DESCRIPTION 48The 49.Fn getgrouplist 50function reads through the group file and calculates 51the group access list for the user specified in 52.Fa name . 53The 54.Fa basegid 55is automatically included in the groups list. 56Typically this value is given as 57the group number from the password file. 58.Pp 59The resulting group list is returned in the array pointed to by 60.Fa groups . 61The caller specifies the size of the 62.Fa groups 63array in the integer pointed to by 64.Fa ngroups ; 65the actual number of groups found is returned in 66.Fa ngroups . 67.Sh RETURN VALUES 68The 69.Fn getgrouplist 70function 71returns \-1 if the size of the group list is too small to 72hold all the user's groups. 73Here, the group array will be filled with as many groups as will fit. 74.Sh FILES 75.Bl -tag -width /etc/group -compact 76.It Pa /etc/group 77group membership list 78.El 79.Sh SEE ALSO 80.Xr setgroups 2 , 81.Xr initgroups 3 82.Sh HISTORY 83The 84.Fn getgrouplist 85function first appeared in 86.Bx 4.4 . 87.Sh BUGS 88The 89.Fn getgrouplist 90function 91uses the routines based on 92.Xr getgrent 3 . 93If the invoking program uses any of these routines, 94the group structure will 95be overwritten in the call to 96.Fn getgrouplist . 97