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