Merge from vendor branch BZIP:
[dragonfly.git] / lib / libc / gen / pause.3
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 .\" $DragonFly: src/lib/libc/gen/pause.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
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 .In unistd.h
46 .Ft int
47 .Fn pause void
48 .Sh DESCRIPTION
49 .Sy Pause is made obsolete by
50 .Xr sigsuspend 2 .
51 .Pp
52 The
53 .Fn pause
54 function
55 forces a process to pause until
56 a signal is received from either the
57 .Xr kill 2
58 function
59 or an interval timer.
60 (See
61 .Xr setitimer 2 . )
62 Upon termination of a signal handler started during a
63 .Fn pause ,
64 the
65 .Fn pause
66 call will return.
67 .Sh RETURN VALUES
68 Always returns \-1.
69 .Sh ERRORS
70 The
71 .Fn pause
72 function
73 always returns:
74 .Bl -tag -width Er
75 .It Bq Er EINTR
76 The call was interrupted.
77 .El
78 .Sh SEE ALSO
79 .Xr kill 2 ,
80 .Xr select 2 ,
81 .Xr sigsuspend 2
82 .Sh HISTORY
83 A
84 .Fn pause
85 syscall
86 appeared in
87 .At v6 .