[apple/libc.git] / compat-43 / sigpause.2

.\" Copyright (c) 1983, 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.
.\"
.\"     @(#)sigpause.2	8.1 (Berkeley) 6/2/93
.\" $FreeBSD: src/lib/libc/compat-43/sigpause.2,v 1.5.2.5 2001/12/14 18:33:49 ru Exp $
.\"
.Dd June 2, 1993
.Dt SIGPAUSE 2
.Os
.Sh NAME
.Nm sigpause
.Nd atomically release blocked signals and wait for interrupt
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In signal.h
.Ft int
.Fn sigpause "int sig"
.Sh DESCRIPTION
.Sy This interface is made obsolete by
.Xr sigsuspend 2 .
.Pp
.Fn Sigpause
assigns
.Fa sig
to the set of masked signals
and then waits for a signal to arrive;
on return the set of masked signals is restored.
.Fa Sig
is usually 0, indicating that no
signals are to be blocked.
.Fn Sigpause
always terminates by being interrupted, returning -1 with
.Va errno
set to
.Er EINTR .
.Sh COMPATIBILITY
.Fn sigpause
now takes a signal value and not a mask.
This often appears as a hang in sigpause$UNIX2003
or with
.Fn sigpause
returning with
.Va errno
set to EINVAL.
Use
.Fn sigsuspend
with signal masks.
.Sh SEE ALSO
.Xr kill 2 ,
.Xr sigaction 2 ,
.Xr sigblock 2 ,
.Xr sigprocmask 2 ,
.Xr sigsuspend 2 ,
.Xr sigvec 2
.Sh HISTORY
The
.Fn sigpause
function call appeared in
.Bx 4.2
and has been deprecated.
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1983, 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	.\"
5b2abdfb A	32	.\" @(#)sigpause.2 8.1 (Berkeley) 6/2/93
5b2abdfb A	33	.\" $FreeBSD: src/lib/libc/compat-43/sigpause.2,v 1.5.2.5 2001/12/14 18:33:49 ru Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd June 2, 1993
5b2abdfb A	36	.Dt SIGPAUSE 2
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm sigpause
5b2abdfb A	40	.Nd atomically release blocked signals and wait for interrupt
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
5b2abdfb	44	.In signal.h
e9ce8d39	45	.Ft int
224c7076	46	.Fn sigpause "int sig"
e9ce8d39	47	.Sh DESCRIPTION
5b2abdfb A	48	.Sy This interface is made obsolete by
	49	.Xr sigsuspend 2 .
	50	.Pp
	51	.Fn Sigpause
	52	assigns
224c7076	53	.Fa sig
5b2abdfb A	54	to the set of masked signals
	55	and then waits for a signal to arrive;
	56	on return the set of masked signals is restored.
224c7076 A	57	.Fa Sig
224c7076 A	58	is usually 0, indicating that no
5b2abdfb A	59	signals are to be blocked.
	60	.Fn Sigpause
	61	always terminates by being interrupted, returning -1 with
	62	.Va errno
	63	set to
224c7076 A	64	.Er EINTR .
	65	.Sh COMPATIBILITY
	66	.Fn sigpause
	67	now takes a signal value and not a mask.
	68	This often appears as a hang in sigpause$UNIX2003
	69	or with
	70	.Fn sigpause
	71	returning with
	72	.Va errno
	73	set to EINVAL.
	74	Use
	75	.Fn sigsuspend
	76	with signal masks.
e9ce8d39	77	.Sh SEE ALSO
5b2abdfb A	78	.Xr kill 2 ,
	79	.Xr sigaction 2 ,
	80	.Xr sigblock 2 ,
	81	.Xr sigprocmask 2 ,
	82	.Xr sigsuspend 2 ,
	83	.Xr sigvec 2
e9ce8d39 A	84	.Sh HISTORY
e9ce8d39 A	85	The
5b2abdfb A	86	.Fn sigpause
	87	function call appeared in
	88	.Bx 4.2
	89	and has been deprecated.