xref: /freebsd/lib/libc/gen/getgrouplist.3 (revision 58f0484fa251c266ede97b591b499fe3dd4f578e)
158f0484fSRodney W. Grimes.\" Copyright (c) 1991, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
658f0484fSRodney W. Grimes.\" are met:
758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
858f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1058f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1158f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
1258f0484fSRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software
1358f0484fSRodney W. Grimes.\"    must display the following acknowledgement:
1458f0484fSRodney W. Grimes.\"	This product includes software developed by the University of
1558f0484fSRodney W. Grimes.\"	California, Berkeley and its contributors.
1658f0484fSRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors
1758f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1858f0484fSRodney W. Grimes.\"    without specific prior written permission.
1958f0484fSRodney W. Grimes.\"
2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3158f0484fSRodney W. Grimes.\"
3258f0484fSRodney W. Grimes.\"     @(#)getgrouplist.3	8.1 (Berkeley) 6/9/93
3358f0484fSRodney W. Grimes.\"
3458f0484fSRodney W. Grimes.Dd June 9, 1993
3558f0484fSRodney W. Grimes.Dt GETGROUPLIST 3
3658f0484fSRodney W. Grimes.Os
3758f0484fSRodney W. Grimes.Sh NAME
3858f0484fSRodney W. Grimes.Nm getgrouplist
3958f0484fSRodney W. Grimes.Nd calculate group access list
4058f0484fSRodney W. Grimes.Sh SYNOPSIS
4158f0484fSRodney W. Grimes.Fd #include <unistd.h>
4258f0484fSRodney W. Grimes.Ft int
4358f0484fSRodney W. Grimes.Fn getgrouplist "const char *name" "int basegid" "int *groups" "int *ngroups"
4458f0484fSRodney W. Grimes.Sh DESCRIPTION
4558f0484fSRodney W. GrimesThe
4658f0484fSRodney W. Grimes.Fn getgrouplist
4758f0484fSRodney W. Grimesfunction reads through the group file and calculates
4858f0484fSRodney W. Grimesthe group access list for the user specified in
4958f0484fSRodney W. Grimes.Fa name .
5058f0484fSRodney W. GrimesThe
5158f0484fSRodney W. Grimes.Fa basegid
5258f0484fSRodney W. Grimesis automatically included in the groups list.
5358f0484fSRodney W. GrimesTypically this value is given as
5458f0484fSRodney W. Grimesthe group number from the password file.
5558f0484fSRodney W. Grimes.Pp
5658f0484fSRodney W. GrimesThe resulting group list is returned in the integer array pointed to by
5758f0484fSRodney W. Grimes.Fa groups .
5858f0484fSRodney W. GrimesThe caller specifies the size of the
5958f0484fSRodney W. Grimes.Fa groups
6058f0484fSRodney W. Grimesarray in the integer pointed to by
6158f0484fSRodney W. Grimes.Fa ngroups ;
6258f0484fSRodney W. Grimesthe actual number of groups found is returned in
6358f0484fSRodney W. Grimes.Fa ngroups .
6458f0484fSRodney W. Grimes.Sh RETURN VALUES
6558f0484fSRodney W. GrimesThe
6658f0484fSRodney W. Grimes.Fn getgrouplist
6758f0484fSRodney W. Grimesfunction
6858f0484fSRodney W. Grimesreturns \-1 if the size of the group list is too small to
6958f0484fSRodney W. Grimeshold all the user's groups.
7058f0484fSRodney W. GrimesHere, the group array will be filled with as many groups as will fit.
7158f0484fSRodney W. Grimes.Sh FILES
7258f0484fSRodney W. Grimes.Bl -tag -width /etc/group -compact
7358f0484fSRodney W. Grimes.It Pa /etc/group
7458f0484fSRodney W. Grimesgroup membership list
7558f0484fSRodney W. Grimes.El
7658f0484fSRodney W. Grimes.Sh SEE ALSO
7758f0484fSRodney W. Grimes.Xr setgroups 2 ,
7858f0484fSRodney W. Grimes.Xr initgroups 3
7958f0484fSRodney W. Grimes.Sh HISTORY
8058f0484fSRodney W. GrimesThe
8158f0484fSRodney W. Grimes.Fn getgrouplist
8258f0484fSRodney W. Grimesfunction first appeared in 4.4BSD.
8358f0484fSRodney W. Grimes.Sh BUGS
8458f0484fSRodney W. GrimesThe
8558f0484fSRodney W. Grimes.Fn getgrouplist
8658f0484fSRodney W. Grimesfunction
8758f0484fSRodney W. Grimesuses the routines based on
8858f0484fSRodney W. Grimes.Xr getgrent 3 .
8958f0484fSRodney W. GrimesIf the invoking program uses any of these routines,
9058f0484fSRodney W. Grimesthe group structure will
9158f0484fSRodney W. Grimesbe overwritten in the call to
9258f0484fSRodney W. Grimes.Fn getgrouplist .
93