xref: /386bsd/usr/src/lib/libc/sys/setpgid.2 (revision a2142627)
1.\" Copyright (c) 1980, 1991 Regents of the University of California.
2.\" 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	6.3 (Berkeley) 3/10/91
33.\"
34.Dd March 10, 1991
35.Dt SETPGRP 2
36.Os BSD 4
37.Sh NAME
38.Nm setpgid ,
39.Nm setpgrp
40.Nd set process group
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft int
44.Fn setpgid pid_tpid pid_tpgrp
45.Ft int
46.Fn setpgrp pid_tpid pid_tpgrp
47.Sh DESCRIPTION
48.Fn Setpgid
49sets the process group of the specified process
50.Ar pid
51to the specified
52.Ar pgrp .
53If
54.Ar pid
55is zero, then the call applies to the current process.
56.Pp
57If the invoker is not the super-user, then the affected process
58must have the same effective user-id as the invoker or be a descendant
59of the invoking process.
60.Sh RETURN VALUES
61.Fn Setpgid
62returns 0 when the operation was successful.
63If the request failed, -1 is returned and the global variable
64.Va errno
65indicates the reason.
66.Sh ERRORS
67.Fn Setpgid
68will fail and the process group will not be altered if:
69.Bl -tag -width indent
70.It Bq Er ESRCH
71The requested process does not exist.
72.It Bq Er EPERM
73The effective user ID of the requested process is different
74from that of the caller and the process is not a descendent
75of the calling process.
76.El
77.Sh SEE ALSO
78.Xr getpgrp 2
79.Sh STANDARDS
80.Fn Setpgid
81conforms to IEEE Std 1003.1-1988
82.Pq Dq Tn POSIX .
83.Sh COMPATIBILITY
84.Fn Setpgrp
85is identical to
86.Fn setpgid ,
87and is retained for calling convention compatibility with historical
88versions of
89.Bx .
90