xref: /freebsd/lib/libc/gen/pause.3 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1.\" Copyright (c) 1980, 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. 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.Dd April 3, 2022
29.Dt PAUSE 3
30.Os
31.Sh NAME
32.Nm pause
33.Nd stop until signal
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In unistd.h
38.Ft int
39.Fn pause void
40.Sh DESCRIPTION
41.Sy Pause is made obsolete by
42.Xr sigsuspend 2 .
43.Pp
44The
45.Fn pause
46function
47forces a process to pause until
48a signal is received from either the
49.Xr kill 2
50function
51or an interval timer.
52(See
53.Xr setitimer 2 . )
54Upon termination of a signal handler started during a
55.Fn pause ,
56the
57.Fn pause
58call will return.
59.Sh RETURN VALUES
60Always returns \-1.
61.Sh ERRORS
62The
63.Fn pause
64function
65always returns:
66.Bl -tag -width Er
67.It Bq Er EINTR
68The call was interrupted.
69.El
70.Sh SEE ALSO
71.Xr kill 2 ,
72.Xr select 2 ,
73.Xr sigsuspend 2
74.Sh HISTORY
75A
76.Fn pause
77system call first appeared in the Programmer's Workbench (PWB/UNIX)
78and was then ported to
79.At v7 .
80It was reimplemeted as a wrapper around the
81.Fn sigpause
82and
83.Fn sigblock
84system calls in
85.Bx 4.2 ,
86and around the
87.Xr sigsuspend 2
88and
89.Xr sigprocmask 2
90system calls in
91.Bx 4.3 Reno .
92