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