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