xref: /freebsd/lib/libc/compat-43/killpg.2 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.\"
30.Dd March 15, 2012
31.Dt KILLPG 2
32.Os
33.Sh NAME
34.Nm killpg
35.Nd send signal to a process group
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In signal.h
41.Ft int
42.Fn killpg "pid_t pgrp" "int sig"
43.Sh DESCRIPTION
44The
45.Fn killpg
46function
47sends the signal
48.Fa sig
49to the process group
50.Fa pgrp .
51See
52.Xr sigaction 2
53for a list of signals.
54If
55.Fa pgrp
56is 0,
57.Fn killpg
58sends the signal to the sending process's process group.
59.Pp
60The sending process must be able to
61.Fn kill
62at least one process in the receiving process group.
63.Sh RETURN VALUES
64.Rv -std killpg
65.Sh ERRORS
66The
67.Fn killpg
68function
69will fail and no signal will be sent if:
70.Bl -tag -width Er
71.It Bq Er EINVAL
72The
73.Fa sig
74argument
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 EPERM
80.Fn kill
81returns EPERM for all processes in the process group.
82.El
83.Sh SEE ALSO
84.Xr getpgrp 2 ,
85.Xr kill 2 ,
86.Xr sigaction 2
87.Sh HISTORY
88The
89.Fn killpg
90function appeared in
91.Bx 4.0 .
92