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