xref: /386bsd/usr/src/lib/libc/sys/setgroups.2 (revision a2142627)
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.\"     @(#)setgroups.2	6.7 (Berkeley) 3/10/91
33.\"
34.Dd March 10, 1991
35.Dt SETGROUPS 2
36.Os BSD 4.2
37.Sh NAME
38.Nm setgroups
39.Nd set group access list
40.Sh SYNOPSIS
41.Fd #include <unistd.h>
42.Fd #include <sys/param.h>
43.Ft int
44.Fn setgroups "int ngroups" "const int *gidset"
45.Sh DESCRIPTION
46.Fn Setgroups
47sets the group access list of the current user process
48according to the array
49.Fa gidset .
50The parameter
51.Fa ngroups
52indicates the number of entries in the array and must be no
53more than
54.Dv NGROUPS ,
55as defined in
56.Ao Pa sys/param.h Ac .
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 EPERM
69The caller is not the super-user.
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 initgroups 3
79.Sh BUGS
80The
81.Fa gidset
82array should be of type
83.Em gid_t ,
84but remains integer for compatibility with earlier systems.
85.Sh HISTORY
86The
87.Nm
88function call appeared in
89.Bx 4.2 .
90