compat-43/killpg.2

   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 .\" 4. 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 .\"     @(#)killpg.2    8.1 (Berkeley) 6/2/93
  29 .\" $FreeBSD: src/lib/libc/compat-43/killpg.2,v 1.14 2007/01/09 00:27:49 imp Exp $
  30 .\"
  31 .Dd October 10, 2006
  32 .Dt KILLPG 2
  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 The
  45 .Fn killpg
  46 function
  47 sends the signal
  48 .Fa sig
  49 to the process group
  50 .Fa pgrp .
  51 See
  52 .Xr sigaction 2
  53 for a list of signals.
  54 If
  55 .Fa pgrp
  56 is 0,
  57 .Fn killpg
  58 sends the signal to the sending process's process group.
  59 .Pp
  60 The sending process and members of the process group must
  61 have the same effective user ID, or
  62 the sender must be the super-user.
  63 As a single special case the continue signal SIGCONT may be sent
  64 to any process with the same session ID as the caller.
  65 .Sh RETURN VALUES
  66 .Rv -std killpg
  67 .Sh ERRORS
  68 The
  69 .Fn killpg
  70 function
  71 will fail and no signal will be sent if:
  72 .Bl -tag -width Er
  73 .It Bq Er EINVAL
  74 The
  75 .Fa sig
  76 argument
  77 is not a valid signal number.
  78 .It Bq Er EPERM
  79 The sending process is not the super-user and one or more
  80 of the target processes has an effective user ID different from that
  81 of the sending process.
  82 .It Bq Er ESRCH
  83 No process can be found in the process group specified by
  84 .Fa pgrp .
  85 .It Bq Er ESRCH
  86 The process group was given as 0
  87 but the sending process does not have a process group.
  88 .El
  89 .Sh LEGACY SYNOPSIS
  90 .Fd #include <sys/types.h>
  91 .Fd #include <signal.h>
  92 .Pp
  93 The include file
  94 .In sys/types.h
  95 is necessary.
  96 .Sh SEE ALSO
  97 .Xr getpgrp 2 ,
  98 .Xr kill 2 ,
  99 .Xr sigaction 2 ,
 100 .Xr compat 5
 101 .Sh HISTORY
 102 The
 103 .Fn killpg
 104 function appeared in
 105 .Bx 4.0 .