6/lib/libc/sys/sigprocmask.2

   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 .\"     @(#)sigprocmask.2       8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt SIGPROCMASK 2
  37 .Os
  38 .Sh NAME
  39 .Nm sigprocmask
  40 .Nd manipulate current signal mask
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In signal.h
  45 .Ft int
  46 .Fo sigprocmask
  47 .Fa "int how"
  48 .Fa "const sigset_t * restrict set"
  49 .Fa "sigset_t * restrict oset"
  50 .Fc
  51 .Sh DESCRIPTION
  52 The
  53 .Fn sigprocmask
  54 system call examines and/or changes the current signal mask (those signals
  55 that are blocked from delivery).
  56 Signals are blocked if they are members of the current signal mask set.
  57 .Pp
  58 If
  59 .Fa set
  60 is not null, the action of
  61 .Fn sigprocmask
  62 depends on the value of the
  63 .Fa how
  64 argument.
  65 The signal mask is changed as a function of the specified
  66 .Fa set
  67 and the current mask.
  68 The function is specified by
  69 .Fa how
  70 using one of the following values from
  71 .In signal.h :
  72 .Bl -tag -width SIG_UNBLOCK
  73 .It Dv SIG_BLOCK
  74 The new mask is the union of the current mask and the specified
  75 .Fa set .
  76 .It Dv SIG_UNBLOCK
  77 The new mask is the intersection of the current mask
  78 and the complement of the specified
  79 .Fa set .
  80 .It Dv SIG_SETMASK
  81 The current mask is replaced by the specified
  82 .Fa set .
  83 .El
  84 .Pp
  85 If
  86 .Fa oset
  87 is not null, it is set to
  88 the previous value of the signal mask.
  89 When
  90 .Fa set
  91 is null,
  92 the value of
  93 .Fa how
  94 is insignificant and the mask remains unset
  95 providing a way to examine the signal mask without modification.
  96 .Pp
  97 The system
  98 quietly disallows
  99 .Dv SIGKILL
 100 or
 101 .Dv SIGSTOP
 102 to be blocked.
 103 .Sh RETURN VALUES
 104 .Rv -std sigprocmask
 105 .Sh ERRORS
 106 The
 107 .Fn sigprocmask
 108 system call will fail and the signal mask will be unchanged if one
 109 of the following occurs:
 110 .Bl -tag -width Er
 111 .It Bq Er EINVAL
 112 The
 113 .Fa how
 114 argument
 115 has a value other than those listed here.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr kill 2 ,
 119 .Xr sigaction 2 ,
 120 .Xr sigpending 2 ,
 121 .Xr sigsuspend 2 ,
 122 .Xr fpsetmask 3 ,
 123 .Xr sigsetops 3
 124 .Sh STANDARDS
 125 The
 126 .Fn sigprocmask
 127 system call is expected to
 128 conform to
 129 .St -p1003.1-90 .