[apple/libc.git] / compat-43 / 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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.12 2002/12/19 09:40:21 ru Exp $
.\"
.Dd June 2, 1993
.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 that is a descendant of the current process.
.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.
	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	.\"
224c7076 A	32	.\" @(#)killpg.2 8.1 (Berkeley) 6/2/93
224c7076 A	33	.\" $FreeBSD: src/lib/libc/compat-43/killpg.2,v 1.12 2002/12/19 09:40:21 ru Exp $
e9ce8d39	34	.\"
224c7076 A	35	.Dd June 2, 1993
224c7076 A	36	.Dt KILLPG 2
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
224c7076 A	39	.Nm killpg
224c7076 A	40	.Nd send signal to a process group
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
224c7076 A	44	.In signal.h
	45	.Ft int
	46	.Fn killpg "pid_t pgrp" "int sig"
e9ce8d39 A	47	.Sh DESCRIPTION
e9ce8d39 A	48	The
224c7076	49	.Fn killpg
5b2abdfb	50	function
224c7076 A	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.
e9ce8d39	69	.Sh RETURN VALUES
224c7076 A	70	.Rv -std killpg
224c7076 A	71	.Sh ERRORS
5b2abdfb	72	The
224c7076 A	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
e9ce8d39 A	105	.Sh HISTORY
e9ce8d39 A	106	The
224c7076	107	.Fn killpg
5b2abdfb	108	function appeared in
224c7076	109	.Bx 4.0 .