xref: /netbsd-src/lib/libc/gen/pause.3 (revision fdecd6a253f999ae92b139670d9e15cc9df4497c)
1.\"	$NetBSD: pause.3,v 1.7 1997/05/16 16:03:53 kleink 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.\"     @(#)pause.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt PAUSE 3
38.Os BSD 4
39.Sh NAME
40.Nm pause
41.Nd stop until signal
42.Sh SYNOPSIS
43.Fd #include <unistd.h>
44.Ft int
45.Fn pause void
46.Sh DESCRIPTION
47.Bf -symbolic
48Pause is made obsolete by sigsuspend(2).
49.Ef
50.Pp
51The
52.Fn pause
53function
54forces a process to pause until
55a signal is received from either the
56.Xr kill 2
57function
58or an interval timer.
59(See
60.Xr setitimer 2 . )
61Upon termination of a signal handler started during a
62.Fn pause ,
63the
64.Fn pause
65call will return.
66.Sh RETURN VALUES
67Always returns \-1.
68.Sh ERRORS
69The
70.Fn pause
71function
72always returns:
73.Bl -tag -width Er
74.It Bq Er EINTR
75The call was interrupted.
76.El
77.Sh SEE ALSO
78.Xr kill 2 ,
79.Xr select 2 ,
80.Xr setitimer 2 ,
81.Xr sigsuspend 2
82.Sh STANDARDS
83The
84.Fn pause
85function conforms to
86.St -p1003.1-90 .
87.Sh HISTORY
88A
89.Fn pause
90syscall
91appeared in
92.At v6 .
93