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