xref: /netbsd-src/lib/libc/sys/setpgid.2 (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1.\"	$NetBSD: setpgid.2,v 1.16 2002/02/08 01:28:22 ross Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)setpgid.2	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt SETPGID 2
38.Os
39.Sh NAME
40.Nm setpgid ,
41.Nm setpgrp
42.Nd set process group
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.Fd #include \*[Lt]unistd.h\*[Gt]
47.Ft int
48.Fn setpgid "pid_t pid" "pid_t pgrp"
49.Ft int
50.Fn setpgrp "pid_t pid" "pid_t pgrp"
51.Sh DESCRIPTION
52.Fn setpgid
53sets the process group of the specified process
54.Ar pid
55to the specified
56.Ar pgrp .
57If
58.Ar pid
59is zero, then the call applies to the current process.
60.Pp
61If the invoker is not the super-user, then the affected process
62must have the same effective user-id as the invoker or be a descendant
63of the invoking process.
64.Sh RETURN VALUES
65.Fn setpgid
66returns 0 when the operation was successful.
67If the request failed, -1 is returned and the global variable
68.Va errno
69indicates the reason.
70.Sh ERRORS
71.Fn setpgid
72will fail and the process group will not be altered if:
73.Bl -tag -width Er
74.It Bq Er EACCES
75The value of the
76.Fa pid
77argument matches the process ID of a child process of the calling process,
78and the child process has successfully executed one of the exec functions.
79.It Bq Er EINVAL
80The value of the
81.Fa pgrp
82argument is less than zero.
83.It Bq Er EPERM
84The effective user ID of the requested process is different
85from that of the caller and the process is not a descendant
86of the calling process.
87.It Bq Er ESRCH
88The value of the
89.Fa pid
90argument does not match the process ID of the calling process or of a
91child process of the calling process.
92.El
93.Sh SEE ALSO
94.Xr getpgrp 2
95.Sh STANDARDS
96The
97.Fn setpgid
98function conforms to
99.St -p1003.1-90 .
100.Sh COMPATIBILITY
101.Fn setpgrp
102is identical to
103.Fn setpgid ,
104and is retained for calling convention compatibility with historical
105versions of
106.Bx .
107