xref: /netbsd-src/lib/libc/gen/sigsetops.3 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\"	$NetBSD: sigsetops.3,v 1.9 2000/06/07 19:47:59 nathanw Exp $
2.\"
3.\" Copyright (c) 1983, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)sigsetops.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt SIGSETOPS 3
38.Os
39.Sh NAME
40.Nm sigemptyset ,
41.Nm sigfillset ,
42.Nm sigaddset ,
43.Nm sigdelset ,
44.Nm sigismember
45.Nd manipulate signal sets
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.Fd #include <signal.h>
50.Ft int
51.Fn sigemptyset "sigset_t *set"
52.Ft int
53.Fn sigfillset "sigset_t *set"
54.Ft int
55.Fn sigaddset "sigset_t *set" "int signo"
56.Ft int
57.Fn sigdelset "sigset_t *set" "int signo"
58.Ft int
59.Fn sigismember "sigset_t *set" "int signo"
60.Sh DESCRIPTION
61These functions manipulate signal sets stored in a
62.Fa sigset_t .
63Either
64.Fn sigemptyset
65or
66.Fn sigfillset
67must be called for every object of type
68.Fa sigset_t
69before any other use of the object.
70.Fn sigemptyset
71and
72.Fn sigfillset
73are provided as macros, but actual functions are available
74if their names are undefined (with #undef
75.Em name ) .
76.Pp
77The
78.Fn sigemptyset
79function initializes a signal set to be empty.
80.Pp
81The
82.Fn sigfillset
83function initializes a signal set to contain all signals.
84.Pp
85The
86.Fn sigaddset
87function adds the specified signal
88.Fa signo
89to the signal set.
90.Pp
91The
92.Fn sigdelset
93function deletes the specified signal
94.Fa signo
95from the signal set.
96.Pp
97The
98.Fn sigismember
99function returns whether a specified signal
100.Fa signo
101is contained in the signal set.
102.Pp
103These functions
104are provided as macros in the include file <signal.h>.
105Actual functions are available
106if their names are undefined (with #undef
107.Em name ) .
108.Sh RETURN VALUES
109The
110.Fn sigismember
111function returns 1
112if the signal is a member of the set,
113a 0 otherwise.
114The other functions return 0 upon success.
115A \-1 return value
116indicates an error occurred and the global variable
117.Va errno
118is set to indicate the reason.
119.Sh ERRORS
120These functions could fail if one of the following occurs:
121.Bl -tag -width Er
122.It Bq Er EINVAL
123.Fa signo
124has an invalid value.
125.El
126.Sh SEE ALSO
127.Xr kill 2 ,
128.Xr sigaction 2 ,
129.Xr sigsuspend 2
130.Sh STANDARDS
131These functions conform to
132.St -p1003.1-90 .
133