xref: /openbsd-src/lib/libc/sys/sigprocmask.2 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: sigprocmask.2,v 1.5 2000/10/18 05:12:12 aaron Exp $
2.\"	$NetBSD: sigprocmask.2,v 1.6 1995/02/27 12:37:33 cgd Exp $
3.\"
4.\" Copyright (c) 1983, 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)sigprocmask.2	8.1 (Berkeley) 6/4/93
36.\"
37.Dd June 4, 1993
38.Dt SIGPROCMASK 2
39.Os
40.Sh NAME
41.Nm sigprocmask
42.Nd manipulate current signal mask
43.Sh SYNOPSIS
44.Fd #include <signal.h>
45.Ft int
46.Fn sigprocmask "int how" "const sigset_t *set" "sigset_t *oset"
47.Sh DESCRIPTION
48The
49.Fn sigprocmask
50function examines and/or changes the current signal mask (those signals
51that are blocked from delivery).
52Signals are blocked if they are members of the current signal mask set.
53.Pp
54If
55.Fa set
56is not null, the action of
57.Fn sigprocmask
58depends on the value of the parameter
59.Fa how .
60The signal mask is changed as a function of the specified
61.Fa set
62and the current mask.
63The function is specified by
64.Fa how
65using one of the following values from
66.Aq Pa signal.h :
67.Bl -tag -width SIG_UNBLOCK
68.It Dv SIG_BLOCK
69The new mask is the union of the current mask and the specified
70.Fa set .
71.It Dv SIG_UNBLOCK
72The new mask is the intersection of the current mask
73and the complement of the specified
74.Fa set .
75.It Dv SIG_SETMASK
76The current mask is replaced by the specified
77.Fa set .
78.El
79.Pp
80If
81.Fa oset
82is not null, it is set to
83the previous value of the signal mask.
84When
85.Fa set
86is null,
87the value of
88.Ar how
89is insignificant and the mask remains unset
90providing a way to examine the signal mask without modification.
91.Pp
92The system
93quietly disallows
94.Dv SIGKILL
95or
96.Dv SIGSTOP
97to be blocked.
98.Sh RETURN VALUES
99A 0 value indicated that the call succeeded.
100A \-1 return value indicates an error occurred and
101.Va errno
102is set to indicated the reason.
103.Sh ERRORS
104The
105.Fn sigprocmask
106call will fail and the signal mask will be unchanged if one
107of the following occurs:
108.Bl -tag -width Er
109.It Bq Er EINVAL
110.Fa how
111has a value other than those listed here.
112.El
113.Sh SEE ALSO
114.Xr kill 2 ,
115.Xr sigaction 2 ,
116.Xr sigsuspend 2 ,
117.Xr sigsetops 3
118.Sh STANDARDS
119The
120.Fn sigprocmask
121function call is expected to conform to
122.St -p1003.1-88 .
123