lib/libc/gen/getgrouplist.3

   1 .\" Copyright (c) 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 .\"     @(#)getgrouplist.3      8.1 (Berkeley) 6/9/93
  29 .\"
  30 .Dd October 26, 2014
  31 .Dt GETGROUPLIST 3
  32 .Os
  33 .Sh NAME
  34 .Nm getgrouplist
  35 .Nd calculate group access list
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In unistd.h
  40 .Ft int
  41 .Fn getgrouplist "const char *name" "gid_t basegid" "gid_t *groups" "int *ngroups"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn getgrouplist
  45 function reads through the group file and calculates
  46 the group access list for the user specified in
  47 .Fa name .
  48 The
  49 .Fa basegid
  50 is automatically included in the groups list.
  51 Typically this value is given as
  52 the group number from the password file.
  53 .Pp
  54 The resulting group list is returned in the array pointed to by
  55 .Fa groups .
  56 The caller specifies the size of the
  57 .Fa groups
  58 array in the integer pointed to by
  59 .Fa ngroups ;
  60 the actual number of groups found is returned in
  61 .Fa ngroups .
  62 .Sh RETURN VALUES
  63 The
  64 .Fn getgrouplist
  65 function
  66 returns 0 on success and \-1 if the size of the group list is too small to
  67 hold all the user's groups.
  68 Here, the group array will be filled with as many groups as will fit.
  69 .Sh FILES
  70 .Bl -tag -width /etc/group -compact
  71 .It Pa /etc/group
  72 group membership list
  73 .El
  74 .Sh SEE ALSO
  75 .Xr setgroups 2 ,
  76 .Xr initgroups 3
  77 .Sh HISTORY
  78 The
  79 .Fn getgrouplist
  80 function first appeared in
  81 .Bx 4.4 .