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