Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / sys / sigpending.2
1 .\" Copyright (c) 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Berkeley Software Design, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)sigpending.2        8.3 (Berkeley) 1/12/94
36 .\" $FreeBSD: src/lib/libc/sys/sigpending.2,v 1.5.2.5 2001/12/14 18:34:01 ru Exp $
37 .\"
38 .Dd January 12, 1994
39 .Dt SIGPENDING 2
40 .Os
41 .Sh NAME
42 .Nm sigpending
43 .Nd get pending signals
44 .Sh LIBRARY
45 .Lb libc
46 .Sh SYNOPSIS
47 .In signal.h
48 .Ft int
49 .Fn sigpending "sigset_t *set"
50 .Sh DESCRIPTION
51 The
52 .Fn sigpending
53 function returns a mask of the signals pending for delivery
54 to the calling process in the location indicated by
55 .Fa set .
56 Signals may be pending because they are currently masked,
57 or transiently before delivery (although the latter case is not
58 normally detectable).
59 .Sh RETURN VALUES
60 .Rv -std sigpending
61 .Sh ERRORS
62 .Fn sigpending
63 will fail if:
64 .Bl -tag -width Er
65 .It Bq Er EFAULT
66 The
67 .Fa set
68 argument specified an invalid address.
69 .El
70 .Sh SEE ALSO
71 .Xr sigaction 2 ,
72 .Xr sigprocmask 2
73 .Sh STANDARDS
74 The
75 .Fn sigpending
76 function call is expected to conform to
77 .St -p1003.1-90 .