xref: /netbsd-src/lib/libc/gen/pause.3 (revision cda4f8f6ee55684e8d311b86c99ea59191e6b74f)
1.\" Copyright (c) 1980, 1991 Regents of the University of California.
2.\" 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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)pause.3	6.3 (Berkeley) 4/19/91
33.\"	$Id: pause.3,v 1.2 1993/07/30 08:37:59 mycroft Exp $
34.\"
35.Dd April 19, 1991
36.Dt PAUSE 3
37.Os BSD 4
38.Sh NAME
39.Nm pause
40.Nd stop until signal
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft int
44.Fn pause void
45.Sh DESCRIPTION
46.Bf -symbolic
47Pause is made obsolete by sigpause(3).
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 [EINTR]
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 sigpause 2
80.Sh HISTORY
81A
82.Fn pause
83syscall
84appeared in
85.At v6 .
86