xref: /dragonfly/lib/libc/gen/sigsetops.3 (revision 984263bc)
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.\" $FreeBSD: src/lib/libc/gen/sigsetops.3,v 1.4.2.3 2003/03/15 15:11:05 trhodes Exp $
34.\"
35.Dd June 4, 1993
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 sets
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In signal.h
49.Ft int
50.Fn sigemptyset "sigset_t *set"
51.Ft int
52.Fn sigfillset "sigset_t *set"
53.Ft int
54.Fn sigaddset "sigset_t *set" "int signo"
55.Ft int
56.Fn sigdelset "sigset_t *set" "int signo"
57.Ft int
58.Fn sigismember "const sigset_t *set" "int signo"
59.Sh DESCRIPTION
60These functions manipulate signal sets stored in a
61.Fa sigset_t .
62Either
63.Fn sigemptyset
64or
65.Fn sigfillset
66must be called for every object of type
67.Fa sigset_t
68before any other use of the object.
69.Pp
70The
71.Fn sigemptyset
72function initializes a signal set to be empty.
73.Pp
74The
75.Fn sigfillset
76function initializes a signal set to contain all signals.
77.Pp
78The
79.Fn sigaddset
80function adds the specified signal
81.Fa signo
82to the signal set.
83.Pp
84The
85.Fn sigdelset
86function deletes the specified signal
87.Fa signo
88from the signal set.
89.Pp
90The
91.Fn sigismember
92function returns whether a specified signal
93.Fa signo
94is contained in the signal set.
95.Pp
96These functions
97are provided as macros in the include file <signal.h>.
98Actual functions are available
99if their names are undefined (with
100.Ic #undef Ar name ) .
101.Sh RETURN VALUES
102The
103.Fn sigismember
104function returns 1
105if the signal is a member of the set,
1060 otherwise.
107The other functions return 0.
108.Sh ERRORS
109Currently no errors are detected.
110.Sh SEE ALSO
111.Xr kill 2 ,
112.Xr sigaction 2 ,
113.Xr sigsuspend 2
114.Sh STANDARDS
115These functions are defined by
116.St -p1003.1-88 .
117