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