summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/setgid.3p
blob: 5654125108a2b4e3fc26f8e49ad3172676644e79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
'\" et
.TH SETGID "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
setgid
\(em set-group-ID
.SH SYNOPSIS
.LP
.nf
#include <unistd.h>
.P
int setgid(gid_t \fIgid\fP);
.fi
.SH DESCRIPTION
If the process has appropriate privileges,
\fIsetgid\fR()
shall set the real group ID, effective group ID, and the saved
set-group-ID of the calling process to
.IR gid .
.P
If the process does not have appropriate privileges, but
.IR gid
is equal to the real group ID or the saved set-group-ID,
\fIsetgid\fR()
shall set the effective group ID to
.IR gid ;
the real group ID and saved set-group-ID shall remain unchanged.
.P
The
\fIsetgid\fR()
function shall not affect the supplementary group list in any way.
.P
Any supplementary group IDs of the calling process shall remain
unchanged.
.SH "RETURN VALUE"
Upon successful completion, 0 is returned. Otherwise, \-1 shall be
returned and
.IR errno
set to indicate the error.
.SH ERRORS
The
\fIsetgid\fR()
function shall fail if:
.TP
.BR EINVAL
The value of the
.IR gid
argument is invalid and is not supported by the implementation.
.TP
.BR EPERM
The process does not have appropriate privileges and
.IR gid
does not match the real group ID or the saved set-group-ID.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
Refer to the RATIONALE section in
.IR "\fIsetuid\fR\^(\|)".
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIexec\fR\^",
.IR "\fIgetegid\fR\^(\|)",
.IR "\fIgeteuid\fR\^(\|)",
.IR "\fIgetgid\fR\^(\|)",
.IR "\fIgetuid\fR\^(\|)",
.IR "\fIsetegid\fR\^(\|)",
.IR "\fIseteuid\fR\^(\|)",
.IR "\fIsetregid\fR\^(\|)",
.IR "\fIsetreuid\fR\^(\|)",
.IR "\fIsetuid\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<sys_types.h>\fP",
.IR "\fB<unistd.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .