BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / setgroups.2

diff --git a/usr/src/lib/libc/sys/setgroups.2 b/usr/src/lib/libc/sys/setgroups.2
index cdc8e6a..e29041b 100644 (file)
--- a/usr/src/lib/libc/sys/setgroups.2
+++ b/usr/src/lib/libc/sys/setgroups.2
@@ -1,64 +1,89 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.
+.\" 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
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)setgroups.2 6.6 (Berkeley) 6/23/90
+.\" 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.

 .\"
 .\"

-.TH SETGROUPS 2 "June 23, 1990"
-.UC 5
-.SH NAME
-setgroups \- set group access list
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/param.h>
-.PP
-.ft B
-setgroups(ngroups, gidset)
-int ngroups, *gidset;
-.fi
-.SH DESCRIPTION
-.I Setgroups
+.\"     @(#)setgroups.2        6.7 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt SETGROUPS 2
+.Os BSD 4.2
+.Sh NAME
+.Nm setgroups
+.Nd set group access list
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Fd #include <sys/param.h>
+.Ft int
+.Fn setgroups "int ngroups" "const int *gidset"
+.Sh DESCRIPTION
+.Fn Setgroups

 sets the group access list of the current user process
 according to the array 
 sets the group access list of the current user process
 according to the array 

-.IR gidset .
+.Fa gidset .

 The parameter
 The parameter

-.I ngroups
+.Fa ngroups

 indicates the number of entries in the array and must be no
 indicates the number of entries in the array and must be no

-more than NGROUPS, as defined in
-.RI < sys/param.h >.
-.PP
+more than
+.Dv NGROUPS ,
+as defined in
+.Ao Pa sys/param.h Ac .
+.Pp

 Only the super-user may set new groups.
 Only the super-user may set new groups.

-.SH "RETURN VALUE
-A 0 value is returned on success, \-1 on error, with
-a error code stored in \fIerrno\fP.
-.SH "ERRORS
-The \fIsetgroups\fP call will fail if:
-.TP 15
-[EPERM]
+.Sh RETURN VALUES
+A 0 value is returned on success, -1 on error, with
+an error code stored in
+.Va errno .
+.Sh ERRORS
+The
+.Fn setgroups
+call will fail if:
+.Bl -tag -width Er
+.It Bq Er EPERM

 The caller is not the super-user.
 The caller is not the super-user.

-.TP 15
-[EFAULT]
-The address specified for \fIgidset\fP is outside the process
+.It Bq Er EFAULT
+The address specified for
+.Fa gidset
+is outside the process

 address space.
 address space.

-.SH "SEE ALSO
-getgroups(2), initgroups(3)
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr getgroups 2 ,
+.Xr initgroups 3
+.Sh BUGS

 The
 The

-.I gidset
+.Fa gidset

 array should be of type
 array should be of type

-.BR gid_t ,
+.Em gid_t ,

 but remains integer for compatibility with earlier systems.
 but remains integer for compatibility with earlier systems.

+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .