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