xref: /openbsd/lib/libc/gen/pause.3 (revision 6c9d614b)
1.\"	$OpenBSD: pause.3,v 1.17 2022/12/30 21:21:25 cheloha Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd $Mdocdate: December 30 2022 $
31.Dt PAUSE 3
32.Os
33.Sh NAME
34.Nm pause
35.Nd wait for a signal
36.Sh SYNOPSIS
37.In unistd.h
38.Ft int
39.Fn pause void
40.Sh DESCRIPTION
41.Bf -symbolic
42.Fn pause
43is obsoleted by
44.Xr sigsuspend 2 .
45.Ef
46.Pp
47.Fn pause
48blocks the calling thread until it receives an unmasked signal.
49.Sh RETURN VALUES
50.Fn pause
51always returns \-1.
52.Sh ERRORS
53.Fn pause
54always sets
55.Xr errno 2
56to the following value:
57.Bl -tag -width Er
58.It Bq Er EINTR
59The call was interrupted by a signal.
60.El
61.Sh SEE ALSO
62.Xr kill 2 ,
63.Xr setitimer 2 ,
64.Xr sigprocmask 2 ,
65.Xr sigsuspend 2 ,
66.Xr signal 3
67.Sh HISTORY
68A
69.Fn pause
70system call first appeared outside of Bell Labs in the
71.Dq 50 changes
72tape for
73.At v6 .
74It was first officially released with PWB/UNIX 1.0.
75It was reimplemented as a wrapper around the
76.Fn sigpause
77and
78.Fn sigblock
79system calls in
80.Bx 4.2 ,
81and around the
82.Xr sigsuspend 2
83and
84.Xr sigprocmask 2
85system calls in
86.Bx 4.3 Reno .
87