4.4BSD snapshot (revision 8.1)
[unix-history] / usr / src / lib / libc / gen / pause.3
CommitLineData
74155b62
KB
1.\" Copyright (c) 1980, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3619c480 3.\"
ae59e04c 4.\" %sccs.include.redist.man%
3619c480 5.\"
74155b62 6.\" @(#)pause.3 8.1 (Berkeley) %G%
ae59e04c
CL
7.\"
8.Dd
9.Dt PAUSE 3
10.Os BSD 4
11.Sh NAME
12.Nm pause
13.Nd stop until signal
14.Sh SYNOPSIS
15.Fd #include <unistd.h>
16.Ft int
17.Fn pause void
18.Sh DESCRIPTION
19.Bf -symbolic
e3800388 20Pause is made obsolete by sigpause(3).
ae59e04c
CL
21.Ef
22.Pp
23The
24.Fn pause
25function
26forces a process to pause until
27a signal is received from either the
28.Xr kill 2
29function
30or an interval timer.
31(See
32.Xr setitimer 2 . )
3619c480 33Upon termination of a signal handler started during a
ae59e04c 34.Fn pause ,
3619c480 35the
ae59e04c 36.Fn pause
3619c480 37call will return.
ae59e04c 38.Sh RETURN VALUES
3eee9a2c 39Always returns \-1.
ae59e04c
CL
40.Sh ERRORS
41The
42.Fn pause
43function
3eee9a2c 44always returns:
ae59e04c
CL
45.Bl -tag -width [EINTR]
46.It Bq Er EINTR
3eee9a2c 47The call was interrupted.
ae59e04c
CL
48.El
49.Sh SEE ALSO
50.Xr kill 2 ,
51.Xr select 2 ,
52.Xr sigpause 2
53.Sh HISTORY
54A
55.Fn pause
56syscall
57appeared in
58.At v6 .