Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / lib / libcr / compat-43 / sigpause.2
1 .\" Copyright (c) 1983, 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 .\"     @(#)sigpause.2  8.1 (Berkeley) 6/2/93
33 .\" $FreeBSD: src/lib/libc/compat-43/sigpause.2,v 1.5.2.6 2003/03/15 15:11:05 trhodes Exp $
34 .\" $DragonFly: src/lib/libcr/compat-43/Attic/sigpause.2,v 1.2 2003/06/17 04:26:41 dillon Exp $
35 .\"
36 .Dd June 2, 1993
37 .Dt SIGPAUSE 2
38 .Os
39 .Sh NAME
40 .Nm sigpause
41 .Nd atomically release blocked signals and wait for interrupt
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In signal.h
46 .Ft int
47 .Fn sigpause "int sigmask"
48 .Sh DESCRIPTION
49 .Sy This interface is made obsolete by
50 .Xr sigsuspend 2 .
51 .Pp
52 The
53 .Fn sigpause
54 function
55 assigns
56 .Fa sigmask
57 to the set of masked signals
58 and then waits for a signal to arrive;
59 on return the set of masked signals is restored.
60 The
61 .Fa sigmask
62 argument
63 is usually 0 to indicate that no
64 signals are to be blocked.
65 The
66 .Fn sigpause
67 function
68 always terminates by being interrupted, returning -1 with
69 .Va errno
70 set to
71 .Er EINTR
72 .Sh SEE ALSO
73 .Xr kill 2 ,
74 .Xr sigaction 2 ,
75 .Xr sigblock 2 ,
76 .Xr sigprocmask 2 ,
77 .Xr sigsuspend 2 ,
78 .Xr sigvec 2
79 .Sh HISTORY
80 The
81 .Fn sigpause
82 function appeared in
83 .Bx 4.2
84 and has been deprecated.