xref: /openbsd-src/lib/libc/compat-43/killpg.3 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\" Copyright (c) 1980, 1991 Regents of the University of California.
2.\" 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.\"	$OpenBSD: killpg.3,v 1.13 2015/01/29 01:46:30 schwarze Exp $
29.\"
30.Dd $Mdocdate: January 29 2015 $
31.Dt KILLPG 3
32.Os
33.Sh NAME
34.Nm killpg
35.Nd send signal to a process group
36.Sh SYNOPSIS
37.In signal.h
38.Ft int
39.Fn killpg "pid_t pgrp" "int sig"
40.Sh DESCRIPTION
41.Fn killpg
42sends the signal
43.Fa sig
44to the process group
45.Fa pgrp .
46See
47.Xr sigaction 2
48for a list of signals.
49If
50.Fa pgrp
51is 0,
52.Fn killpg
53sends the signal to the sending process's process group.
54.Pp
55The sending process and members of the process group must
56have the same effective user ID, or
57the sender must be the superuser.
58As a single special case the continue signal SIGCONT may be sent
59to any process with the same session ID as the caller.
60.Sh RETURN VALUES
61.Rv -std
62.Sh ERRORS
63.Fn killpg
64will fail and no signal will be sent if:
65.Bl -tag -width Er
66.It Bq Er EINVAL
67.Fa sig
68is not a valid signal number.
69.It Bq Er ESRCH
70No process can be found in the process group specified by
71.Fa pgrp .
72.It Bq Er ESRCH
73The process group was given as 0
74but the sending process does not have a process group.
75.It Bq Er EPERM
76The sending process is not the superuser and one or more
77of the target processes has an effective user ID different from that
78of the sending process.
79.El
80.Sh SEE ALSO
81.Xr getpgrp 2 ,
82.Xr kill 2 ,
83.Xr sigaction 2
84.Sh HISTORY
85The
86.Fn killpg
87function call appeared in
88.Bx 4.0 .
89