xref: /minix3/lib/libc/sys/setpgid.2 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1.\"	$NetBSD: setpgid.2,v 1.23 2014/09/19 16:02:58 wiz 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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     @(#)setpgid.2	8.1 (Berkeley) 6/4/93
31.\"
32.Dd December 18, 2003
33.Dt SETPGID 2
34.Os
35.Sh NAME
36.Nm setpgid ,
37.Nm setpgrp
38.Nd set process group
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
42.In unistd.h
43.Ft int
44.Fn setpgid "pid_t pid" "pid_t pgrp"
45.Ft int
46.Fn setpgrp "pid_t pid" "pid_t pgrp"
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.
56If
57.Ar pgrp
58is zero, then the process id of the process specified by
59.Ar pid
60is used instead.
61.Pp
62If the invoker is not the super-user, then the affected process
63must have the same effective user-id as the invoker or be a descendant
64of the invoking process.
65.Sh RETURN VALUES
66.Fn setpgid
67returns 0 when the operation was successful.
68If the request failed, \-1 is returned and the global variable
69.Va errno
70indicates the reason.
71.Sh COMPATIBILITY
72.Fn setpgrp
73is identical to
74.Fn setpgid ,
75and is retained for calling convention compatibility with historical
76versions of
77.Bx .
78.Sh ERRORS
79.Fn setpgid
80will fail and the process group will not be altered if:
81.Bl -tag -width Er
82.It Bq Er EACCES
83The value of the
84.Fa pid
85argument matches the process ID of a child process of the calling process,
86and the child process has successfully executed one of the exec functions.
87.It Bq Er EINVAL
88The value of the
89.Fa pgrp
90argument is less than zero.
91.It Bq Er EPERM
92The effective user ID of the requested process is different
93from that of the caller and the process is not a descendant
94of the calling process.
95.It Bq Er ESRCH
96The value of the
97.Fa pid
98argument does not match the process ID of the calling process or of a
99child process of the calling process.
100.El
101.Sh SEE ALSO
102.Xr getpgrp 2
103.Sh STANDARDS
104The
105.Fn setpgid
106function conforms to
107.St -p1003.1-90 .
108