xref: /openbsd-src/lib/libc/compat-43/sigpause.3 (revision 6a10513e4a2d1bbd153303cf3a722a5635e217f7)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" 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. 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.\"
28.\"	$OpenBSD: sigpause.3,v 1.15 2022/12/13 06:56:06 jmc Exp $
29.\"
30.Dd $Mdocdate: December 13 2022 $
31.Dt SIGPAUSE 3
32.Os
33.Sh NAME
34.Nm sigpause
35.Nd atomically release blocked signals and wait for interrupt
36.Sh SYNOPSIS
37.In signal.h
38.Ft int
39.Fn sigpause "int sigmask"
40.Sh DESCRIPTION
41.Bf -symbolic
42This interface is made obsolete by
43.Xr sigsuspend 2 .
44.Ef
45.Pp
46.Fn sigpause
47assigns
48.Fa sigmask
49to the set of masked signals
50and then waits for a signal to arrive;
51on return the set of masked signals is restored.
52.Fa sigmask
53is usually 0 to indicate that no
54signals are to be blocked.
55.Fn sigpause
56always terminates by being interrupted, returning \-1 with
57.Va errno
58set to
59.Er EINTR .
60.Sh SEE ALSO
61.Xr kill 2 ,
62.Xr sigaction 2 ,
63.Xr sigprocmask 2 ,
64.Xr sigsuspend 2 ,
65.Xr sigblock 3 ,
66.Xr sigvec 3
67.Sh HISTORY
68A
69.Fn sigpause
70system call first appeared in
71.Bx 4.2 .
72In
73.Bx 4.3 Reno ,
74it was reimplemented as a wrapper around
75.Xr sigsuspend 2 .
76The old system call was kept for compatibility until
77.Ox 4.9 .
78