lib/libc/gen/sigsetops.3

   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 .\"     @(#)sigsetops.3 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/gen/sigsetops.3,v 1.4.2.3 2003/03/15 15:11:05 trhodes Exp $
  34 .\" $DragonFly: src/lib/libc/gen/sigsetops.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt SIGSETOPS 3
  38 .Os
  39 .Sh NAME
  40 .Nm sigemptyset ,
  41 .Nm sigfillset ,
  42 .Nm sigaddset ,
  43 .Nm sigdelset ,
  44 .Nm sigismember
  45 .Nd manipulate signal sets
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In signal.h
  50 .Ft int
  51 .Fn sigemptyset "sigset_t *set"
  52 .Ft int
  53 .Fn sigfillset "sigset_t *set"
  54 .Ft int
  55 .Fn sigaddset "sigset_t *set" "int signo"
  56 .Ft int
  57 .Fn sigdelset "sigset_t *set" "int signo"
  58 .Ft int
  59 .Fn sigismember "const sigset_t *set" "int signo"
  60 .Sh DESCRIPTION
  61 These functions manipulate signal sets stored in a
  62 .Fa sigset_t .
  63 Either
  64 .Fn sigemptyset
  65 or
  66 .Fn sigfillset
  67 must be called for every object of type
  68 .Fa sigset_t
  69 before any other use of the object.
  70 .Pp
  71 The
  72 .Fn sigemptyset
  73 function initializes a signal set to be empty.
  74 .Pp
  75 The
  76 .Fn sigfillset
  77 function initializes a signal set to contain all signals.
  78 .Pp
  79 The
  80 .Fn sigaddset
  81 function adds the specified signal
  82 .Fa signo
  83 to the signal set.
  84 .Pp
  85 The
  86 .Fn sigdelset
  87 function deletes the specified signal
  88 .Fa signo
  89 from the signal set.
  90 .Pp
  91 The
  92 .Fn sigismember
  93 function returns whether a specified signal
  94 .Fa signo
  95 is contained in the signal set.
  96 .Pp
  97 These functions
  98 are provided as macros in the include file <signal.h>.
  99 Actual functions are available
 100 if their names are undefined (with
 101 .Ic #undef Ar name ) .
 102 .Sh RETURN VALUES
 103 The
 104 .Fn sigismember
 105 function returns 1
 106 if the signal is a member of the set,
 107 0 otherwise.
 108 The other functions return 0.
 109 .Sh ERRORS
 110 Currently no errors are detected.
 111 .Sh SEE ALSO
 112 .Xr kill 2 ,
 113 .Xr sigaction 2 ,
 114 .Xr sigsuspend 2
 115 .Sh STANDARDS
 116 These functions are defined by
 117 .St -p1003.1-88 .