diff options
Diffstat (limited to 'man3/initgroups.3')
| -rw-r--r-- | man3/initgroups.3 | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/man3/initgroups.3 b/man3/initgroups.3 new file mode 100644 index 000000000..94f76a412 --- /dev/null +++ b/man3/initgroups.3 @@ -0,0 +1,75 @@ +.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) +.\" +.\" Permission is granted to make and distribute verbatim copies of this +.\" manual provided the copyright notice and this permission notice are +.\" preserved on all copies. +.\" +.\" Permission is granted to copy and distribute modified versions of this +.\" manual under the conditions for verbatim copying, provided that the +.\" entire resulting derived work is distributed under the terms of a +.\" permission notice identical to this one. +.\" +.\" Since the Linux kernel and libraries are constantly changing, this +.\" manual page may be incorrect or out-of-date. The author(s) assume no +.\" responsibility for errors or omissions, or for damages resulting from +.\" the use of the information contained herein. The author(s) may not +.\" have taken the same level of care in the production of this manual, +.\" which is licensed free of charge, as they might when working +.\" professionally. +.\" +.\" Formatted or processed versions of this manual, if unaccompanied by +.\" the source, must acknowledge the copyright and authors of this work. +.\" +.\" References consulted: +.\" Linux libc source code +.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) +.\" 386BSD man pages +.\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu> +.\" Modified 2004-10-10 by aeb +.\" +.TH INITGROUPS 3 2004-10-10 "GNU" "Linux Programmer's Manual" +.SH NAME +initgroups \- initialize the supplementary group access list +.SH SYNOPSIS +.nf +.B #include <sys/types.h> +.B #include <grp.h> +.sp +.BI "int initgroups(const char *" user ", gid_t " group ); +.fi +.SH DESCRIPTION +The \fBinitgroups()\fP function initializes the group access list by +reading the group database \fI/etc/group\fP and using all groups of +which \fIuser\fP is a member. The additional group \fIgroup\fP is +also added to the list. + +The +.I user +argument must be non-NULL. +.SH "RETURN VALUE" +The \fBinitgroups()\fP function returns 0 on success, or \-1 if an error +occurs. +.SH ERRORS +.TP +.B ENOMEM +Insufficient memory to allocate group information structure. +.TP +.B EPERM +The calling process has insufficient privilege. See the underlying system call +.BR setgroups (2). +.SH FILES +.nf +\fI/etc/group\fP group database file +.fi +.SH "CONFORMING TO" +SVID 3, BSD 4.3 +.SH NOTES +The prototype for +.B initgroups +is only available if +.B _BSD_SOURCE +is defined (either explicitly, or implicitly, by not defining +_POSIX_SOURCE or compiling with the -ansi flag). +.SH "SEE ALSO" +.BR getgroups (2), +.BR setgroups (2) |