lib/libc/gen/sigset.3

   1 .\"     $NetBSD: sigset.3,v 1.5 2005/07/24 21:58:32 rpaulo Exp $
   2 .\"
   3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Klaus Klein.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd July 24, 2005
  31 .Dt SIGSET 3
  32 .Os
  33 .Sh NAME
  34 .Nm sigset
  35 .Nd manipulate signal dispositions
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In signal.h
  40 .\" The following is Quite Ugly, but syntactically correct.  Don't try to
  41 .\" fix it.
  42 .Ft void \*(lp*
  43 .Fn sigset "int sig" "void \*(lp*disp\*(rp\*(lpint\*(rp\*(rp\*(rp\*(lpint"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 This interface is made obsolete by
  47 .Xr sigaction 2
  48 and
  49 .Xr sigprocmask 2 .
  50 .Ef
  51 .Pp
  52 The
  53 .Fn sigset
  54 function manipulates the disposition of the signal
  55 .Fa sig .
  56 The new disposition is given in
  57 .Fa disp .
  58 .Pp
  59 If
  60 .Fa disp
  61 is one of
  62 .Dv SIG_DFL ,
  63 .Dv SIG_IGN ,
  64 or the address of a handler function,
  65 the disposition of
  66 .Fa sig
  67 is changed accordingly, and
  68 .Fa sig
  69 is removed from the process' signal mask.
  70 Also, if
  71 .Fa disp
  72 is the address of a handler function,
  73 .Fa sig
  74 will be added to the process' signal mask during execution of the handler.
  75 .Pp
  76 If
  77 .Fa disp
  78 is equal to
  79 .Dv SIG_HOLD ,
  80 .Fa sig
  81 is added to the calling process' signal mask and the disposition of
  82 .Fa sig
  83 remains unchanged.
  84 .Sh RETURN VALUES
  85 If successful, the
  86 .Fn sigset
  87 function returns
  88 .Dv SIG_HOLD
  89 if
  90 .Fa sig
  91 had been blocked,
  92 and the previous disposition of
  93 .Fa sig
  94 if it had not been blocked.
  95 Otherwise
  96 .Dv SIG_ERR
  97 is returned and
  98 .Va errno
  99 is set to indicate the error.
 100 .Sh ERRORS
 101 The
 102 .Fn sigset
 103 function will fail if:
 104 .Bl -tag -width Er
 105 .It Bq Er EINVAL
 106 The argument
 107 .Fa sig
 108 is not a valid signal number.
 109 .It Bq Er EINVAL
 110 An attempt is made to ignore a signal that cannot be ignored,
 111 such as
 112 .Dv SIGKILL
 113 or
 114 .Dv SIGSTOP .
 115 .El
 116 .Sh SEE ALSO
 117 .Xr sigaction 2 ,
 118 .Xr sigprocmask 2
 119 .Sh STANDARDS
 120 The
 121 .Fn sigset
 122 function conforms to
 123 .St -p1003.1-2001 .