xref: /dragonfly/lib/libc/sys/setgroups.2 (revision 73610d44)
1.\" Copyright (c) 1983, 1991, 1993, 1994
2.\"	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)setgroups.2	8.2 (Berkeley) 4/16/94
29.\" $FreeBSD: src/lib/libc/sys/setgroups.2,v 1.4.2.4 2001/12/14 18:34:01 ru Exp $
30.\" $DragonFly: src/lib/libc/sys/setgroups.2,v 1.3 2006/05/26 19:39:37 swildner Exp $
31.\"
32.Dd April 16, 1994
33.Dt SETGROUPS 2
34.Os
35.Sh NAME
36.Nm setgroups
37.Nd set group access list
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In sys/param.h
42.In unistd.h
43.Ft int
44.Fn setgroups "int ngroups" "const gid_t *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.In sys/param.h .
57.Pp
58Only the super-user may set new groups.
59.Sh RETURN VALUES
60.Rv -std setgroups
61.Sh ERRORS
62The
63.Fn setgroups
64call will fail if:
65.Bl -tag -width Er
66.It Bq Er EPERM
67The caller is not the super-user.
68.It Bq Er EFAULT
69The address specified for
70.Fa gidset
71is outside the process
72address space.
73.El
74.Sh SEE ALSO
75.Xr getgroups 2 ,
76.Xr initgroups 3
77.Sh HISTORY
78The
79.Fn setgroups
80function call appeared in
81.Bx 4.2 .
82