Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / sys / getgid.2
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 .\"
35 .Dd June 4, 1993
36 .Dt GETGID 2
37 .Os
38 .Sh NAME
39 .Nm getgid ,
40 .Nm getegid
41 .Nd get group process identification
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In sys/types.h
46 .In unistd.h
47 .Ft gid_t
48 .Fn getgid void
49 .Ft gid_t
50 .Fn getegid void
51 .Sh DESCRIPTION
52 The
53 .Fn getgid
54 function returns the real group ID of the calling process,
55 .Fn getegid
56 returns the effective group ID of the calling process.
57 .Pp
58 The real group ID is specified at login time.
59 .Pp
60 The real group ID is the group of the user who invoked the program.
61 As the effective group ID gives the process additional permissions
62 during the execution of
63 .Dq Em set-group-ID
64 mode processes,
65 .Fn getgid
66 is used to determine the real-user-id of the calling process.
67 .Sh ERRORS
68 The
69 .Fn getgid
70 and
71 .Fn getegid
72 functions are always successful, and no return value is reserved to
73 indicate an error.
74 .Sh SEE ALSO
75 .Xr getuid 2 ,
76 .Xr issetugid 2 ,
77 .Xr setgid 2 ,
78 .Xr setregid 2
79 .Sh STANDARDS
80 The
81 .Fn getgid
82 and
83 .Fn getegid
84 function calls are expected to conform to
85 .St -p1003.1-90 .