Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files. =================================================================== RCS file: /ftp/cvs/cvsroot/src/lib/libc/gen/getgrouplist.3,v rcsdiff: /ftp/cvs/cvsroot/src/lib/libc/gen/getgrouplist.3,v: warning: Unknown phrases like `commitid ...;' are present. retrieving revision 1.5 retrieving revision 1.13.24.1 diff -u -p -r1.5 -r1.13.24.1 --- src/lib/libc/gen/getgrouplist.3 1998/02/05 18:46:41 1.5 +++ src/lib/libc/gen/getgrouplist.3 2008/05/18 12:30:15 1.13.24.1 @@ -1,4 +1,31 @@ -.\" $NetBSD: getgrouplist.3,v 1.5 1998/02/05 18:46:41 perry Exp $ +.\" $NetBSD: getgrouplist.3,v 1.13.24.1 2008/05/18 12:30:15 yamt Exp $ +.\" +.\" Copyright (c) 2005 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Luke Mewburn. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -11,11 +38,7 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. Neither the name of the University nor the names of its contributors +.\" 3. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" @@ -33,45 +56,70 @@ .\" .\" @(#)getgrouplist.3 8.1 (Berkeley) 6/9/93 .\" -.Dd June 9, 1993 +.Dd January 6, 2005 .Dt GETGROUPLIST 3 .Os .Sh NAME -.Nm getgrouplist +.Nm getgrouplist , +.Nm getgroupmembership , .Nd calculate group access list .Sh LIBRARY .Lb libc .Sh SYNOPSIS -.Fd #include +.In unistd.h .Ft int .Fn getgrouplist "const char *name" "gid_t basegid" "gid_t *groups" "int *ngroups" +.Ft int +.Fn getgroupmembership "const char *name" "gid_t basegid" "gid_t *groups" "int maxgrp" "int *ngroups" .Sh DESCRIPTION The .Fn getgrouplist -function reads through the group file and calculates +and +.Fn getgroupmembership +functions read through the group database and calculate 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 group number from the password database. .Pp The resulting group list is returned in the integer array pointed to by .Fa groups . -The caller specifies the size of the +.Pp +For +.Fn getgrouplist , +the caller specifies the size of the .Fa groups array in the integer pointed to by -.Fa ngroups ; -the actual number of groups found is returned in .Fa ngroups . +.Pp +For +.Fn getgroupmembership , +the caller specifies the size of the +.Fa groups +array in +.Fa maxgrp . +.Pp +The actual number of groups found is returned in +.Fa ngroups . +.Pp +Duplicate group ids will be suppressed from the result. .Sh RETURN VALUES The .Fn getgrouplist -function -returns \-1 if the size of the group list is too small to +and +.Fn getgroupmembership +functions +return 0 if successful, and +return \-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. +In the latter case, the +.Fa groups +array will be filled with as many groups as will fit and +.Fa ngroups +will contain the total number of groups found. .Sh FILES .Bl -tag -width /etc/group -compact .It Pa /etc/group @@ -79,12 +127,19 @@ group membership list .El .Sh SEE ALSO .Xr setgroups 2 , -.Xr initgroups 3 +.Xr initgroups 3 , +.Xr group 5 .Sh HISTORY The .Fn getgrouplist function first appeared in .Bx 4.4 . +The +.Fn getgroupmembership +function first appeared in +.Nx 3.0 +to address an API deficiency in +.Fn getgrouplist . .Sh BUGS The .Fn getgrouplist