[apple/libc.git] / compat-43 / FreeBSD / killpg.2

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)killpg.2	8.1 (Berkeley) 6/2/93
.\" $FreeBSD: src/lib/libc/compat-43/killpg.2,v 1.14 2007/01/09 00:27:49 imp Exp $
.\"
.Dd October 10, 2006
.Dt KILLPG 2
.Os
.Sh NAME
.Nm killpg
.Nd send signal to a process group
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In signal.h
.Ft int
.Fn killpg "pid_t pgrp" "int sig"
.Sh DESCRIPTION
The
.Fn killpg
function
sends the signal
.Fa sig
to the process group
.Fa pgrp .
See
.Xr sigaction 2
for a list of signals.
If
.Fa pgrp
is 0,
.Fn killpg
sends the signal to the sending process's process group.
.Pp
The sending process and members of the process group must
have the same effective user ID, or
the sender must be the super-user.
As a single special case the continue signal SIGCONT may be sent
to any process with the same session ID as the caller.
.Sh RETURN VALUES
.Rv -std killpg
.Sh ERRORS
The
.Fn killpg
function
will fail and no signal will be sent if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
.Fa sig
argument
is not a valid signal number.
.It Bq Er EPERM
The sending process is not the super-user and one or more
of the target processes has an effective user ID different from that
of the sending process.
.It Bq Er ESRCH
No process can be found in the process group specified by
.Fa pgrp .
.It Bq Er ESRCH
The process group was given as 0
but the sending process does not have a process group.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <signal.h>
.Pp
The include file
.In sys/types.h
is necessary.
.Sh SEE ALSO
.Xr getpgrp 2 ,
.Xr kill 2 ,
.Xr sigaction 2 ,
.Xr compat 5
.Sh HISTORY
The
.Fn killpg
function appeared in
.Bx 4.0 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1980, 1991, 1993
e9ce8d39 A	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.
e9ce8d39 A	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	.\"
5b2abdfb	28	.\" @(#)killpg.2 8.1 (Berkeley) 6/2/93
1f2f436a	29	.\" $FreeBSD: src/lib/libc/compat-43/killpg.2,v 1.14 2007/01/09 00:27:49 imp Exp $
e9ce8d39	30	.\"
1f2f436a	31	.Dd October 10, 2006
5b2abdfb	32	.Dt KILLPG 2
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
5b2abdfb A	35	.Nm killpg
5b2abdfb A	36	.Nd send signal to a process group
e9ce8d39 A	37	.Sh LIBRARY
	38	.Lb libc
	39	.Sh SYNOPSIS
5b2abdfb	40	.In signal.h
e9ce8d39	41	.Ft int
5b2abdfb	42	.Fn killpg "pid_t pgrp" "int sig"
e9ce8d39	43	.Sh DESCRIPTION
9385eb3d A	44	The
	45	.Fn killpg
	46	function
5b2abdfb A	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.
e9ce8d39	54	If
5b2abdfb A	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
1f2f436a	64	to any process with the same session ID as the caller.
e9ce8d39	65	.Sh RETURN VALUES
5b2abdfb	66	.Rv -std killpg
e9ce8d39	67	.Sh ERRORS
9385eb3d A	68	The
	69	.Fn killpg
	70	function
5b2abdfb	71	will fail and no signal will be sent if:
e9ce8d39 A	72	.Bl -tag -width Er
e9ce8d39 A	73	.It Bq Er EINVAL
9385eb3d A	74	The
	75	.Fa sig
	76	argument
5b2abdfb	77	is not a valid signal number.
ad3c9f2a A	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.
5b2abdfb A	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.
5b2abdfb	88	.El
ad3c9f2a A	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.
e9ce8d39	96	.Sh SEE ALSO
5b2abdfb A	97	.Xr getpgrp 2 ,
5b2abdfb A	98	.Xr kill 2 ,
ad3c9f2a A	99	.Xr sigaction 2 ,
ad3c9f2a A	100	.Xr compat 5
e9ce8d39 A	101	.Sh HISTORY
e9ce8d39 A	102	The
5b2abdfb	103	.Fn killpg
9385eb3d	104	function appeared in
5b2abdfb	105	.Bx 4.0 .