Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / compat-43 / sigpause.3
bloba5602da59d802bcbc962c5710ace799edca3e678
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. 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 .\"     from: @(#)sigpause.2    8.1 (Berkeley) 6/2/93
29 .\"     $NetBSD: sigpause.3,v 1.14 2003/04/16 13:34:35 wiz Exp $
30 .\"
31 .Dd June 2, 1993
32 .Dt SIGPAUSE 3
33 .Os
34 .Sh NAME
35 .Nm sigpause
36 .Nd atomically release blocked signals and wait for interrupt
37 .Sh LIBRARY
38 .Lb libc
39 .Sh SYNOPSIS
40 .In signal.h
41 .Ft int
42 .Fn sigpause "int sigmask"
43 .Sh DESCRIPTION
44 .Bf -symbolic
45 This interface is made obsolete by
46 .Xr sigsuspend 2 .
47 .Ef
48 .Pp
49 .Fn sigpause
50 assigns
51 .Fa sigmask
52 to the set of masked signals
53 and then waits for a signal to arrive;
54 on return the set of masked signals is restored.
55 .Fa sigmask
56 is usually 0 to indicate that no
57 signals are to be blocked.
58 .Fn sigpause
59 always terminates by being interrupted, returning -1 with
60 .Va errno
61 set to
62 .Dv EINTR .
63 .Sh SEE ALSO
64 .Xr kill 2 ,
65 .Xr sigaction 2 ,
66 .Xr sigprocmask 2 ,
67 .Xr sigsuspend 2 ,
68 .Xr sigblock 3 ,
69 .Xr sigvec 3
70 .Sh HISTORY
71 The
72 .Fn sigpause
73 function call appeared in
74 .Bx 4.2
75 and has been deprecated.