xref: /netbsd/lib/libc/compat-43/killpg.3 (revision bf9ec67e)
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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)killpg.2	8.1 (Berkeley) 6/2/93
33.\"	$NetBSD: killpg.3,v 1.12 2002/02/07 07:00:09 ross Exp $
34.\"
35.Dd June 2, 1993
36.Dt KILLPG 3
37.Os
38.Sh NAME
39.Nm killpg
40.Nd send signal to a process group
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.Fd #include \*[Lt]signal.h\*[Gt]
45.Ft int
46.Fn killpg "pid_t pgrp" "int sig"
47.Sh DESCRIPTION
48.Fn killpg
49sends the signal
50.Fa sig
51to the process group
52.Fa pgrp .
53See
54.Xr sigaction 2
55for a list of signals.
56If
57.Fa pgrp
58is 0,
59.Fn killpg
60sends the signal to the sending process's process group.
61.Pp
62The sending process and members of the process group must
63have the same effective user ID, or
64the sender must be the super-user.
65As a single special case the continue signal SIGCONT may be sent
66to any process that is a descendant of the current process.
67.Sh RETURN VALUES
68Upon successful completion, a value of 0 is returned.  Otherwise,
69a value of -1 is returned and the global variable
70.Va errno
71is set to indicate the error.
72.Sh ERRORS
73.Fn killpg
74will fail and no signal will be sent if:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77.Fa sig
78is not a valid signal number.
79.It Bq Er ESRCH
80No process can be found in the process group specified by
81.Fa pgrp .
82.It Bq Er ESRCH
83The process group was given as 0
84but the sending process does not have a process group.
85.It Bq Er EPERM
86The sending process is not the super-user and one or more
87of the target processes has an effective user ID different from that
88of the sending process.
89.El
90.Sh SEE ALSO
91.Xr getpgrp 2 ,
92.Xr kill 2 ,
93.Xr sigaction 2
94.Sh HISTORY
95The
96.Fn killpg
97function call appeared in
98.Bx 4.0 .
99