Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NetBSD/lib/libc/sys/getgroups.2

104 lines
3.1 KiB
Groff
Raw Normal View History

Sort SEE ALSO.
2006-10-14 00:51:28 +04:00
.\" $NetBSD: getgroups.2,v 1.22 2006/10/13 20:51:28 wiz Exp $
merge with lite, keeping most local changes. clean up Ids
1995-02-27 15:31:34 +03:00
.\"
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\"
.\" 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.
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself.
2003-08-07 20:42:00 +04:00
.\" 3. Neither the name of the University nor the names of its contributors
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
.\"
merge with lite, keeping most local changes. clean up Ids
1995-02-27 15:31:34 +03:00
.\" @(#)getgroups.2 8.2 (Berkeley) 4/16/94
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.\"
PR/23152: Matthew Mondor: Minor improvements to section 2 man pages for NetBSD 1.6.1 Well we're long gone from NetBSD 1.6.1 but I adapted the patch to -current as it seemed reasonable. Thanks for submitting!
2006-10-08 01:03:51 +04:00
.Dd October 7, 2006
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Dt GETGROUPS 2
Last of the .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Wheee!
1999-03-22 22:44:33 +03:00
.Os
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Sh NAME
.Nm getgroups
.Nd get group access list
Add a LIBRARY section to system call manual pages. While it's clear that the libraries contain stubs only (with minor exceptions a la pipe(2)), the purpose of this section is to provide linkage information.
1999-12-03 00:42:35 +03:00
.Sh LIBRARY
.Lb libc
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Sh SYNOPSIS
Use .In header.h instead of .Fd #include \*[Lt]header.h\*[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross.
2003-04-16 17:34:34 +04:00
.In unistd.h
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Ft int
Last weekend's gid_t changes allow us to change the gidset argument of getgroups() and setgroups() from a int ptr to a gid_t ptr.
1994-03-29 06:46:29 +04:00
.Fn getgroups "int gidsetlen" "gid_t *gidset"
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Sh DESCRIPTION
first pass at fixing up capitalization of function names and arguments; ensure that each is correct with respect to the implementation, rather than being correct as per english.
1998-08-29 12:32:32 +04:00
.Fn getgroups
Describe special case when gidsetlen == 0. NGROUPS -> NGROUPS_MAX.
1994-04-16 02:44:06 +04:00
gets the current group access list of the current user process
Boring whitespace fixes.
2001-09-16 05:38:59 +04:00
and stores it in the array
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Fa gidset .
The parameter
.Fa gidsetlen
Boring whitespace fixes.
2001-09-16 05:38:59 +04:00
indicates the number of entries that may be placed in
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Fa gidset .
first pass at fixing up capitalization of function names and arguments; ensure that each is correct with respect to the implementation, rather than being correct as per english.
1998-08-29 12:32:32 +04:00
.Fn getgroups
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
returns the actual number of groups returned in
.Fa gidset .
No more than
Add curly braces around NGROUPS_MAX. This convention is used in manpages for other UN*X systems to refer to system values (availiable via sysconf() or pathconf()) rather than definitions in <limits.h>.
1994-04-19 04:09:04 +04:00
.Dv {NGROUPS_MAX}
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
will ever
be returned.
Describe special case when gidsetlen == 0. NGROUPS -> NGROUPS_MAX.
1994-04-16 02:44:06 +04:00
If
.Fa gidsetlen
Boring whitespace fixes.
2001-09-16 05:38:59 +04:00
is 0,
Describe special case when gidsetlen == 0. NGROUPS -> NGROUPS_MAX.
1994-04-16 02:44:06 +04:00
.Fn getgroups
returns the number of groups without modifying the
.Fa gidset
array.
PR/23152: Matthew Mondor: Minor improvements to section 2 man pages for NetBSD 1.6.1 Well we're long gone from NetBSD 1.6.1 but I adapted the patch to -current as it seemed reasonable. Thanks for submitting!
2006-10-08 01:03:51 +04:00
.Pp
This system call only returns the secondary groups.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Sh RETURN VALUES
A successful call returns the number of groups in the group set.
\- is a minus, not -.
2004-05-13 14:20:57 +04:00
A value of \-1 indicates that an error occurred, and the error
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
code is stored in the global variable
.Va errno .
.Sh ERRORS
The possible errors for
.Fn getgroups
are:
.Bl -tag -width Er
.It Bq Er EINVAL
The argument
.Fa gidsetlen
Remove the inclusion of <sys/param.h> from SYNOPSIS: it is neither necessary nor mandated by the standard.
1998-02-16 18:35:07 +03:00
is non-zero and is smaller than the number of groups in the group set.
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.It Bq Er EFAULT
The argument
.Fa gidset
specifies
an invalid address.
.El
.Sh SEE ALSO
PR/23152: Matthew Mondor: Minor improvements to section 2 man pages for NetBSD 1.6.1 Well we're long gone from NetBSD 1.6.1 but I adapted the patch to -current as it seemed reasonable. Thanks for submitting!
2006-10-08 01:03:51 +04:00
.Xr getegid 2 ,
Sort SEE ALSO.
2006-10-14 00:51:28 +04:00
.Xr getgid 2 ,
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Xr setgroups 2 ,
.Xr initgroups 3
Add missing `STANDARDS' compliance statements. As we #define _POSIX_VERSION to 199009L, bump existing statements to 1003.1-1990.
1997-07-15 03:19:39 +04:00
.Sh STANDARDS
The
.Fn getgroups
function conforms to
.St -p1003.1-90 .
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
.Sh HISTORY
The
Clean up manpages: Use .Fn rather than .Nm macro in HISTORY and STANDARDS sections. Use .At and .St macros instead of spelling out "Version 6 UNIX", "IEEE 1003.1-1988 (POSIX)", etc.
1993-11-25 03:38:17 +03:00
.Fn getgroups
initial import of 386bsd-0.1 sources
1993-03-21 12:45:37 +03:00
function call appeared in
.Bx 4.2 .