usr/src/lib/libc/gen/pause.3

.\" Copyright (c) 1980, 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)pause.3     6.3 (Berkeley) %G%
.\"
.Dd
.Dt PAUSE 3
.Os BSD 4
.Sh NAME
.Nm pause
.Nd stop until signal
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft int
.Fn pause void
.Sh DESCRIPTION
.Bf -symbolic
Pause is made obsolete by sigpause(3).
.Ef
.Pp
The
.Fn pause
function
forces a process to pause until
a signal is received from either the
.Xr kill 2
function
or an interval timer.
(See
.Xr setitimer 2 . )
Upon termination of a signal handler started during a
.Fn pause ,
the
.Fn pause
call will return.
.Sh RETURN VALUES
Always returns \-1.
.Sh ERRORS
The
.Fn pause
function
always returns:
.Bl -tag -width [EINTR]
.It Bq Er EINTR
The call was interrupted.
.El
.Sh SEE ALSO
.Xr kill 2 ,
.Xr select 2 ,
.Xr sigpause 2
.Sh HISTORY
A
.Fn pause
syscall
appeared in
.At v6 .