1.\"	$NetBSD: pause.3,v 1.15 2003/08/07 16:42:55 agc 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.\"     @(#)pause.3	8.1 (Berkeley) 6/4/93
31.\"
32.Dd June 4, 1993
33.Dt PAUSE 3
34.Os
35.Sh NAME
36.Nm pause
37.Nd stop until signal
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In 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 poll 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