xref: /dflybsd-src/lib/libc/gen/killpg.3 (revision 8289fd98f2a8587dc514cf8fe40b7b307afa80a8)
1*8289fd98SSascha Wildner.\" Copyright (c) 1980, 1991, 1993
2*8289fd98SSascha Wildner.\"	The Regents of the University of California.  All rights reserved.
3*8289fd98SSascha Wildner.\"
4*8289fd98SSascha Wildner.\" Redistribution and use in source and binary forms, with or without
5*8289fd98SSascha Wildner.\" modification, are permitted provided that the following conditions
6*8289fd98SSascha Wildner.\" are met:
7*8289fd98SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
8*8289fd98SSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
9*8289fd98SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
10*8289fd98SSascha Wildner.\"    notice, this list of conditions and the following disclaimer in the
11*8289fd98SSascha Wildner.\"    documentation and/or other materials provided with the distribution.
12*8289fd98SSascha Wildner.\" 3. Neither the name of the University nor the names of its contributors
13*8289fd98SSascha Wildner.\"    may be used to endorse or promote products derived from this software
14*8289fd98SSascha Wildner.\"    without specific prior written permission.
15*8289fd98SSascha Wildner.\"
16*8289fd98SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17*8289fd98SSascha Wildner.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*8289fd98SSascha Wildner.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*8289fd98SSascha Wildner.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20*8289fd98SSascha Wildner.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*8289fd98SSascha Wildner.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*8289fd98SSascha Wildner.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*8289fd98SSascha Wildner.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*8289fd98SSascha Wildner.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*8289fd98SSascha Wildner.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*8289fd98SSascha Wildner.\" SUCH DAMAGE.
27*8289fd98SSascha Wildner.\"
28*8289fd98SSascha Wildner.\"     @(#)killpg.2	8.1 (Berkeley) 6/2/93
29*8289fd98SSascha Wildner.\" $FreeBSD: src/lib/libc/compat-43/killpg.2,v 1.6.2.4 2003/03/15 15:11:05 trhodes Exp $
30*8289fd98SSascha Wildner.\"
31*8289fd98SSascha Wildner.Dd November 26, 2016
32*8289fd98SSascha Wildner.Dt KILLPG 3
33*8289fd98SSascha Wildner.Os
34*8289fd98SSascha Wildner.Sh NAME
35*8289fd98SSascha Wildner.Nm killpg
36*8289fd98SSascha Wildner.Nd send signal to a process group
37*8289fd98SSascha Wildner.Sh LIBRARY
38*8289fd98SSascha Wildner.Lb libc
39*8289fd98SSascha Wildner.Sh SYNOPSIS
40*8289fd98SSascha Wildner.In sys/types.h
41*8289fd98SSascha Wildner.In signal.h
42*8289fd98SSascha Wildner.Ft int
43*8289fd98SSascha Wildner.Fn killpg "pid_t pgrp" "int sig"
44*8289fd98SSascha Wildner.Sh DESCRIPTION
45*8289fd98SSascha WildnerThe
46*8289fd98SSascha Wildner.Fn killpg
47*8289fd98SSascha Wildnerfunction
48*8289fd98SSascha Wildnersends the signal
49*8289fd98SSascha Wildner.Fa sig
50*8289fd98SSascha Wildnerto the process group
51*8289fd98SSascha Wildner.Fa pgrp .
52*8289fd98SSascha WildnerSee
53*8289fd98SSascha Wildner.Xr sigaction 2
54*8289fd98SSascha Wildnerfor a list of signals.
55*8289fd98SSascha WildnerIf
56*8289fd98SSascha Wildner.Fa pgrp
57*8289fd98SSascha Wildneris 0,
58*8289fd98SSascha Wildner.Fn killpg
59*8289fd98SSascha Wildnersends the signal to the sending process's process group.
60*8289fd98SSascha Wildner.Pp
61*8289fd98SSascha WildnerThe sending process and members of the process group must
62*8289fd98SSascha Wildnerhave the same effective user ID, or
63*8289fd98SSascha Wildnerthe sender must be the super-user.
64*8289fd98SSascha WildnerAs a single special case the continue signal
65*8289fd98SSascha Wildner.Dv SIGCONT
66*8289fd98SSascha Wildnermay be sent
67*8289fd98SSascha Wildnerto any process that is a descendant of the current process.
68*8289fd98SSascha Wildner.Sh RETURN VALUES
69*8289fd98SSascha Wildner.Rv -std killpg
70*8289fd98SSascha Wildner.Sh ERRORS
71*8289fd98SSascha WildnerThe
72*8289fd98SSascha Wildner.Fn killpg
73*8289fd98SSascha Wildnerfunction
74*8289fd98SSascha Wildnerwill fail and no signal will be sent if:
75*8289fd98SSascha Wildner.Bl -tag -width Er
76*8289fd98SSascha Wildner.It Bq Er EINVAL
77*8289fd98SSascha WildnerThe
78*8289fd98SSascha Wildner.Fa sig
79*8289fd98SSascha Wildnerargument
80*8289fd98SSascha Wildneris not a valid signal number.
81*8289fd98SSascha Wildner.It Bq Er ESRCH
82*8289fd98SSascha WildnerNo process can be found in the process group specified by
83*8289fd98SSascha Wildner.Fa pgrp .
84*8289fd98SSascha Wildner.It Bq Er ESRCH
85*8289fd98SSascha WildnerThe process group was given as 0
86*8289fd98SSascha Wildnerbut the sending process does not have a process group.
87*8289fd98SSascha Wildner.It Bq Er EPERM
88*8289fd98SSascha WildnerThe sending process is not the super-user and one or more
89*8289fd98SSascha Wildnerof the target processes has an effective user ID different from that
90*8289fd98SSascha Wildnerof the sending process.
91*8289fd98SSascha Wildner.El
92*8289fd98SSascha Wildner.Sh SEE ALSO
93*8289fd98SSascha Wildner.Xr getpgrp 2 ,
94*8289fd98SSascha Wildner.Xr kill 2 ,
95*8289fd98SSascha Wildner.Xr sigaction 2
96*8289fd98SSascha Wildner.Sh HISTORY
97*8289fd98SSascha WildnerThe
98*8289fd98SSascha Wildner.Fn killpg
99*8289fd98SSascha Wildnerfunction appeared in
100*8289fd98SSascha Wildner.Bx 4.0 .
101