xref: /netbsd-src/lib/libc/compat-43/killpg.3 (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: @(#)killpg.2	6.5 (Berkeley) 3/10/91
33.\"	$Id: killpg.3,v 1.5 1994/12/05 18:51:47 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt KILLPG 3
37.Os BSD 4
38.Sh NAME
39.Nm killpg
40.Nd send signal to a process group
41.Sh SYNOPSIS
42.Fd #include <signal.h>
43.Ft int
44.Fn killpg "pid_t pgrp" "int sig"
45.Sh DESCRIPTION
46.Fn Killpg
47sends the signal
48.Fa sig
49to the process group
50.Fa pgrp .
51See
52.Xr sigaction 2
53for a list of signals.
54If
55.Fa pgrp
56is 0,
57.Fn killpg
58sends the signal to the sending process's process group.
59.Pp
60The sending process and members of the process group must
61have the same effective user ID, or
62the sender must be the super-user.
63As a single special case the continue signal SIGCONT may be sent
64to any process that is a descendant of the current process.
65.Sh RETURN VALUES
66Upon successful completion, a value of 0 is returned.  Otherwise,
67a value of -1 is returned and the global variable
68.Va errno
69is set to indicate the error.
70.Sh ERRORS
71.Fn Killpg
72will fail and no signal will be sent if:
73.Bl -tag -width Er
74.It Bq Er EINVAL
75.Fa Sig
76is not a valid signal number.
77.It Bq Er ESRCH
78No process can be found in the process group specified by
79.Fa pgrp .
80.It Bq Er ESRCH
81The process group was given as 0
82but the sending process does not have a process group.
83.It Bq Er EPERM
84The sending process is not the super-user and one or more
85of the target processes has an effective user ID different from that
86of the sending process.
87.El
88.Sh SEE ALSO
89.Xr kill 2 ,
90.Xr getpgrp 2 ,
91.Xr sigaction 2
92.Sh HISTORY
93The
94.Fn killpg
95function call appeared in
96.Bx 4.0 .
97