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