xref: /freebsd/lib/libc/compat-43/killpg.2 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
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.\"     @(#)killpg.2	8.1 (Berkeley) 6/2/93
29.\" $FreeBSD$
30.\"
31.Dd March 15, 2012
32.Dt KILLPG 2
33.Os
34.Sh NAME
35.Nm killpg
36.Nd send signal to a process group
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In sys/types.h
41.In signal.h
42.Ft int
43.Fn killpg "pid_t pgrp" "int sig"
44.Sh DESCRIPTION
45The
46.Fn killpg
47function
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 must be able to
62.Fn kill
63at least one process in the receiving process group.
64.Sh RETURN VALUES
65.Rv -std killpg
66.Sh ERRORS
67The
68.Fn killpg
69function
70will fail and no signal will be sent if:
71.Bl -tag -width Er
72.It Bq Er EINVAL
73The
74.Fa sig
75argument
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 EPERM
81.Fn kill
82returns EPERM for all processes in the process group.
83.El
84.Sh SEE ALSO
85.Xr getpgrp 2 ,
86.Xr kill 2 ,
87.Xr sigaction 2
88.Sh HISTORY
89The
90.Fn killpg
91function appeared in
92.Bx 4.0 .
93