xref: /netbsd-src/lib/libc/sys/setgroups.2 (revision 448e711c7835101c94f75b7ebddf58046df58290)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" 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.\"     from: @(#)setgroups.2	6.7 (Berkeley) 3/10/91
33.\"	$Id: setgroups.2,v 1.3 1993/11/25 00:39:36 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt SETGROUPS 2
37.Os BSD 4.2
38.Sh NAME
39.Nm setgroups
40.Nd set group access list
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Fd #include <sys/param.h>
44.Ft int
45.Fn setgroups "int ngroups" "const int *gidset"
46.Sh DESCRIPTION
47.Fn Setgroups
48sets the group access list of the current user process
49according to the array
50.Fa gidset .
51The parameter
52.Fa ngroups
53indicates the number of entries in the array and must be no
54more than
55.Dv NGROUPS ,
56as defined in
57.Ao Pa sys/param.h Ac .
58.Pp
59Only the super-user may set new groups.
60.Sh RETURN VALUES
61A 0 value is returned on success, -1 on error, with
62an error code stored in
63.Va errno .
64.Sh ERRORS
65The
66.Fn setgroups
67call will fail if:
68.Bl -tag -width Er
69.It Bq Er EPERM
70The caller is not the super-user.
71.It Bq Er EFAULT
72The address specified for
73.Fa gidset
74is outside the process
75address space.
76.El
77.Sh SEE ALSO
78.Xr getgroups 2 ,
79.Xr initgroups 3
80.Sh BUGS
81The
82.Fa gidset
83array should be of type
84.Em gid_t ,
85but remains integer for compatibility with earlier systems.
86.Sh HISTORY
87The
88.Fn setgroups
89function call appeared in
90.Bx 4.2 .
91