xref: /freebsd/lib/libc/gen/sigsetops.3 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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.\"     @(#)sigsetops.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd June 4, 1993
36.Dt SIGSETOPS 3
37.Os
38.Sh NAME
39.Nm sigemptyset ,
40.Nm sigfillset ,
41.Nm sigaddset ,
42.Nm sigdelset ,
43.Nm sigismember
44.Nd manipulate signal sets
45.Sh SYNOPSIS
46.Fd #include <signal.h>
47.Ft int
48.Fn sigemptyset "sigset_t *set"
49.Ft int
50.Fn sigfillset "sigset_t *set"
51.Ft int
52.Fn sigaddset "sigset_t *set" "int signo"
53.Ft int
54.Fn sigdelset "sigset_t *set" "int signo"
55.Ft int
56.Fn sigismember "const sigset_t *set" "int signo"
57.Sh DESCRIPTION
58These functions manipulate signal sets stored in a
59.Fa sigset_t .
60Either
61.Fn sigemptyset
62or
63.Fn sigfillset
64must be called for every object of type
65.Fa sigset_t
66before any other use of the object.
67.Pp
68The
69.Fn sigemptyset
70function initializes a signal set to be empty.
71.Pp
72The
73.Fn sigfillset
74function initializes a signal set to contain all signals.
75.Pp
76The
77.Fn sigaddset
78function adds the specified signal
79.Fa signo
80to the signal set.
81.Pp
82The
83.Fn sigdelset
84function deletes the specified signal
85.Fa signo
86from the signal set.
87.Pp
88The
89.Fn sigismember
90function returns whether a specified signal
91.Fa signo
92is contained in the signal set.
93.Pp
94These functions
95are provided as macros in the include file <signal.h>.
96Actual functions are available
97if their names are undefined (with #undef
98.Em name ) .
99.Sh RETURN VALUES
100The
101.Fn sigismember
102function returns 1
103if the signal is a member of the set,
1040 otherwise.
105The other functions return 0.
106.Sh ERRORS
107Currently no errors are detected.
108.Sh SEE ALSO
109.Xr kill 2 ,
110.Xr sigaction 2 ,
111.Xr sigsuspend 2
112.Sh STANDARDS
113These functions are defined by
114.St -p1003.1-88 .
115