xref: /freebsd/lib/libc/gen/initgroups.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
158f0484fSRodney W. Grimes.\" Copyright (c) 1983, 1991, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
658f0484fSRodney W. Grimes.\" are met:
758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
858f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1058f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1158f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
12*fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
1358f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1458f0484fSRodney W. Grimes.\"    without specific prior written permission.
1558f0484fSRodney W. Grimes.\"
1658f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1758f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1858f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1958f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2058f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2158f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2258f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2358f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2458f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2558f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2658f0484fSRodney W. Grimes.\" SUCH DAMAGE.
2758f0484fSRodney W. Grimes.\"
2820cc9ac4SMark Johnston.Dd October 26, 2014
2958f0484fSRodney W. Grimes.Dt INITGROUPS 3
30a307d598SRuslan Ermilov.Os
3158f0484fSRodney W. Grimes.Sh NAME
3258f0484fSRodney W. Grimes.Nm initgroups
3358f0484fSRodney W. Grimes.Nd initialize group access list
3425bb73e0SAlexey Zelkin.Sh LIBRARY
3525bb73e0SAlexey Zelkin.Lb libc
3658f0484fSRodney W. Grimes.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In unistd.h
3858f0484fSRodney W. Grimes.Ft int
395567b258SMark Murray.Fn initgroups "const char *name" "gid_t basegid"
4058f0484fSRodney W. Grimes.Sh DESCRIPTION
4158f0484fSRodney W. GrimesThe
4258f0484fSRodney W. Grimes.Fn initgroups
4358f0484fSRodney W. Grimesfunction
4458f0484fSRodney W. Grimesuses the
4558f0484fSRodney W. Grimes.Xr getgrouplist 3
4658f0484fSRodney W. Grimesfunction to calculate the group access list for the user
4758f0484fSRodney W. Grimesspecified in
4858f0484fSRodney W. Grimes.Fa name .
4958f0484fSRodney W. GrimesThis group list is then setup for the current process using
5058f0484fSRodney W. Grimes.Xr setgroups 2 .
5158f0484fSRodney W. GrimesThe
5258f0484fSRodney W. Grimes.Fa basegid
5358f0484fSRodney W. Grimesis automatically included in the groups list.
5458f0484fSRodney W. GrimesTypically this value is given as
5558f0484fSRodney W. Grimesthe group number from the password file.
5658f0484fSRodney W. Grimes.Sh RETURN VALUES
577d3346caSAnton Berezin.Rv -std initgroups
587d3346caSAnton Berezin.Sh ERRORS
5958f0484fSRodney W. GrimesThe
6058f0484fSRodney W. Grimes.Fn initgroups
617d3346caSAnton Berezinfunction may fail and set
627d3346caSAnton Berezin.Va errno
637d3346caSAnton Berezinfor any of the errors specified for the library function
647d3346caSAnton Berezin.Xr setgroups 2 .
6554404cfbSBrooks DavisIt may also return:
6654404cfbSBrooks Davis.Bl -tag -width Er
6754404cfbSBrooks Davis.It Bq Er ENOMEM
6854404cfbSBrooks DavisThe
6954404cfbSBrooks Davis.Fn initgroups
7054404cfbSBrooks Davisfunction was unable to allocate temporary storage.
7154404cfbSBrooks Davis.El
7258f0484fSRodney W. Grimes.Sh SEE ALSO
7358f0484fSRodney W. Grimes.Xr setgroups 2 ,
7458f0484fSRodney W. Grimes.Xr getgrouplist 3
7558f0484fSRodney W. Grimes.Sh HISTORY
7658f0484fSRodney W. GrimesThe
77b8dd5117SDavid Nugent.Fn initgroups
7858f0484fSRodney W. Grimesfunction appeared in
7958f0484fSRodney W. Grimes.Bx 4.2 .
80