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 .\"
  35 .Dd April 16, 1994
  36 .Dt SETGROUPS 2
  37 .Os
  38 .Sh NAME
  39 .Nm setgroups
  40 .Nd set group access list
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/param.h
  45 .In unistd.h
  46 .Ft int
  47 .Fn setgroups "int ngroups" "const gid_t *gidset"
  48 .Sh DESCRIPTION
  49 .Fn Setgroups
  50 sets the group access list of the current user process
  51 according to the array
  52 .Fa gidset .
  53 The parameter
  54 .Fa ngroups
  55 indicates the number of entries in the array and must be no
  56 more than
  57 .Dv NGROUPS ,
  58 as defined in
  59 .Ao Pa sys/param.h Ac .
  60 .Pp
  61 Only the super-user may set new groups.
  62 .Sh RETURN VALUES
  63 .Rv -std setgroups
  64 .Sh ERRORS
  65 The
  66 .Fn setgroups
  67 call will fail if:
  68 .Bl -tag -width Er
  69 .It Bq Er EPERM
  70 The caller is not the super-user.
  71 .It Bq Er EFAULT
  72 The address specified for
  73 .Fa gidset
  74 is outside the process
  75 address space.
  76 .El
  77 .Sh SEE ALSO
  78 .Xr getgroups 2 ,
  79 .Xr initgroups 3
  80 .Sh HISTORY
  81 The
  82 .Fn setgroups
  83 function call appeared in
  84 .Bx 4.2 .