xref: /freebsd-14.2/lib/libc/sys/setpgid.2 (revision fffcbbcd)
1.\" Copyright (c) 1980, 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.\"     @(#)setpgid.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd June 4, 1993
36.Dt SETPGID 2
37.Os
38.Sh NAME
39.Nm setpgid ,
40.Nm setpgrp
41.Nd set process group
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include <unistd.h>
46.Ft int
47.Fn setpgid "pid_t pid" "pid_t pgrp"
48.Ft int
49.Fn setpgrp "pid_t pid" "pid_t pgrp"
50.Sh DESCRIPTION
51.Fn Setpgid
52sets the process group of the specified process
53.Fa pid
54to the specified
55.Fa pgrp .
56If
57.Fa pid
58is zero, then the call applies to the current process.
59.Pp
60If the invoker is not the super-user, then the affected process
61must have the same effective user-id as the invoker or be a descendant
62of the invoking process.
63.Sh RETURN VALUES
64.Fn Setpgid
65returns 0 when the operation was successful.
66If the request failed, -1 is returned and the global variable
67.Va errno
68indicates the reason.
69.Sh ERRORS
70.Fn Setpgid
71will fail and the process group will not be altered if:
72.Bl -tag -width Er
73.It Bq Er ESRCH
74The requested process does not exist.
75.It Bq Er EPERM
76The effective user ID of the requested process is different
77from that of the caller and the process is not a descendent
78of the calling process.
79.El
80.Sh SEE ALSO
81.Xr getpgrp 2
82.Sh STANDARDS
83The
84.Fn setpgid
85function call is expected to conform to
86.St -p1003.1-90 .
87.Sh COMPATIBILITY
88.Fn Setpgrp
89is identical to
90.Fn setpgid ,
91and is retained for calling convention compatibility with historical
92versions of
93.Bx .
94