man3/killpg.3

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)killpg.2    6.5 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified Fri Jul 23 21:55:01 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 2004-06-16 by Michael Kerrisk <mtk.manpages@gmail.com>
  39 .\"     Added notes on CAP_KILL
  40 .\" Modified 2004-06-21 by aeb
  41 .\"
  42 .TH KILLPG 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  43 .SH NAME
  44 killpg \- send signal to a process group
  45 .SH SYNOPSIS
  46 .nf
  47 .B #include <signal.h>
  48 .PP
  49 .BI "int killpg(int " pgrp ", int " sig );
  50 .fi
  51 .PP
  52 .RS -4
  53 Feature Test Macro Requirements for glibc (see
  54 .BR feature_test_macros (7)):
  55 .RE
  56 .PP
  57 .BR killpg ():
  58 .nf
  59     _XOPEN_SOURCE >= 500
  60 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  61         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  62         || /* Glibc <= 2.19: */ _BSD_SOURCE
  63 .fi
  64 .SH DESCRIPTION
  65 .BR killpg ()
  66 sends the signal
  67 .I sig
  68 to the process group
  69 .IR pgrp .
  70 See
  71 .BR signal (7)
  72 for a list of signals.
  73 .PP
  74 If
  75 .I pgrp
  76 is 0,
  77 .BR killpg ()
  78 sends the signal to the calling process's process group.
  79 (POSIX says: if
  80 .I pgrp
  81 is less than or equal to 1, the behavior is undefined.)
  82 .PP
  83 For the permissions required to send a signal to another process, see
  84 .BR kill (2).
  85 .SH RETURN VALUE
  86 On success, zero is returned.
  87 On error, \-1 is returned, and
  88 .I errno
  89 is set to indicate the error.
  90 .SH ERRORS
  91 .TP
  92 .B EINVAL
  93 .I sig
  94 is not a valid signal number.
  95 .TP
  96 .B EPERM
  97 The process does not have permission to send the signal
  98 to any of the target processes.
  99 For the required permissions, see
 100 .BR kill (2).
 101 .TP
 102 .B ESRCH
 103 No process can be found in the process group specified by
 104 .IR pgrp .
 105 .TP
 106 .B ESRCH
 107 The process group was given as 0 but the sending process does not
 108 have a process group.
 109 .SH CONFORMING TO
 110 POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD
 111 .RB ( killpg ()
 112 first appeared in 4BSD).
 113 .SH NOTES
 114 There are various differences between the permission checking
 115 in BSD-type systems and System\ V-type systems.
 116 See the POSIX rationale for
 117 .BR kill (3p).
 118 A difference not mentioned by POSIX concerns the return
 119 value
 120 .BR EPERM :
 121 BSD documents that no signal is sent and
 122 .B EPERM
 123 returned when the permission check failed for at least one target process,
 124 while POSIX documents
 125 .B EPERM
 126 only when the permission check failed for all target processes.
 127 .SS C library/kernel differences
 128 On Linux,
 129 .BR killpg ()
 130 is implemented as a library function that makes the call
 131 .IR "kill(\-pgrp,\ sig)" .
 132 .SH SEE ALSO
 133 .BR getpgrp (2),
 134 .BR kill (2),
 135 .BR signal (2),
 136 .BR capabilities (7),
 137 .BR credentials (7)