xnu-1228.7.58.tar.gz

[apple/xnu.git] / bsd / man / man2 / getgroups.2

diff --git a/bsd/man/man2/getgroups.2 b/bsd/man/man2/getgroups.2
index ecc9c82eec74d591f16e65ff12f731cd53f135b6..160022ca3e53c8183745dd5fdbf2d947988b4794 100644 (file)
--- a/bsd/man/man2/getgroups.2
+++ b/bsd/man/man2/getgroups.2
@@ -40,57 +40,71 @@
 .Nm getgroups
 .Nd get group access list
 .Sh SYNOPSIS
 .Nm getgroups
 .Nd get group access list
 .Sh SYNOPSIS

-.Fd #include <sys/param.h>
-.Fd #include <sys/types.h>

 .Fd #include <unistd.h>
 .Ft int
 .Fd #include <unistd.h>
 .Ft int

-.Fn getgroups "int gidsetlen" "gid_t *gidset"
+.Fo getgroups
+.Fa "int gidsetsize"
+.Fa "gid_t grouplist[]"
+.Fc

 .Sh DESCRIPTION
 .Fn Getgroups
 gets the current group access list of the current user process
 and stores it in the array 
 .Sh DESCRIPTION
 .Fn Getgroups
 gets the current group access list of the current user process
 and stores it in the array 

-.Fa gidset .
+.Fa grouplist[] .

 The parameter
 The parameter

-.Fa gidsetlen
+.Fa gidsetsize

 indicates the number of entries that may be placed in 
 indicates the number of entries that may be placed in 

-.Fa gidset .
+.Fa grouplist[] .

 .Fn Getgroups
 returns the actual number of groups returned in
 .Fn Getgroups
 returns the actual number of groups returned in

-.Fa gidset .
+.Fa grouplist[] .

 No more than
 .Dv {NGROUPS_MAX}
 will ever
 be returned.
 If
 No more than
 .Dv {NGROUPS_MAX}
 will ever
 be returned.
 If

-.Fa gidsetlen
+.Fa gidsetsize

 is 0, 
 .Fn getgroups
 returns the number of groups without modifying the
 is 0, 
 .Fn getgroups
 returns the number of groups without modifying the

-.Fa gidset
+.Fa grouplist[]

 array.
 .Sh RETURN VALUES
 A successful call returns the number of groups in the group set.
 array.
 .Sh RETURN VALUES
 A successful call returns the number of groups in the group set.

-A value of -1 indicates that an error occurred, and the error
-code is stored in the global variable
-.Va errno .
+Otherwise, a value of -1 is returned and the global integer variable
+.Va errno
+is set to indicate the error.

 .Sh ERRORS
 The possible errors for
 .Fn getgroups
 are:
 .Bl -tag -width Er
 .Sh ERRORS
 The possible errors for
 .Fn getgroups
 are:
 .Bl -tag -width Er

+.\" ==========
+.It Bq Er EFAULT
+The argument
+.Fa grouplist
+specifies an invalid address.
+.\" ==========

 .It Bq Er EINVAL
 The argument
 .It Bq Er EINVAL
 The argument

-.Fa gidsetlen
+.Fa gidsetsize ,
+although non-zero,

 is smaller than the number of groups in the group set.
 is smaller than the number of groups in the group set.

-.It Bq Er EFAULT
-The argument
-.Fa gidset
-specifies
-an invalid address.

 .El
 .El

+.Sh LEGACY SYNOPSIS
+.Fd #include <sys/param.h>
+.Fd #include <sys/types.h>
+.Fd #include <unistd.h>
+.Pp
+The include files
+.In sys/param.h
+and
+.In sys/types.h
+are necessary.

 .Sh SEE ALSO
 .Xr setgroups 2 ,
 .Sh SEE ALSO
 .Xr setgroups 2 ,

-.Xr initgroups 3
+.Xr initgroups 3 ,
+.Xr compat 5

 .Sh HISTORY
 The
 .Fn getgroups
 .Sh HISTORY
 The
 .Fn getgroups