lib/libc/sys/setgroups.2

   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. 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 8.2 (Berkeley) 4/16/94
  33 .\" $FreeBSD: src/lib/libc/sys/setgroups.2,v 1.4.2.4 2001/12/14 18:34:01 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/setgroups.2,v 1.3 2006/05/26 19:39:37 swildner Exp $
  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 .In sys/param.h
  46 .In unistd.h
  47 .Ft int
  48 .Fn setgroups "int ngroups" "const gid_t *gidset"
  49 .Sh DESCRIPTION
  50 .Fn Setgroups
  51 sets the group access list of the current user process
  52 according to the array
  53 .Fa gidset .
  54 The parameter
  55 .Fa ngroups
  56 indicates the number of entries in the array and must be no
  57 more than
  58 .Dv NGROUPS ,
  59 as defined in
  60 .In sys/param.h .
  61 .Pp
  62 Only the super-user may set new groups.
  63 .Sh RETURN VALUES
  64 .Rv -std setgroups
  65 .Sh ERRORS
  66 The
  67 .Fn setgroups
  68 call will fail if:
  69 .Bl -tag -width Er
  70 .It Bq Er EPERM
  71 The caller is not the super-user.
  72 .It Bq Er EFAULT
  73 The address specified for
  74 .Fa gidset
  75 is outside the process
  76 address space.
  77 .El
  78 .Sh SEE ALSO
  79 .Xr getgroups 2 ,
  80 .Xr initgroups 3
  81 .Sh HISTORY
  82 The
  83 .Fn setgroups
  84 function call appeared in
  85 .Bx 4.2 .