xref: /netbsd-src/lib/libc/sys/setpgid.2 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
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.\"     from: @(#)setpgid.2	6.3 (Berkeley) 3/10/91
33.\"	$Id: setpgid.2,v 1.7 1994/05/02 23:54:59 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt SETPGRP 2
37.Os BSD 4
38.Sh NAME
39.Nm setpgid ,
40.Nm setpgrp
41.Nd set process group
42.Sh SYNOPSIS
43.Fd #include <unistd.h>
44.Ft int
45.Fn setpgid "pid_t pid" "pid_t pgrp"
46.Ft int
47.Fn setpgrp "pid_t pid" "pid_t pgrp"
48.Sh DESCRIPTION
49.Fn Setpgid
50sets the process group of the specified process
51.Ar pid
52to the specified
53.Ar pgrp .
54If
55.Ar pid
56is zero, then the call applies to the current process.
57.Pp
58If the invoker is not the super-user, then the affected process
59must have the same effective user-id as the invoker or be a descendant
60of the invoking process.
61.Sh RETURN VALUES
62.Fn Setpgid
63returns 0 when the operation was successful.
64If the request failed, -1 is returned and the global variable
65.Va errno
66indicates the reason.
67.Sh ERRORS
68.Fn Setpgid
69will fail and the process group will not be altered if:
70.Bl -tag -width Er
71.It Bq Er EACCESS
72The value of the
73.Fa pid
74argument matches the process ID of a child process of the calling process,
75and the child process has successfully executed one of the exec functions.
76.It Bq Er EPERM
77The effective user ID of the requested process is different
78from that of the caller and the process is not a descendant
79of the calling process.
80.It Bq Er ESRCH
81The value of the
82.Fa pid
83argument does not match the process ID of the calling process or of a
84child process of the calling process.
85.El
86.Sh SEE ALSO
87.Xr getpgrp 2
88.Sh STANDARDS
89The
90.Fn setpgid
91function conforms to
92.St -p1003.1-88 .
93.Sh COMPATIBILITY
94.Fn Setpgrp
95is identical to
96.Fn setpgid ,
97and is retained for calling convention compatibility with historical
98versions of
99.Bx .
100