Commit | Line | Data |
---|---|---|
15715acc KB |
1 | .\" Copyright (c) 1980, 1991, 1993 |
2 | .\" The Regents of the University of California. All rights reserved. | |
3ebb09da | 3 | .\" |
c0567266 KB |
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. | |
931b8415 | 31 | .\" |
ad787160 C |
32 | .\" @(#)setpgid.2 8.1 (Berkeley) 6/4/93 |
33 | .\" | |
34 | .Dd June 4, 1993 | |
931b8415 CL |
35 | .Dt SETPGID 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 | |
3ebb09da | 49 | sets the process group of the specified process |
931b8415 | 50 | .Ar pid |
3ebb09da | 51 | to the specified |
931b8415 | 52 | .Ar pgrp . |
3ebb09da | 53 | If |
931b8415 | 54 | .Ar pid |
3ebb09da | 55 | is zero, then the call applies to the current process. |
931b8415 | 56 | .Pp |
3ebb09da KM |
57 | If the invoker is not the super-user, then the affected process |
58 | must have the same effective user-id as the invoker or be a descendant | |
59 | of the invoking process. | |
931b8415 CL |
60 | .Sh RETURN VALUES |
61 | .Fn Setpgid | |
76559d79 | 62 | returns 0 when the operation was successful. |
931b8415 CL |
63 | If the request failed, -1 is returned and the global variable |
64 | .Va errno | |
f4199a91 | 65 | indicates the reason. |
931b8415 CL |
66 | .Sh ERRORS |
67 | .Fn Setpgid | |
68 | will fail and the process group will not be altered if: | |
69 | .Bl -tag -width indent | |
70 | .It Bq Er ESRCH | |
f4199a91 | 71 | The requested process does not exist. |
931b8415 | 72 | .It Bq Er EPERM |
f4199a91 KM |
73 | The effective user ID of the requested process is different |
74 | from that of the caller and the process is not a descendent | |
75 | of the calling process. | |
931b8415 CL |
76 | .El |
77 | .Sh SEE ALSO | |
78 | .Xr getpgrp 2 | |
79 | .Sh STANDARDS | |
80 | .Fn Setpgid | |
81 | conforms to IEEE Std 1003.1-1988 | |
82 | .Pq Dq Tn POSIX . | |
83 | .Sh COMPATIBILITY | |
84 | .Fn Setpgrp | |
76559d79 | 85 | is identical to |
931b8415 | 86 | .Fn setpgid , |
76559d79 | 87 | and is retained for calling convention compatibility with historical |
931b8415 CL |
88 | versions of |
89 | .Bx . |