xref: /netbsd-src/lib/libc/sys/setgroups.2 (revision d9158b13b5dfe46201430699a3f7a235ecf28df3)
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.6 1994/04/19 00:09:05 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 <sys/param.h>
43.Fd #include <sys/types.h>
44.Fd #include <unistd.h>
45.Ft int
46.Fn setgroups "int ngroups" "const gid_t *gidset"
47.Sh DESCRIPTION
48.Fn Setgroups
49sets the group access list of the current user process
50according to the array
51.Fa gidset .
52The parameter
53.Fa ngroups
54indicates the number of entries in the array and must be no
55more than
56.Dv {NGROUPS_MAX} .
57.Pp
58Only the super-user may set new groups.
59.Sh RETURN VALUES
60A 0 value is returned on success, -1 on error, with
61an error code stored in
62.Va errno .
63.Sh ERRORS
64The
65.Fn setgroups
66call will fail if:
67.Bl -tag -width Er
68.It Bq Er EINVAL
69The value of
70.Fa ngroups
71is greater than
72.Dv {NGROUPS_MAX} .
73.It Bq Er EPERM
74The caller is not the super-user.
75.It Bq Er EFAULT
76The address specified for
77.Fa gidset
78is outside the process
79address space.
80.El
81.Sh SEE ALSO
82.Xr getgroups 2 ,
83.Xr initgroups 3
84.Sh HISTORY
85The
86.Fn setgroups
87function call appeared in
88.Bx 4.2 .
89