xref: /freebsd/share/man/man9/groupmember.9 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd July 9, 2001
30.Dt GROUPMEMBER 9
31.Os
32.Sh NAME
33.Nm groupmember
34.Nd checks group set for a group ID
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/ucred.h
38.Ft int
39.Fn groupmember "gid_t gid" "struct ucred *cred"
40.Sh DESCRIPTION
41The
42.Fn groupmember
43function checks to see if the given
44.Fa gid
45is in the group set of the credentials.
46.Pp
47Its arguments are:
48.Bl -tag -width ".Fa cred"
49.It Fa gid
50The group ID to check for.
51.It Fa cred
52The credentials to search for the group in.
53.El
54.Sh RETURN VALUES
55If the
56.Fa gid
57is found, 1 is returned; otherwise, 0 is returned.
58.Sh AUTHORS
59This manual page was written by
60.An Chad David Aq davidc@acns.ab.ca .
61