man3/initgroups.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  30 .\" Modified 2004-10-10 by aeb
  31 .\"
  32 .TH INITGROUPS 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  33 .SH NAME
  34 initgroups \- initialize the supplementary group access list
  35 .SH SYNOPSIS
  36 .nf
  37 .B #include <sys/types.h>
  38 .B #include <grp.h>
  39 .PP
  40 .BI "int initgroups(const char *" user ", gid_t " group );
  41 .fi
  42 .PP
  43 .RS -4
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .RE
  47 .PP
  48 .BR initgroups ():
  49 .nf
  50     Since glibc 2.19:
  51         _DEFAULT_SOURCE
  52     Glibc 2.19 and earlier:
  53         _BSD_SOURCE
  54 .fi
  55 .SH DESCRIPTION
  56 The
  57 .BR initgroups ()
  58 function initializes the group access list by
  59 reading the group database
  60 .I /etc/group
  61 and using all groups of
  62 which
  63 .I user
  64 is a member.
  65 The additional group
  66 .I group
  67 is
  68 also added to the list.
  69 .PP
  70 The
  71 .I user
  72 argument must be non-NULL.
  73 .SH RETURN VALUE
  74 The
  75 .BR initgroups ()
  76 function returns 0 on success.
  77 On error, \-1 is returned, and
  78 .I errno
  79 is set to indicate the error.
  80 .SH ERRORS
  81 .TP
  82 .B ENOMEM
  83 Insufficient memory to allocate group information structure.
  84 .TP
  85 .B EPERM
  86 The calling process has insufficient privilege.
  87 See the underlying system call
  88 .BR setgroups (2).
  89 .SH FILES
  90 .TP
  91 .I /etc/group
  92 group database file
  93 .SH ATTRIBUTES
  94 For an explanation of the terms used in this section, see
  95 .BR attributes (7).
  96 .ad l
  97 .nh
  98 .TS
  99 allbox;
 100 lbx lb lb
 101 l l l.
 102 Interface       Attribute       Value
 103 T{
 104 .BR initgroups ()
 105 T}      Thread safety   MT-Safe locale
 106 .TE
 107 .hy
 108 .ad
 109 .sp 1
 110 .SH CONFORMING TO
 111 SVr4, 4.3BSD.
 112 .SH SEE ALSO
 113 .BR getgroups (2),
 114 .BR setgroups (2),
 115 .BR credentials (7)