xref: /dragonfly/lib/libc/gen/pause.3 (revision 73610d44)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)pause.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD: src/lib/libc/gen/pause.3,v 1.3.2.5 2001/12/14 18:33:51 ru Exp $
30.\" $DragonFly: src/lib/libc/gen/pause.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
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.Sy Pause is made obsolete by
46.Xr sigsuspend 2 .
47.Pp
48The
49.Fn pause
50function
51forces a process to pause until
52a signal is received from either the
53.Xr kill 2
54function
55or an interval timer.
56(See
57.Xr setitimer 2 . )
58Upon termination of a signal handler started during a
59.Fn pause ,
60the
61.Fn pause
62call will return.
63.Sh RETURN VALUES
64Always returns \-1.
65.Sh ERRORS
66The
67.Fn pause
68function
69always returns:
70.Bl -tag -width Er
71.It Bq Er EINTR
72The call was interrupted.
73.El
74.Sh SEE ALSO
75.Xr kill 2 ,
76.Xr select 2 ,
77.Xr sigsuspend 2
78.Sh HISTORY
79A
80.Fn pause
81syscall
82appeared in
83.At v6 .
84