usr/src/man/man3c/killpg.3c

   1 '\" te
   2 .\"  Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH KILLPG 3C "Jul 24, 2002"
   7 .SH NAME
   8 killpg \- send signal to a process group
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <signal.h>
  13
  14 \fBint\fR \fBkillpg\fR(\fBpid_t\fR \fIpgrp\fR, \fBint\fR \fIsig\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBkillpg()\fR function sends the signal \fIsig\fR to the process group
  21 \fIpgrp\fR. See \fBsignal.h\fR(3HEAD) for a list of signals.
  22 .sp
  23 .LP
  24 The real or effective user \fBID\fR of the sending process must match the real
  25 or saved set-user \fBID\fR of the receiving process, unless the effective user
  26 \fBID\fR of the sending process is the privileged user. A single exception is
  27 the signal \fBSIGCONT\fR, which may always be sent to any descendant of the
  28 current process.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  33 returned and \fBerrno\fR is set to indicate the error.
  34 .SH ERRORS
  35 .sp
  36 .LP
  37 The \fBkillpg()\fR function will fail and no signal will be sent if:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBEINVAL\fR\fR
  42 .ad
  43 .RS 10n
  44 The \fIsig\fR argument is not a valid signal number.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBEPERM\fR\fR
  51 .ad
  52 .RS 10n
  53 The effective user \fBID\fR of the sending process is not privileged user, and
  54 neither its real nor effective user \fBID\fR matches the real or saved set-user
  55 \fBID\fR of one or more of the target processes.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBESRCH\fR\fR
  62 .ad
  63 .RS 10n
  64 No processes were found in the specified process group.
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Standard
  81 _
  82 MT-Level        MT-Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBkill\fR(2), \fBsetpgrp\fR(2), \fBsigaction\fR(2), \fBsignal.h\fR(3HEAD),
  89 \fBattributes\fR(5), \fBstandards\fR(5)