xref: /netbsd-src/lib/libc/gen/sigsetops.3 (revision 6ea46cb5e46c49111a6ecf3bcbe3c7e2730fe9f6)
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.5 1994/08/12 05:01:23 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 .
60.Fn sigemptyset
61and
62.Fn sigfillset
63are provided as macros, but actual functions are available
64if their names are undefined (with #undef
65.Em name ) .
66.Pp
67The
68.Fn sigemptyset
69function initializes a signal set to be empty.
70The
71.Fn sigfillset
72function initializes a signal set to contain all of the known signals.
73One of these routines must be used to initialize a signal set
74before its use by the other functions.
75.Pp
76The
77.Fn sigaddset
78function adds a specified signal
79.Fa signo
80to a signal set.
81The
82.Fn sigdelset
83function deletes a specified signal
84.Fa signo
85from a signal set.
86.Pp
87The
88.Fn sigismember
89function tests whether a specified signal
90.Fa signo
91is contained in a signal set.
92.Sh RETURN VALUES
93The
94.Fn sigismember
95function returns 1
96if the signal is a member of the set,
97a 0 otherwise.
98The other functions return 0 upon success.
99A \-1 return value
100indicates an error occurred and the global variable
101.Va errno
102is set to indicated the reason.
103.Sh ERRORS
104These functions could fail if one of the following occurs:
105.Bl -tag -width Er
106.It Bq Er EINVAL
107.Fa signo
108has an invalid value.
109.El
110.Sh SEE ALSO
111.Xr kill 2 ,
112.Xr sigaction 2 ,
113.Xr sigsetops 2 ,
114.Xr sigsuspend 2
115.Sh STANDARDS
116These functions are defined by
117.St -p1003.1-90 .
118