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