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