2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 1980, 1991 Regents of the University of California.
|
|
|
|
.\" All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" @(#)killpg.2 6.5 (Berkeley) 3/10/91
|
|
|
|
.\"
|
|
|
|
.\" Modified Fri Jul 23 21:55:01 1993 by Rik Faith <faith@cs.unc.edu>
|
|
|
|
.\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
|
2007-09-20 06:52:22 +00:00
|
|
|
.\" Modified 2004-06-16 by Michael Kerrisk <mtk.manpages@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Added notes on CAP_KILL
|
2007-04-12 22:42:49 +00:00
|
|
|
.\" Modified 2004-06-21 by aeb
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
_exit.2, brk.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, getdtablesize.2, gethostname.2, getpagesize.2, getsid.2, killpg.2, mknod.2, mknodat.2, poll.2, posix_fadvise.2, pread.2, readlink.2, setpgid.2, setreuid.2, sigaltstack.2, stat.2, symlink.2, sync.2, truncate.2, vfork.2, wait.2, wait4.2, a64l.3, abs.3, acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atoi.3, cbrt.3, ceil.3, copysign.3, cosh.3, dirfd.3, div.3, ecvt.3, erf.3, erfc.3, exp.3, exp2.3, fabs.3, fdim.3, ffs.3, floor.3, fma.3, fmax.3, fmin.3, fmod.3, fpclassify.3, frexp.3, ftw.3, fwide.3, gcvt.3, getcwd.3, getdate.3, getgrent.3, gethostid.3, getpass.3, getpwent.3, getsubopt.3, getw.3, hypot.3, ilogb.3, index.3, isalpha.3, isgreater.3, iswblank.3, j0.3, ldexp.3, lockf.3, log.3, log10.3, log1p.3, logb.3, lrint.3, lround.3, mkstemp.3, mktemp.3, modf.3, mq_receive.3, mq_send.3, nan.3, nextafter.3, posix_fallocate.3, posix_memalign.3, printf.3, qecvt.3, random.3, realpath.3, remainder.3, remquo.3, rint.3, round.3, scalb.3, scalbln.3, scanf.3, siginterrupt.3, signbit.3, sigset.3, sinh.3, sqrt.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strfry.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtod.3, strtok.3, strtol.3, strtoul.3, strxfrm.3, tanh.3, tgamma.3, trunc.3, ttyslot.3, ualarm.3, usleep.3, wprintf.3, armscii-8.7, cp1251.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-3.7, iso_8859-5.7, iso_8859-6.7, iso_8859-8.7, koi8-u.7: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 17:19:13 +00:00
|
|
|
.TH KILLPG 2 2010-09-20 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
killpg \- send signal to a process group
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <signal.h>
|
|
|
|
.sp
|
|
|
|
.BI "int killpg(int " pgrp ", int " sig );
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
2010-09-18 05:25:06 +00:00
|
|
|
.ad l
|
|
|
|
.TP 4
|
2007-07-08 12:11:40 +00:00
|
|
|
.BR killpg ():
|
2010-09-18 05:25:06 +00:00
|
|
|
_BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
|
|
|
|
_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
|
|
|
|
.ad
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2006-06-03 01:26:30 +00:00
|
|
|
.BR killpg ()
|
2004-11-03 13:51:07 +00:00
|
|
|
sends the signal
|
|
|
|
.I sig
|
|
|
|
to the process group
|
|
|
|
.IR pgrp .
|
|
|
|
See
|
|
|
|
.BR signal (7)
|
|
|
|
for a list of signals.
|
2007-06-11 18:40:01 +00:00
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
If
|
|
|
|
.I pgrp
|
|
|
|
is 0,
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR killpg ()
|
2007-06-11 18:40:01 +00:00
|
|
|
sends the signal to the calling process's process group.
|
2004-11-03 13:51:07 +00:00
|
|
|
(POSIX says: If
|
|
|
|
.I pgrp
|
2007-06-08 09:56:56 +00:00
|
|
|
is less than or equal to 1, the behavior is undefined.)
|
2004-11-03 13:51:07 +00:00
|
|
|
|
|
|
|
For a process to have permission to send a signal
|
|
|
|
it must either be privileged (under Linux: have the
|
|
|
|
.B CAP_KILL
|
|
|
|
capability), or the real or effective
|
|
|
|
user ID of the sending process must equal the real or
|
|
|
|
saved set-user-ID of the target process.
|
2007-06-21 05:38:48 +00:00
|
|
|
In the case of
|
|
|
|
.B SIGCONT
|
|
|
|
it suffices when the sending and receiving
|
2004-11-03 13:51:07 +00:00
|
|
|
processes belong to the same session.
|
|
|
|
.SH "RETURN VALUE"
|
2007-04-12 22:42:49 +00:00
|
|
|
On success, zero is returned.
|
|
|
|
On error, \-1 is returned, and
|
2004-11-03 13:51:07 +00:00
|
|
|
.I errno
|
|
|
|
is set appropriately.
|
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
.I Sig
|
|
|
|
is not a valid signal number.
|
|
|
|
.TP
|
|
|
|
.B EPERM
|
|
|
|
The process does not have permission to send the signal
|
|
|
|
to any of the target processes.
|
|
|
|
.TP
|
|
|
|
.B ESRCH
|
|
|
|
No process can be found in the process group specified by
|
|
|
|
.IR pgrp .
|
|
|
|
.TP
|
|
|
|
.B ESRCH
|
|
|
|
The process group was given as 0 but the sending process does not
|
|
|
|
have a process group.
|
2007-05-18 16:06:42 +00:00
|
|
|
.SH "CONFORMING TO"
|
2007-06-11 18:40:01 +00:00
|
|
|
SVr4, 4.4BSD (the
|
2007-05-18 16:06:42 +00:00
|
|
|
.BR killpg ()
|
|
|
|
function call first appeared in 4BSD), POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
|
|
|
There are various differences between the permission checking
|
2007-04-12 22:42:49 +00:00
|
|
|
in BSD-type systems and System V-type systems.
|
2007-05-11 23:07:02 +00:00
|
|
|
See the POSIX rationale for
|
2007-06-11 18:40:01 +00:00
|
|
|
.BR kill ().
|
2005-10-19 14:48:35 +00:00
|
|
|
A difference not mentioned by POSIX concerns the return
|
2007-06-22 17:16:20 +00:00
|
|
|
value
|
|
|
|
.BR EPERM :
|
|
|
|
BSD documents that no signal is sent and
|
2007-09-20 16:26:31 +00:00
|
|
|
.B EPERM
|
2007-06-22 17:16:20 +00:00
|
|
|
returned when the permission check failed for at least one target process,
|
|
|
|
while POSIX documents
|
|
|
|
.B EPERM
|
|
|
|
only when the permission check failed for all target processes.
|
2007-06-24 17:28:02 +00:00
|
|
|
|
|
|
|
On Linux,
|
|
|
|
.BR killpg ()
|
|
|
|
is implemented as a library function that makes the call
|
|
|
|
.IR "kill(-pgrp,\ sig)" .
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR getpgrp (2),
|
|
|
|
.BR kill (2),
|
|
|
|
.BR signal (2),
|
2007-06-08 07:57:18 +00:00
|
|
|
.BR capabilities (7),
|
|
|
|
.BR credentials (7)
|