src/lib/libc/compat-43/killpg.3

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" 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 .\"     $OpenBSD: killpg.3,v 1.11 2007/05/31 19:19:27 jmc Exp $
  29 .\"
  30 .Dd $Mdocdate: May 31 2007 $
  31 .Dt KILLPG 3
  32 .Os
  33 .Sh NAME
  34 .Nm killpg
  35 .Nd send signal to a process group
  36 .Sh SYNOPSIS
  37 .Fd #include <signal.h>
  38 .Ft int
  39 .Fn killpg "pid_t pgrp" "int sig"
  40 .Sh DESCRIPTION
  41 .Fn killpg
  42 sends the signal
  43 .Fa sig
  44 to the process group
  45 .Fa pgrp .
  46 See
  47 .Xr sigaction 2
  48 for a list of signals.
  49 If
  50 .Fa pgrp
  51 is 0,
  52 .Fn killpg
  53 sends the signal to the sending process's process group.
  54 .Pp
  55 The sending process and members of the process group must
  56 have the same effective user ID, or
  57 the sender must be the superuser.
  58 As a single special case the continue signal SIGCONT may be sent
  59 to any process with the same session ID as the caller.
  60 .Sh RETURN VALUES
  61 Upon successful completion, a value of 0 is returned.
  62 Otherwise, a value of \-1 is returned and the global variable
  63 .Va errno
  64 is set to indicate the error.
  65 .Sh ERRORS
  66 .Fn killpg
  67 will fail and no signal will be sent if:
  68 .Bl -tag -width Er
  69 .It Bq Er EINVAL
  70 .Fa sig
  71 is not a valid signal number.
  72 .It Bq Er ESRCH
  73 No process can be found in the process group specified by
  74 .Fa pgrp .
  75 .It Bq Er ESRCH
  76 The process group was given as 0
  77 but the sending process does not have a process group.
  78 .It Bq Er EPERM
  79 The sending process is not the superuser and one or more
  80 of the target processes has an effective user ID different from that
  81 of the sending process.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr getpgrp 2 ,
  85 .Xr kill 2 ,
  86 .Xr sigaction 2
  87 .Sh HISTORY
  88 The
  89 .Fn killpg
  90 function call appeared in
  91 .Bx 4.0 .