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