man-pages/man3/killpg.3

79 lines
2.2 KiB
Groff

.\" (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" License.
.\" Modified Sat Jul 24 19:04:55 1993 by Rik Faith (faith@cs.unc.edu)
.\" Modified 2004-11-11, Michael Kerrisk, <mtk-manpages@gmx.net>
.\"
.TH KILLPG 3 1993-04-04 "GNU" "Linux Programmer's Manual"
.SH NAME
killpg \- send signal to all members of a process group
.SH SYNOPSIS
.nf
.B #include <signal.h>
.sp
.BI "int killpg(pid_t " pgrp ", int " signal );
.fi
.SH DESCRIPTION
The
.BR killpg ()
function causes signal
.I signal
to be sent to all the processes in the process group
.I pgrp
or to the processes' own process group if
.I pgrp
is equal to zero.
.PP
If
.I pgrp
is greater than 1, it is equivalent to:
.nf
.sp
.in +0.5i
.B kill(\-pgrp , signal);
.in -0.5i
.fi
.SH "RETURN VALUE"
The value returned is \-1 on error, or 0 for success.
.SH ERRORS
Errors are returned in
.I errno
and can be one of the following:
.TP
.B EINVAL
for an invalid signal,
.TP
.B EPERM
if the userid of the calling process is not equal to that of the
process the signal is sent to, and the userid is not that of the
superuser.
.TP
.B ESRCH
for a process group which does not exist, and
.SH "CONFORMING TO"
SUSv2, POSIX.1-2001
.SH "SEE ALSO"
.BR kill (2),
.BR signal (2),
.BR sigqueue (2),
.BR signal (7)