lib/libc/compat-43/sigpause.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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)sigpause.2  8.1 (Berkeley) 6/2/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 2, 1993
  32 .Dt SIGPAUSE 2
  33 .Os
  34 .Sh NAME
  35 .Nm sigpause
  36 .Nd atomically release blocked signals and wait for interrupt
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In signal.h
  41 .Ft int
  42 .Fn sigpause "int sigmask"
  43 .Sh DESCRIPTION
  44 .Sy This interface is made obsolete by
  45 .Xr sigsuspend 2 .
  46 .Pp
  47 The
  48 .Fn sigpause
  49 function
  50 assigns
  51 .Fa sigmask
  52 to the set of masked signals
  53 and then waits for a signal to arrive;
  54 on return the set of masked signals is restored.
  55 The
  56 .Fa sigmask
  57 argument
  58 is usually 0 to indicate that no
  59 signals are to be blocked.
  60 The
  61 .Fn sigpause
  62 function
  63 always terminates by being interrupted, returning -1 with
  64 .Va errno
  65 set to
  66 .Er EINTR
  67 .Sh SEE ALSO
  68 .Xr kill 2 ,
  69 .Xr sigaction 2 ,
  70 .Xr sigblock 2 ,
  71 .Xr sigprocmask 2 ,
  72 .Xr sigsuspend 2 ,
  73 .Xr sigvec 2
  74 .Sh STANDARDS
  75 The
  76 .Fn sigpause
  77 function is implemented for compatibility with historic
  78 .Bx 4.3
  79 applications.
  80 An incompatible interface by the same name, which used a single signal number
  81 rather than a mask, was present in
  82 .At V ,
  83 and was copied from there into the
  84 .Sy X/Open System Interfaces
  85 .Pq Tn XSI
  86 option of
  87 .St -p1003.1-2001 .
  88 .Sh HISTORY
  89 The
  90 .Fn sigpause
  91 function appeared in
  92 .Bx 4.2
  93 and has been deprecated.