Libinfo-459.tar.gz

[apple/libinfo.git] / lookup.subproj / getgrouplist.3

diff --git a/lookup.subproj/getgrouplist.3 b/lookup.subproj/getgrouplist.3
index fa62c540537e013b60193579f1c9e302d7df29a3..5f48ab3340123adbf8c253d117260685f33cfa6b 100644 (file)
--- a/lookup.subproj/getgrouplist.3
+++ b/lookup.subproj/getgrouplist.3
@@ -28,14 +28,35 @@
 .\"     @(#)getgrouplist.3     8.1 (Berkeley) 6/9/93
 .\" $FreeBSD: src/lib/libc/gen/getgrouplist.3,v 1.9 2007/01/09 00:27:53 imp Exp $
 .\"
+.\" @APPLE_LICENSE_HEADER_START@
+.\"
+.\" Portions Copyright (c) 2003-2013 Apple Inc.  All Rights Reserved.
+.\"
+.\" This file contains Original Code and/or Modifications of Original Code
+.\" as defined in and that are subject to the Apple Public Source License
+.\" Version 2.0 (the 'License'). You may not use this file except in
+.\" compliance with the License. Please obtain a copy of the License at
+.\" http://www.opensource.apple.com/apsl/ and read it before using this
+.\" file.
+.\"
+.\" The Original Code and all software distributed under the License are
+.\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+.\" Please see the License for the specific language governing rights and
+.\" limitations under the License.
+.\"
+.\" @APPLE_LICENSE_HEADER_END@
+.\"
 .Dd June 9, 1993
 .Dt GETGROUPLIST 3
 .Os
 .Sh NAME
 .Nm getgrouplist
-.Nd calculate group access list
+.Nd calculate partial group access list
 .Sh LIBRARY
-.Lb libc
+Standard system libraries.
 .Sh SYNOPSIS
 .In unistd.h
 .Ft int
@@ -44,14 +65,15 @@
 .Sh DESCRIPTION
 The
 .Fn getgrouplist
-function reads through the group file and calculates
-the group access list for the user specified in
+function obtains information from
+.Xr opendirectoryd 8
+to construct the group access list for the user specified in
 .Fa name .
 The
 .Fa basegid
 is automatically included in the groups list.
 Typically this value is given as
-the group number from the password file.
+the default group number from the user's account record.
 .Pp
 The resulting group list is returned in the array pointed to by
 .Fa groups .
@@ -65,9 +87,12 @@ the actual number of groups found is returned in
 The
 .Fn getgrouplist
 function
-returns \-1 if the size of the group list is too small to
-hold all the user's groups.
-Here, the group array will be filled with as many groups as will fit.
+returns 0 on success.
+If the size of the group list is too small to
+hold all the user's groups,
+.Fn getgrouplist
+returns \-1 to indicate failure.
+In this case, the group array will be filled with as many groups as will fit.
 .Sh FILES
 .Bl -tag -width /etc/group -compact
 .It Pa /etc/group
@@ -75,19 +100,10 @@ group membership list
 .El
 .Sh SEE ALSO
 .Xr setgroups 2 ,
-.Xr initgroups 3
+.Xr initgroups 3 ,
+.Xr opendirectoryd 8 .
 .Sh HISTORY
 The
 .Fn getgrouplist
 function first appeared in
 .Bx 4.4 .
-.Sh BUGS
-The
-.Fn getgrouplist
-function
-uses the routines based on
-.Xr getgrent 3 .
-If the invoking program uses any of these routines,
-the group structure will
-be overwritten in the call to
-.Fn getgrouplist .