Return to initgroups.3 CVS log

Up to [cvs.NetBSD.org] / src / lib / libc / gen

Annotation of src/lib/libc/gen/initgroups.3, Revision 1.8.12.1

1.8.12.1! nathanw     1: .\"    $NetBSD: initgroups.3,v 1.8 1999/03/22 19:44:43 garbled Exp $
1.4       cgd         2: .\"
1.3       mycroft     3: .\" Copyright (c) 1983, 1991, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         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. All advertising materials mentioning features or use of this software
                     15: .\"    must display the following acknowledgement:
                     16: .\"    This product includes software developed by the University of
                     17: .\"    California, Berkeley and its contributors.
                     18: .\" 4. Neither the name of the University nor the names of its contributors
                     19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
1.4       cgd        34: .\"     @(#)initgroups.3       8.1 (Berkeley) 6/4/93
1.1       cgd        35: .\"
1.3       mycroft    36: .Dd June 4, 1993
1.1       cgd        37: .Dt INITGROUPS 3
1.8       garbled    38: .Os
1.1       cgd        39: .Sh NAME
                     40: .Nm initgroups
1.5       mycroft    41: .Nd initialize supplementary group IDs
1.7       perry      42: .Sh LIBRARY
                     43: .Lb libc
1.1       cgd        44: .Sh SYNOPSIS
                     45: .Fd #include <unistd.h>
                     46: .Ft int
1.6       jtc        47: .Fn initgroups "const char *name" "gid_t basegid"
1.1       cgd        48: .Sh DESCRIPTION
                     49: The
                     50: .Fn initgroups
                     51: function
1.3       mycroft    52: uses the
                     53: .Xr getgrouplist 3
1.5       mycroft    54: function to calculate the supplementary group IDs for the user
1.1       cgd        55: specified in
                     56: .Fa name .
1.5       mycroft    57: This group list then set up for the current process using
1.3       mycroft    58: .Xr setgroups 2 .
1.1       cgd        59: The
                     60: .Fa basegid
1.5       mycroft    61: is automatically included in the group list.
1.1       cgd        62: Typically this value is given as
                     63: the group number from the password file.
                     64: .Sh RETURN VALUES
                     65: The
                     66: .Fn initgroups
                     67: function
                     68: returns \-1 if it was not invoked by the super-user.
                     69: .Sh SEE ALSO
1.3       mycroft    70: .Xr setgroups 2 ,
                     71: .Xr getgrouplist 3
1.1       cgd        72: .Sh HISTORY
                     73: The
1.5       mycroft    74: .Fn initgroups
1.8.12.1! nathanw    75: function appeared in
1.1       cgd        76: .Bx 4.2 .
                     77: .Sh BUGS
                     78: The
1.3       mycroft    79: .Fn getgrouplist
                     80: function called by
1.5       mycroft    81: .Fn initgroups
1.1       cgd        82: uses the routines based on
                     83: .Xr getgrent 3 .
                     84: If the invoking program uses any of these routines,
                     85: the group structure will
                     86: be overwritten in the call to
                     87: .Fn initgroups .