xref: /original-bsd/lib/libc/gen/sigsetops.3 (revision bdc0a208)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)sigsetops.3	6.2 (Berkeley) 04/19/91
7.\"
8.Dd
9.Dt SIGSETOPS 3
10.Os
11.Sh NAME
12.Nm sigsetops ,
13.Nm sigemptyset ,
14.Nm sigfillset ,
15.Nm sigaddset ,
16.Nm sigdelset ,
17.Nm sigismember
18.Nd manipulate signal masks
19.Sh SYNOPSIS
20.Fd #include <signal.h>
21.Fn sigemptyset "sigset_t *set"
22.Fn sigfillset "sigset_t *set"
23.Fn sigaddset "sigset_t *set" "int signo"
24.Fn sigdelset "sigset_t *set" "int signo"
25.Fn sigismember "sigset_t *set" "int signo"
26.Sh DESCRIPTION
27These functions manipulate signal mask stored in a
28.Fa sigset_t .
29They are provided as macros, but actual functions are available
30if their names are undefined (with #undef
31.Em name ) .
32.Pp
33The
34.Fn sigemptyset
35function initializes a signal set to be empty.
36The
37.Fn sigfillset
38function initializes a signal set to contain all of the known signals.
39One of these routines must be used to initialize a signal set
40before its use by the other functions.
41.Pp
42The
43.Fn sigaddset
44function adds a specified signal
45.Fa signo
46to a signal set.
47The
48.Fn sigdelset
49function deletes a specified signal
50.Fa signo
51from a signal set.
52.Pp
53The
54.Fn sigismember
55function tests whether a specified signal
56.Fa signo
57is contained in a signal set.
58.Sh RETURN VALUES
59The
60.Fn sigismember
61function returnes 1
62if the signal is a member of the set,
63a 0 otherwise.
64The other functions return 0 upon success.
65A \-1 return value
66indicates an error occurred and the global variable
67.Va errno
68is set to indicated the reason.
69The current implementation does not detect any errors.
70.Sh ERRORS
71These functions could fail if one of the following occurs:
72.Bl -tag -width [EINVAL]
73.It Bq Er EINVAL
74.Fa signo
75has an invalid value.
76.El
77.Sh SEE ALSO
78.Xr kill 2 ,
79.Xr sigaction 2 ,
80.Xr sigsetops 2 ,
81.Xr sigsuspend 2
82.Sh STANDARDS
83The
84These functions are defined by
85.St -p1003.1-88 .
86.Sh HISTORY
87These functions are
88.Ud .
89