lib/libc/gen/sigsetops.3

   1 .\"     $NetBSD: sigsetops.3,v 1.14 2003/08/07 16:42:57 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)sigsetops.3 8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt SIGSETOPS 3
  34 .Os
  35 .Sh NAME
  36 .Nm sigemptyset ,
  37 .Nm sigfillset ,
  38 .Nm sigaddset ,
  39 .Nm sigdelset ,
  40 .Nm sigismember
  41 .Nd manipulate signal sets
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In signal.h
  46 .Ft int
  47 .Fn sigemptyset "sigset_t *set"
  48 .Ft int
  49 .Fn sigfillset "sigset_t *set"
  50 .Ft int
  51 .Fn sigaddset "sigset_t *set" "int signo"
  52 .Ft int
  53 .Fn sigdelset "sigset_t *set" "int signo"
  54 .Ft int
  55 .Fn sigismember "sigset_t *set" "int signo"
  56 .Sh DESCRIPTION
  57 These functions manipulate signal sets stored in a
  58 .Fa sigset_t .
  59 Either
  60 .Fn sigemptyset
  61 or
  62 .Fn sigfillset
  63 must be called for every object of type
  64 .Fa sigset_t
  65 before any other use of the object.
  66 .Pp
  67 The
  68 .Fn sigemptyset
  69 function initializes a signal set to be empty.
  70 .Pp
  71 The
  72 .Fn sigfillset
  73 function initializes a signal set to contain all signals.
  74 .Pp
  75 The
  76 .Fn sigaddset
  77 function adds the specified signal
  78 .Fa signo
  79 to the signal set.
  80 .Pp
  81 The
  82 .Fn sigdelset
  83 function deletes the specified signal
  84 .Fa signo
  85 from the signal set.
  86 .Pp
  87 The
  88 .Fn sigismember
  89 function returns whether a specified signal
  90 .Fa signo
  91 is contained in the signal set.
  92 .Pp
  93 .Fn sigemptyset
  94 and
  95 .Fn sigfillset
  96 are provided as macros, but actual functions are available
  97 if their names are undefined (with #undef
  98 .Em name ) .
  99 .Sh RETURN VALUES
 100 The
 101 .Fn sigismember
 102 function returns 1
 103 if the signal is a member of the set,
 104 a 0 otherwise.
 105 The other functions return 0 upon success.
 106 A \-1 return value
 107 indicates an error occurred and the global variable
 108 .Va errno
 109 is set to indicate the reason.
 110 .Sh ERRORS
 111 These functions could fail if one of the following occurs:
 112 .Bl -tag -width Er
 113 .It Bq Er EINVAL
 114 .Fa signo
 115 has an invalid value.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr kill 2 ,
 119 .Xr sigaction 2 ,
 120 .Xr sigsuspend 2 ,
 121 .Xr signal 7
 122 .Sh STANDARDS
 123 These functions conform to
 124 .St -p1003.1-90 .