xref: /dragonfly/lib/libc/sys/getgid.2 (revision 0cfebe3d)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  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, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)getgid.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libc/sys/getgid.2,v 1.8.2.4 2001/12/14 18:34:00 ru Exp $
34.\" $DragonFly: src/lib/libc/sys/getgid.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
35.\"
36.Dd June 4, 1993
37.Dt GETGID 2
38.Os
39.Sh NAME
40.Nm getgid ,
41.Nm getegid
42.Nd get group process identification
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In sys/types.h
47.In unistd.h
48.Ft gid_t
49.Fn getgid void
50.Ft gid_t
51.Fn getegid void
52.Sh DESCRIPTION
53The
54.Fn getgid
55function returns the real group ID of the calling process,
56.Fn getegid
57returns the effective group ID of the calling process.
58.Pp
59The real group ID is specified at login time.
60.Pp
61The real group ID is the group of the user who invoked the program.
62As the effective group ID gives the process additional permissions
63during the execution of
64.Dq Em set-group-ID
65mode processes,
66.Fn getgid
67is used to determine the real-user-id of the calling process.
68.Sh ERRORS
69The
70.Fn getgid
71and
72.Fn getegid
73functions are always successful, and no return value is reserved to
74indicate an error.
75.Sh SEE ALSO
76.Xr getuid 2 ,
77.Xr issetugid 2 ,
78.Xr setgid 2 ,
79.Xr setregid 2
80.Sh STANDARDS
81The
82.Fn getgid
83and
84.Fn getegid
85function calls are expected to conform to
86.St -p1003.1-90 .
87