tools/llvm: Do not build with symbols
[minix3.git] / lib / libc / sys / setgroups.2
blobe49b54ca741763f6604e3b064d2bb4c60dadca83
1 .\"     $NetBSD: setgroups.2,v 1.19 2013/07/14 14:29:09 njoly 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. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)setgroups.2 8.2 (Berkeley) 4/16/94
31 .\"
32 .Dd October 7, 2006
33 .Dt SETGROUPS 2
34 .Os
35 .Sh NAME
36 .Nm setgroups
37 .Nd set group access list
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In sys/param.h
42 .In unistd.h
43 .Ft int
44 .Fn setgroups "int ngroups" "const gid_t *gidset"
45 .Sh DESCRIPTION
46 .Fn setgroups
47 sets the group access list of the current user process
48 according to the array
49 .Fa gidset .
50 The parameter
51 .Fa ngroups
52 indicates the number of entries in the array and must be no
53 more than
54 .Brq Dv NGROUPS_MAX .
55 .Pp
56 Only the super-user may set new groups.
57 .Pp
58 This system call affects only secondary groups.
59 .Sh RETURN VALUES
60 A 0 value is returned on success, \-1 on error, with
61 an error code stored in
62 .Va errno .
63 .Sh ERRORS
64 The
65 .Fn setgroups
66 call will fail if:
67 .Bl -tag -width Er
68 .It Bq Er EINVAL
69 The value of
70 .Fa ngroups
71 is greater than
72 .Brq Dv NGROUPS_MAX .
73 .It Bq Er EPERM
74 The caller is not the super-user.
75 .It Bq Er EFAULT
76 The address specified for
77 .Fa gidset
78 is outside the process
79 address space.
80 .El
81 .Sh SEE ALSO
82 .Xr getgroups 2 ,
83 .Xr setegid 2 ,
84 .Xr setgid 2 ,
85 .Xr setregid 2 ,
86 .Xr initgroups 3
87 .Sh HISTORY
88 The
89 .Fn setgroups
90 function call appeared in
91 .Bx 4.2 .