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