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