xref: /freebsd/lib/libc/compat-43/killpg.2 (revision 7c43148a974877188a930e4078a164f83da8e652)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd March 15, 2012
29.Dt KILLPG 2
30.Os
31.Sh NAME
32.Nm killpg
33.Nd send signal to a process group
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In signal.h
39.Ft int
40.Fn killpg "pid_t pgrp" "int sig"
41.Sh DESCRIPTION
42The
43.Fn killpg
44function
45sends the signal
46.Fa sig
47to the process group
48.Fa pgrp .
49See
50.Xr sigaction 2
51for a list of signals.
52If
53.Fa pgrp
54is 0,
55.Fn killpg
56sends the signal to the sending process's process group.
57.Pp
58The sending process must be able to
59.Fn kill
60at least one process in the receiving process group.
61.Sh RETURN VALUES
62.Rv -std killpg
63.Sh ERRORS
64The
65.Fn killpg
66function
67will fail and no signal will be sent if:
68.Bl -tag -width Er
69.It Bq Er EINVAL
70The
71.Fa sig
72argument
73is not a valid signal number.
74.It Bq Er ESRCH
75No process can be found in the process group specified by
76.Fa pgrp .
77.It Bq Er EPERM
78.Fn kill
79returns EPERM for all processes in the process group.
80.El
81.Sh SEE ALSO
82.Xr getpgrp 2 ,
83.Xr kill 2 ,
84.Xr sigaction 2
85.Sh HISTORY
86The
87.Fn killpg
88function appeared in
89.Bx 4.0 .
90