Merge from vendor branch BZIP:
[dragonfly.git] / lib / libc / gen / initgroups.3
1 .\" Copyright (c) 1983, 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 .\"     @(#)initgroups.3        8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/gen/initgroups.3,v 1.6.2.4 2001/12/14 18:33:51 ru Exp $
34 .\" $DragonFly: src/lib/libc/gen/initgroups.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt INITGROUPS 3
38 .Os
39 .Sh NAME
40 .Nm initgroups
41 .Nd initialize group access list
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In unistd.h
46 .Ft int
47 .Fn initgroups "const char *name" "int basegid"
48 .Sh DESCRIPTION
49 The
50 .Fn initgroups
51 function
52 uses the
53 .Xr getgrouplist 3
54 function to calculate the group access list for the user
55 specified in
56 .Fa name .
57 This group list is then setup for the current process using
58 .Xr setgroups 2 .
59 The
60 .Fa basegid
61 is automatically included in the groups list.
62 Typically this value is given as
63 the group number from the password file.
64 .Sh RETURN VALUES
65 .Rv -std initgroups
66 .Sh ERRORS
67 The
68 .Fn initgroups
69 function may fail and set
70 .Va errno
71 for any of the errors specified for the library function
72 .Xr setgroups 2 .
73 .Sh SEE ALSO
74 .Xr setgroups 2 ,
75 .Xr getgrouplist 3
76 .Sh HISTORY
77 The
78 .Fn initgroups
79 function appeared in
80 .Bx 4.2 .
81 .Sh BUGS
82 The
83 .Fn getgrouplist
84 function called by
85 .Fn initgroups
86 uses the routines based on
87 .Xr getgrent 3 .
88 If the invoking program uses any of these routines,
89 the group structure will
90 be overwritten in the call to
91 .Fn initgroups .