Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / 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.6.2.4 2003/03/15 15:11:05 trhodes 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 sys/types.h
45 .In signal.h
46 .Ft int
47 .Fn killpg "pid_t pgrp" "int sig"
48 .Sh DESCRIPTION
49 The
50 .Fn killpg
51 function
52 sends the signal
53 .Fa sig
54 to the process group
55 .Fa pgrp .
56 See
57 .Xr sigaction 2
58 for a list of signals.
59 If
60 .Fa pgrp
61 is 0,
62 .Fn killpg
63 sends the signal to the sending process's process group.
64 .Pp
65 The sending process and members of the process group must
66 have the same effective user ID, or
67 the sender must be the super-user.
68 As a single special case the continue signal SIGCONT may be sent
69 to any process that is a descendant of the current process.
70 .Sh RETURN VALUES
71 .Rv -std killpg
72 .Sh ERRORS
73 The
74 .Fn killpg
75 function
76 will fail and no signal will be sent if:
77 .Bl -tag -width Er
78 .It Bq Er EINVAL
79 The
80 .Fa sig
81 argument
82 is not a valid signal number.
83 .It Bq Er ESRCH
84 No process can be found in the process group specified by
85 .Fa pgrp .
86 .It Bq Er ESRCH
87 The process group was given as 0
88 but the sending process does not have a process group.
89 .It Bq Er EPERM
90 The sending process is not the super-user and one or more
91 of the target processes has an effective user ID different from that
92 of the sending process.
93 .El
94 .Sh SEE ALSO
95 .Xr getpgrp 2 ,
96 .Xr kill 2 ,
97 .Xr sigaction 2
98 .Sh HISTORY
99 The
100 .Fn killpg
101 function appeared in
102 .Bx 4.0 .