original/man2/killpg.2

   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 2 2010-09-20 "Linux" "Linux Programmer's Manual"
  43 .SH NAME
  44 killpg \- send signal to a process group
  45 .SH SYNOPSIS
  46 .B #include <signal.h>
  47 .sp
  48 .BI "int killpg(int " pgrp ", int " sig );
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .ad l
  55 .TP 4
  56 .BR killpg ():
  57 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  58 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  59 .ad
  60 .SH DESCRIPTION
  61 .BR killpg ()
  62 sends the signal
  63 .I sig
  64 to the process group
  65 .IR pgrp .
  66 See
  67 .BR signal (7)
  68 for a list of signals.
  69
  70 If
  71 .I pgrp
  72 is 0,
  73 .BR killpg ()
  74 sends the signal to the calling process's process group.
  75 (POSIX says: If
  76 .I pgrp
  77 is less than or equal to 1, the behavior is undefined.)
  78
  79 For a process to have permission to send a signal
  80 it must either be privileged (under Linux: have the
  81 .B CAP_KILL
  82 capability), or the real or effective
  83 user ID of the sending process must equal the real or
  84 saved set-user-ID of the target process.
  85 In the case of
  86 .B SIGCONT
  87 it suffices when the sending and receiving
  88 processes belong to the same session.
  89 .SH RETURN VALUE
  90 On success, zero is returned.
  91 On error, \-1 is returned, and
  92 .I errno
  93 is set appropriately.
  94 .SH ERRORS
  95 .TP
  96 .B EINVAL
  97 .I sig
  98 is not a valid signal number.
  99 .TP
 100 .B EPERM
 101 The process does not have permission to send the signal
 102 to any of the target processes.
 103 .TP
 104 .B ESRCH
 105 No process can be found in the process group specified by
 106 .IR pgrp .
 107 .TP
 108 .B ESRCH
 109 The process group was given as 0 but the sending process does not
 110 have a process group.
 111 .SH CONFORMING TO
 112 SVr4, 4.4BSD (the
 113 .BR killpg ()
 114 function call first appeared in 4BSD), POSIX.1-2001.
 115 .SH NOTES
 116 There are various differences between the permission checking
 117 in BSD-type systems and System\ V-type systems.
 118 See the POSIX rationale for
 119 .BR kill ().
 120 A difference not mentioned by POSIX concerns the return
 121 value
 122 .BR EPERM :
 123 BSD documents that no signal is sent and
 124 .B EPERM
 125 returned when the permission check failed for at least one target process,
 126 while POSIX documents
 127 .B EPERM
 128 only when the permission check failed for all target processes.
 129
 130 On Linux,
 131 .BR killpg ()
 132 is implemented as a library function that makes the call
 133 .IR "kill(-pgrp,\ sig)" .
 134 .SH SEE ALSO
 135 .BR getpgrp (2),
 136 .BR kill (2),
 137 .BR signal (2),
 138 .BR capabilities (7),
 139 .BR credentials (7)
 140 .SH COLOPHON
 141 This page is part of release 3.67 of the Linux
 142 .I man-pages
 143 project.
 144 A description of the project,
 145 information about reporting bugs,
 146 and the latest version of this page,
 147 can be found at
 148 \%http://www.kernel.org/doc/man\-pages/.