xref: /freebsd/lib/libc/gen/sigsetops.3 (revision 3416500aef140042c64bc149cb1ec6620483bc44)
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$
30.\"
31.Dd December 16, 2004
32.Dt SIGSETOPS 3
33.Os
34.Sh NAME
35.Nm sigemptyset ,
36.Nm sigfillset ,
37.Nm sigaddset ,
38.Nm sigdelset ,
39.Nm sigismember
40.Nd manipulate signal sets
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In signal.h
45.Ft int
46.Fn sigemptyset "sigset_t *set"
47.Ft int
48.Fn sigfillset "sigset_t *set"
49.Ft int
50.Fn sigaddset "sigset_t *set" "int signo"
51.Ft int
52.Fn sigdelset "sigset_t *set" "int signo"
53.Ft int
54.Fn sigismember "const sigset_t *set" "int signo"
55.Sh DESCRIPTION
56These functions manipulate signal sets stored in a
57.Fa sigset_t .
58Either
59.Fn sigemptyset
60or
61.Fn sigfillset
62must be called for every object of type
63.Fa sigset_t
64before any other use of the object.
65.Pp
66The
67.Fn sigemptyset
68function initializes a signal set to be empty.
69.Pp
70The
71.Fn sigfillset
72function initializes a signal set to contain all signals.
73.Pp
74The
75.Fn sigaddset
76function adds the specified signal
77.Fa signo
78to the signal set.
79.Pp
80The
81.Fn sigdelset
82function deletes the specified signal
83.Fa signo
84from the signal set.
85.Pp
86The
87.Fn sigismember
88function returns whether a specified signal
89.Fa signo
90is contained in the signal set.
91.Sh RETURN VALUES
92The
93.Fn sigismember
94function returns 1
95if the signal is a member of the set,
960 otherwise.
97The other functions return 0 upon success.
98A \-1 return value
99indicates an error occurred and the global variable
100.Va errno
101is set to indicate the reason.
102.Sh ERRORS
103These functions could fail if one of the following occurs:
104.Bl -tag -width Er
105.It Bq Er EINVAL
106.Fa signo
107has an invalid value.
108.El
109.Sh SEE ALSO
110.Xr kill 2 ,
111.Xr sigaction 2 ,
112.Xr sigpending 2 ,
113.Xr sigprocmask 2 ,
114.Xr sigsuspend 2
115.Sh STANDARDS
116These functions are defined by
117.St -p1003.1-88 .
118