xref: /openbsd-src/lib/libc/sys/setgroups.2 (revision 47911bd667ac77dc523b8a13ef40b012dbffa741)
1.\"	$OpenBSD: setgroups.2,v 1.7 2000/04/15 11:46:04 aaron 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. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)setgroups.2	8.2 (Berkeley) 4/16/94
36.\"
37.Dd April 16, 1994
38.Dt SETGROUPS 2
39.Os
40.Sh NAME
41.Nm setgroups
42.Nd set group access list
43.Sh SYNOPSIS
44.Fd #include <sys/types.h>
45.Fd #include <unistd.h>
46.Ft int
47.Fn setgroups "int ngroups" "const gid_t *gidset"
48.Sh DESCRIPTION
49.Fn setgroups
50sets the group access list of the current user process
51according to the array
52.Fa gidset .
53The parameter
54.Fa ngroups
55indicates the number of entries in the array and must be no
56more than
57.Dv {NGROUPS_MAX} .
58.Pp
59Only the superuser 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 EINVAL
70The value of
71.Fa ngroups
72is greater than
73.Dv {NGROUPS_MAX} .
74.It Bq Er EPERM
75The caller is not the superuser.
76.It Bq Er EFAULT
77The address specified for
78.Fa gidset
79is outside the process
80address space.
81.El
82.Sh SEE ALSO
83.Xr getgroups 2 ,
84.Xr initgroups 3
85.Sh HISTORY
86The
87.Fn setgroups
88function call appeared in
89.Bx 4.2 .
90