xref: /dragonfly/lib/libc/gen/pause.3 (revision 984263bc)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)pause.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libc/gen/pause.3,v 1.3.2.5 2001/12/14 18:33:51 ru Exp $
34.\"
35.Dd June 4, 1993
36.Dt PAUSE 3
37.Os
38.Sh NAME
39.Nm pause
40.Nd stop until signal
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In unistd.h
45.Ft int
46.Fn pause void
47.Sh DESCRIPTION
48.Sy Pause is made obsolete by
49.Xr sigsuspend 2 .
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 sigsuspend 2
81.Sh HISTORY
82A
83.Fn pause
84syscall
85appeared in
86.At v6 .
87