lib/libc/gen/initgroups.3

   1 .\"     $NetBSD: initgroups.3,v 1.14 2003/05/01 13:58:03 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)initgroups.3        8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd August 10, 2002
  33 .Dt INITGROUPS 3
  34 .Os
  35 .Sh NAME
  36 .Nm initgroups
  37 .Nd initialize supplementary group IDs
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft int
  43 .Fn initgroups "const char *name" "gid_t basegid"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn initgroups
  47 function
  48 uses the
  49 .Xr getgrouplist 3
  50 function to calculate the supplementary group IDs for the user
  51 specified in
  52 .Fa name .
  53 This group list is then set up for the current process using
  54 .Xr setgroups 2 .
  55 The
  56 .Fa basegid
  57 is automatically included in the group list.
  58 Typically this value is given as
  59 the group number from the password file.
  60 .Pp
  61 If the groups database lists more than
  62 .Ev NGROUPS
  63 groups for
  64 .Fa name
  65 (including one for
  66 .Fa basegid ) ,
  67 the later groups are ignored.
  68 .Sh RETURN VALUES
  69 The
  70 .Fn initgroups
  71 function
  72 returns \-1 if it was not invoked by the super-user.
  73 .Sh SEE ALSO
  74 .Xr setgroups 2 ,
  75 .Xr getgrouplist 3
  76 .Sh HISTORY
  77 The
  78 .Fn initgroups
  79 function appeared in
  80 .Bx 4.2 .
  81 .Sh BUGS
  82 The
  83 .Fn getgrouplist
  84 function called by
  85 .Fn initgroups
  86 uses the routines based on
  87 .Xr getgrent 3 .
  88 If the invoking program uses any of these routines,
  89 the group structure will
  90 be overwritten in the call to
  91 .Fn initgroups .