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