]> git.saurik.com Git - apple/libinfo.git/blob - lookup.subproj/getgrouplist.3
Libinfo-324.tar.gz
[apple/libinfo.git] / lookup.subproj / getgrouplist.3
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: src/lib/libc/gen/getgrouplist.3,v 1.9 2007/01/09 00:27:53 imp Exp $
30 .\"
31 .Dd June 9, 1993
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" "int basegid" "int *groups" "int *ngroups"
43 .\".Fn getgrouplist "const char *name" "gid_t basegid" "gid_t *groups" "int *ngroups"
44 .Sh DESCRIPTION
45 The
46 .Fn getgrouplist
47 function reads through the group file and calculates
48 the group access list for the user specified in
49 .Fa name .
50 The
51 .Fa basegid
52 is automatically included in the groups list.
53 Typically this value is given as
54 the group number from the password file.
55 .Pp
56 The resulting group list is returned in the array pointed to by
57 .Fa groups .
58 The caller specifies the size of the
59 .Fa groups
60 array in the integer pointed to by
61 .Fa ngroups ;
62 the actual number of groups found is returned in
63 .Fa ngroups .
64 .Sh RETURN VALUES
65 The
66 .Fn getgrouplist
67 function
68 returns \-1 if the size of the group list is too small to
69 hold all the user's groups.
70 Here, the group array will be filled with as many groups as will fit.
71 .Sh FILES
72 .Bl -tag -width /etc/group -compact
73 .It Pa /etc/group
74 group membership list
75 .El
76 .Sh SEE ALSO
77 .Xr setgroups 2 ,
78 .Xr initgroups 3
79 .Sh HISTORY
80 The
81 .Fn getgrouplist
82 function first appeared in
83 .Bx 4.4 .
84 .Sh BUGS
85 The
86 .Fn getgrouplist
87 function
88 uses the routines based on
89 .Xr getgrent 3 .
90 If the invoking program uses any of these routines,
91 the group structure will
92 be overwritten in the call to
93 .Fn getgrouplist .