xref: /dragonfly/lib/libc/gen/sigsetops.3 (revision 0ca59c34)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)sigsetops.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD: src/lib/libc/gen/sigsetops.3,v 1.4.2.3 2003/03/15 15:11:05 trhodes Exp $
30.\" $DragonFly: src/lib/libc/gen/sigsetops.3,v 1.3 2006/05/26 19:39:36 swildner Exp $
31.\"
32.Dd June 4, 1993
33.Dt SIGSETOPS 3
34.Os
35.Sh NAME
36.Nm sigemptyset ,
37.Nm sigfillset ,
38.Nm sigaddset ,
39.Nm sigdelset ,
40.Nm sigismember
41.Nd manipulate signal sets
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In signal.h
46.Ft int
47.Fn sigemptyset "sigset_t *set"
48.Ft int
49.Fn sigfillset "sigset_t *set"
50.Ft int
51.Fn sigaddset "sigset_t *set" "int signo"
52.Ft int
53.Fn sigdelset "sigset_t *set" "int signo"
54.Ft int
55.Fn sigismember "const sigset_t *set" "int signo"
56.Sh DESCRIPTION
57These functions manipulate signal sets stored in a
58.Fa sigset_t .
59Either
60.Fn sigemptyset
61or
62.Fn sigfillset
63must be called for every object of type
64.Fa sigset_t
65before any other use of the object.
66.Pp
67The
68.Fn sigemptyset
69function initializes a signal set to be empty.
70.Pp
71The
72.Fn sigfillset
73function initializes a signal set to contain all signals.
74.Pp
75The
76.Fn sigaddset
77function adds the specified signal
78.Fa signo
79to the signal set.
80.Pp
81The
82.Fn sigdelset
83function deletes the specified signal
84.Fa signo
85from the signal set.
86.Pp
87The
88.Fn sigismember
89function returns whether a specified signal
90.Fa signo
91is contained in the signal set.
92.Pp
93These functions
94are provided as macros in the include file
95.In signal.h .
96Actual functions are available
97if their names are undefined (with
98.Ic #undef Ar name ) .
99.Sh RETURN VALUES
100The
101.Fn sigismember
102function returns 1
103if the signal is a member of the set,
1040 otherwise.
105The other functions return 0.
106.Sh ERRORS
107Currently no errors are detected.
108.Sh SEE ALSO
109.Xr kill 2 ,
110.Xr sigaction 2 ,
111.Xr sigsuspend 2
112.Sh STANDARDS
113These functions are defined by
114.St -p1003.1-88 .
115