xref: /openbsd/lib/libc/gen/pause.3 (revision 66f07096)
1.\"	$OpenBSD: pause.3,v 1.3 1997/06/13 13:12:31 deraadt 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. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd June 4, 1993
35.Dt PAUSE 3
36.Os BSD 4
37.Sh NAME
38.Nm pause
39.Nd stop until signal
40.Sh SYNOPSIS
41.Fd #include <unistd.h>
42.Ft int
43.Fn pause void
44.Sh DESCRIPTION
45.Bf -symbolic
46Pause is made obsolete by
47.Xr sigsuspend 2 .
48.Ef
49.Pp
50The
51.Fn pause
52function
53forces a process to pause until
54a signal is received from either the
55.Xr kill 2
56function
57or an interval timer.
58(See
59.Xr setitimer 2 . )
60Upon termination of a signal handler started during a
61.Fn pause ,
62the
63.Fn pause
64call will return.
65.Sh RETURN VALUES
66Always returns \-1.
67.Sh ERRORS
68The
69.Fn pause
70function
71always returns:
72.Bl -tag -width Er
73.It Bq Er EINTR
74The call was interrupted.
75.El
76.Sh SEE ALSO
77.Xr kill 2 ,
78.Xr select 2 ,
79.Xr setitimer 2 ,
80.Xr sigsuspend 2
81.Sh HISTORY
82A
83.Fn pause
84syscall
85appeared in
86.At v6 .
87