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