lib/libc/gen/initgroups.3

   1 .\" Copyright (c) 1983, 1991, 1993
   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 .\"     @(#)initgroups.3        8.1 (Berkeley) 6/4/93
  29 .\"
  30 .Dd October 26, 2014
  31 .Dt INITGROUPS 3
  32 .Os
  33 .Sh NAME
  34 .Nm initgroups
  35 .Nd initialize group access list
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In unistd.h
  40 .Ft int
  41 .Fn initgroups "const char *name" "gid_t basegid"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn initgroups
  45 function
  46 uses the
  47 .Xr getgrouplist 3
  48 function to calculate the group access list for the user
  49 specified in
  50 .Fa name .
  51 This group list is then setup for the current process using
  52 .Xr setgroups 2 .
  53 The
  54 .Fa basegid
  55 is automatically included in the groups list.
  56 Typically this value is given as
  57 the group number from the password file.
  58 .Sh RETURN VALUES
  59 .Rv -std initgroups
  60 .Sh ERRORS
  61 The
  62 .Fn initgroups
  63 function may fail and set
  64 .Va errno
  65 for any of the errors specified for the library function
  66 .Xr setgroups 2 .
  67 It may also return:
  68 .Bl -tag -width Er
  69 .It Bq Er ENOMEM
  70 The
  71 .Fn initgroups
  72 function was unable to allocate temporary storage.
  73 .El
  74 .Sh SEE ALSO
  75 .Xr setgroups 2 ,
  76 .Xr getgrouplist 3
  77 .Sh HISTORY
  78 The
  79 .Fn initgroups
  80 function appeared in
  81 .Bx 4.2 .