1994-05-27 05:00:24 +00:00
|
|
|
.\" Copyright (c) 1991, 1993
|
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" @(#)getgrouplist.3 8.1 (Berkeley) 6/9/93
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
|
|
|
|
.Dd June 9, 1993
|
|
|
|
|
.Dt GETGROUPLIST 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm getgrouplist
|
|
|
|
|
.Nd calculate group access list
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In unistd.h
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft int
|
|
|
|
|
.Fn getgrouplist "const char *name" "int basegid" "int *groups" "int *ngroups"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn getgrouplist
|
|
|
|
|
function reads through the group file and calculates
|
|
|
|
|
the group access list for the user specified in
|
|
|
|
|
.Fa name .
|
|
|
|
|
The
|
|
|
|
|
.Fa basegid
|
|
|
|
|
is automatically included in the groups list.
|
|
|
|
|
Typically this value is given as
|
|
|
|
|
the group number from the password file.
|
|
|
|
|
.Pp
|
|
|
|
|
The resulting group list is returned in the integer array pointed to by
|
|
|
|
|
.Fa groups .
|
2000-10-30 13:23:19 +00:00
|
|
|
The caller specifies the size of the
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fa groups
|
|
|
|
|
array in the integer pointed to by
|
|
|
|
|
.Fa ngroups ;
|
|
|
|
|
the actual number of groups found is returned in
|
|
|
|
|
.Fa ngroups .
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
The
|
|
|
|
|
.Fn getgrouplist
|
|
|
|
|
function
|
|
|
|
|
returns \-1 if the size of the group list is too small to
|
|
|
|
|
hold all the user's groups.
|
|
|
|
|
Here, the group array will be filled with as many groups as will fit.
|
|
|
|
|
.Sh FILES
|
|
|
|
|
.Bl -tag -width /etc/group -compact
|
|
|
|
|
.It Pa /etc/group
|
|
|
|
|
group membership list
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr setgroups 2 ,
|
|
|
|
|
.Xr initgroups 3
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Fn getgrouplist
|
1996-08-22 23:31:07 +00:00
|
|
|
function first appeared in
|
|
|
|
|
.Bx 4.4 .
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh BUGS
|
|
|
|
|
The
|
|
|
|
|
.Fn getgrouplist
|
|
|
|
|
function
|
|
|
|
|
uses the routines based on
|
|
|
|
|
.Xr getgrent 3 .
|
|
|
|
|
If the invoking program uses any of these routines,
|
|
|
|
|
the group structure will
|
|
|
|
|
be overwritten in the call to
|
|
|
|
|
.Fn getgrouplist .
|
