xref: /freebsd/share/man/man9/groupmember.9 (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
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.Dd July 9, 2001
28.Dt GROUPMEMBER 9
29.Os
30.Sh NAME
31.Nm groupmember
32.Nd checks group set for a group ID
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/ucred.h
36.Ft int
37.Fn groupmember "gid_t gid" "struct ucred *cred"
38.Sh DESCRIPTION
39The
40.Fn groupmember
41function checks to see if the given
42.Fa gid
43is in the group set of the credentials.
44.Pp
45Its arguments are:
46.Bl -tag -width ".Fa cred"
47.It Fa gid
48The group ID to check for.
49.It Fa cred
50The credentials to search for the group in.
51.El
52.Sh RETURN VALUES
53If the
54.Fa gid
55is found, 1 is returned; otherwise, 0 is returned.
56.Sh AUTHORS
57This manual page was written by
58.An Chad David Aq Mt davidc@acns.ab.ca .
59