xref: /freebsd/lib/libc/compat-43/sigpause.2 (revision 7660b554bc59a07be0431c17e0e33815818baa69)
1.\" Copyright (c) 1983, 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.\"     @(#)sigpause.2	8.1 (Berkeley) 6/2/93
33.\" $FreeBSD$
34.\"
35.Dd June 2, 1993
36.Dt SIGPAUSE 2
37.Os
38.Sh NAME
39.Nm sigpause
40.Nd atomically release blocked signals and wait for interrupt
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In signal.h
45.Ft int
46.Fn sigpause "int sigmask"
47.Sh DESCRIPTION
48.Sy This interface is made obsolete by
49.Xr sigsuspend 2 .
50.Pp
51The
52.Fn sigpause
53function
54assigns
55.Fa sigmask
56to the set of masked signals
57and then waits for a signal to arrive;
58on return the set of masked signals is restored.
59The
60.Fa sigmask
61argument
62is usually 0 to indicate that no
63signals are to be blocked.
64The
65.Fn sigpause
66function
67always terminates by being interrupted, returning -1 with
68.Va errno
69set to
70.Er EINTR
71.Sh SEE ALSO
72.Xr kill 2 ,
73.Xr sigaction 2 ,
74.Xr sigblock 2 ,
75.Xr sigprocmask 2 ,
76.Xr sigsuspend 2 ,
77.Xr sigvec 2
78.Sh STANDARDS
79The
80.Fn sigpause
81function is implemented for compatibility with historic
82.Bx 4.3
83applications.
84An incompatible interface by the same name, which used a single signal number
85rather than a mask, was present in
86.At V ,
87and was copied from there into the
88.Sy X/Open System Interfaces
89.Pq Tn XSI
90option of
91.St -p1003.1-2001 .
92.Sh HISTORY
93The
94.Fn sigpause
95function appeared in
96.Bx 4.2
97and has been deprecated.
98