lib/libc/compat-43/killpg.3

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