]> git.saurik.com Git - apple/xnu.git/blob - bsd/man/man2/setgroups.2
xnu-3248.20.55.tar.gz
[apple/xnu.git] / bsd / man / man2 / setgroups.2
1 .\" $NetBSD: setgroups.2,v 1.7 1995/02/27 12:36:49 cgd Exp $
2 .\"
3 .\" Copyright (c) 1983, 1991, 1993, 1994
4 .\" The Regents of the University of California. All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgement:
16 .\" This product includes software developed by the University of
17 .\" California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\" @(#)setgroups.2 8.2 (Berkeley) 4/16/94
35 .\"
36 .Dd September 15, 2010
37 .Dt SETGROUPS 2
38 .Os BSD 4.2
39 .Sh NAME
40 .Nm setgroups
41 .Nd set group access list
42 .Sh SYNOPSIS
43 .Fd #include <sys/param.h>
44 .Fd #include <unistd.h>
45 .Ft int
46 .Fn setgroups "int ngroups" "const gid_t *gidset"
47 .Sh DESCRIPTION
48 .Fn Setgroups
49 sets the group access list of the current user process
50 according to the array
51 .Fa gidset .
52 The parameter
53 .Fa ngroups
54 indicates the number of entries in the array and must be no
55 more than
56 .Dv {NGROUPS_MAX} .
57 .Pp
58 Only the super-user may set new groups.
59 .Pp
60 Use of
61 .Fn setgroups
62 is highly discouraged.
63 .Sh RETURN VALUES
64 A 0 value is returned on success, -1 on error, with
65 an error code stored in
66 .Va errno .
67 .Sh ERRORS
68 The
69 .Fn setgroups
70 call will fail if:
71 .Bl -tag -width Er
72 .It Bq Er EINVAL
73 The value of
74 .Fa ngroups
75 is greater than
76 .Dv {NGROUPS_MAX} .
77 .It Bq Er EPERM
78 The caller is not the super-user.
79 .It Bq Er EFAULT
80 The address specified for
81 .Fa gidset
82 is outside the process
83 address space.
84 .El
85 .Sh SEE ALSO
86 .Xr getgroups 2 ,
87 .Xr initgroups 3
88 .Sh HISTORY
89 The
90 .Fn setgroups
91 function call appeared in
92 .Bx 4.2 .