xref: /netbsd-src/lib/libc/gen/sigsetops.3 (revision ae1bfcddc410612bc8c58b807e1830becb69a24c)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" 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.\"     from: @(#)sigsetops.3	6.2 (Berkeley) 4/19/91
33.\"	$Id: sigsetops.3,v 1.4 1994/01/10 23:09:09 jtc Exp $
34.\"
35.Dd April 19, 1991
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 masks
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 "sigset_t *set" "int signo"
57.Sh DESCRIPTION
58These functions manipulate signal mask stored in a
59.Fa sigset_t .
60They are provided as macros, but actual functions are available
61if their names are undefined (with #undef
62.Em name ) .
63.Pp
64The
65.Fn sigemptyset
66function initializes a signal set to be empty.
67The
68.Fn sigfillset
69function initializes a signal set to contain all of the known signals.
70One of these routines must be used to initialize a signal set
71before its use by the other functions.
72.Pp
73The
74.Fn sigaddset
75function adds a specified signal
76.Fa signo
77to a signal set.
78The
79.Fn sigdelset
80function deletes a specified signal
81.Fa signo
82from a signal set.
83.Pp
84The
85.Fn sigismember
86function tests whether a specified signal
87.Fa signo
88is contained in a signal set.
89.Sh RETURN VALUES
90The
91.Fn sigismember
92function returns 1
93if the signal is a member of the set,
94a 0 otherwise.
95The other functions return 0 upon success.
96A \-1 return value
97indicates an error occurred and the global variable
98.Va errno
99is set to indicated the reason.
100The current implementation does not detect any errors.
101.Sh ERRORS
102These functions could fail if one of the following occurs:
103.Bl -tag -width Er
104.It Bq Er EINVAL
105.Fa signo
106has an invalid value.
107.El
108.Sh SEE ALSO
109.Xr kill 2 ,
110.Xr sigaction 2 ,
111.Xr sigsetops 2 ,
112.Xr sigsuspend 2
113.Sh STANDARDS
114These functions are defined by
115.St -p1003.1-90 .
116.Sh HISTORY
117These functions are
118.Ud .
119