xref: /openbsd/lib/libc/gen/pause.3 (revision 771fbea0)
1.\"	$OpenBSD: pause.3,v 1.14 2015/09/23 08:52:56 sobrado 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: September 23 2015 $
31.Dt PAUSE 3
32.Os
33.Sh NAME
34.Nm pause
35.Nd stop until signal
36.Sh SYNOPSIS
37.In unistd.h
38.Ft int
39.Fn pause void
40.Sh DESCRIPTION
41.Bf -symbolic
42Pause is made obsolete by
43.Xr sigsuspend 2 .
44.Ef
45.Pp
46The
47.Fn pause
48function forces a process to pause until a signal is received from either the
49.Xr kill 2
50function or an interval timer
51(see
52.Xr setitimer 2 ) .
53.Pp
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 may set the global variable
65.Va errno
66to the following error:
67.Bl -tag -width Er
68.It Bq Er EINTR
69The call was interrupted.
70.El
71.Sh SEE ALSO
72.Xr kill 2 ,
73.Xr select 2 ,
74.Xr setitimer 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 reimplemented 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