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