xref: /dragonfly/lib/libc/gen/killpg.3 (revision 8edfbc5e)
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: src/lib/libc/compat-43/killpg.2,v 1.6.2.4 2003/03/15 15:11:05 trhodes Exp $
30.\"
31.Dd November 26, 2016
32.Dt KILLPG 3
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 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
65.Dv SIGCONT
66may be sent
67to any process that is a descendant of the current process.
68.Sh RETURN VALUES
69.Rv -std killpg
70.Sh ERRORS
71The
72.Fn killpg
73function
74will fail and no signal will be sent if:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77The
78.Fa sig
79argument
80is not a valid signal number.
81.It Bq Er ESRCH
82No process can be found in the process group specified by
83.Fa pgrp .
84.It Bq Er ESRCH
85The process group was given as 0
86but the sending process does not have a process group.
87.It Bq Er EPERM
88The sending process is not the super-user and one or more
89of the target processes has an effective user ID different from that
90of the sending process.
91.El
92.Sh SEE ALSO
93.Xr getpgrp 2 ,
94.Xr kill 2 ,
95.Xr sigaction 2
96.Sh HISTORY
97The
98.Fn killpg
99function appeared in
100.Bx 4.0 .
101