mirror of https://github.com/mkerrisk/man-pages
133 lines
4.0 KiB
Groff
133 lines
4.0 KiB
Groff
.\" Copyright (C) 2004 Andries Brouwer (aeb@cwi.nl)
|
|
.\"
|
|
.\" %%%LICENSE_START(VERBATIM)
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
.\" preserved on all copies.
|
|
.\"
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
.\" permission notice identical to this one.
|
|
.\"
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
.\" have taken the same level of care in the production of this manual,
|
|
.\" which is licensed free of charge, as they might when working
|
|
.\" professionally.
|
|
.\"
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
.\" %%%LICENSE_END
|
|
.\"
|
|
.TH SIGPAUSE 3 2015-08-08 "Linux" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
sigpause \- atomically release blocked signals and wait for interrupt
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.B #include <signal.h>
|
|
.sp
|
|
.BI "int sigpause(int " sigmask "); /* BSD (but see NOTES) */"
|
|
.sp
|
|
.BI "int sigpause(int " sig "); /* System V / UNIX 95 */"
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Don't use this function.
|
|
Use
|
|
.BR sigsuspend (2)
|
|
instead.
|
|
.LP
|
|
The function
|
|
.BR sigpause ()
|
|
is designed to wait for some signal.
|
|
It changes the process's signal mask (set of blocked signals),
|
|
and then waits for a signal to arrive.
|
|
Upon arrival of a signal, the original signal mask is restored.
|
|
.SH RETURN VALUE
|
|
If
|
|
.BR sigpause ()
|
|
returns, it was interrupted by a signal and the return value is \-1
|
|
with
|
|
.I errno
|
|
set to
|
|
.BR EINTR .
|
|
.SH ATTRIBUTES
|
|
For an explanation of the terms used in this section, see
|
|
.BR attributes (7).
|
|
.TS
|
|
allbox;
|
|
lb lb lb
|
|
l l l.
|
|
Interface Attribute Value
|
|
T{
|
|
.BR sigpause ()
|
|
.\" FIXME: the following marking is different from which in glibc manual,
|
|
.\" marking in glibc manual is more detailed.
|
|
.\" sigpause: MT-Unsafe race:sigprocmask/!bsd!linux
|
|
.\" glibc manual says /!linux!bsd indicate the preceding marker only applies
|
|
.\" when the underlying kernel is neither Linux nor a BSD kernel.
|
|
.\" So, it is safety in Linux kernel.
|
|
T} Thread safety MT-Safe
|
|
.TE
|
|
.SH CONFORMING TO
|
|
The System V version of
|
|
.BR sigpause ()
|
|
is standardized in POSIX.1-2001.
|
|
It is also specified in POSIX.1-2008, where it is marked obsolete.
|
|
.SH NOTES
|
|
.SS History
|
|
The classical BSD version of this function appeared in 4.2BSD.
|
|
It sets the process's signal mask to
|
|
.IR sigmask .
|
|
UNIX 95 standardized the incompatible System V version of
|
|
this function, which removes only the specified signal
|
|
.I sig
|
|
from the process's signal mask.
|
|
.\" __xpg_sigpause: UNIX 95, spec 1170, SVID, SVr4, XPG
|
|
The unfortunate situation with two incompatible functions with the
|
|
same name was solved by the
|
|
.BR \%sigsuspend (2)
|
|
function, that takes a
|
|
.I "sigset_t\ *"
|
|
argument (instead of an
|
|
.IR int ).
|
|
.SS Linux notes
|
|
On Linux, this routine is a system call only on the Sparc (sparc64)
|
|
architecture.
|
|
|
|
.\" Libc4 and libc5 know only about the BSD version.
|
|
.\"
|
|
Glibc uses the BSD version if the
|
|
.B _BSD_SOURCE
|
|
feature test macro is defined and none of
|
|
.BR _POSIX_SOURCE ,
|
|
.BR _POSIX_C_SOURCE ,
|
|
.BR _XOPEN_SOURCE ,
|
|
.BR _GNU_SOURCE ,
|
|
or
|
|
.B _SVID_SOURCE
|
|
is defined.
|
|
Otherwise, the System V version is used (and
|
|
.BR _XOPEN_SOURCE
|
|
must be defined to obtain the declaration).
|
|
Since glibc 2.19, only the System V version is exposed by
|
|
.IR <signal.h> ;
|
|
applications that formerly used the BSD
|
|
.BR sigpause ()
|
|
should be amended to use
|
|
.BR sigsuspend (2).
|
|
.\"
|
|
.\" For the BSD version, one usually uses a zero
|
|
.\" .I sigmask
|
|
.\" to indicate that no signals are to be blocked.
|
|
.SH SEE ALSO
|
|
.BR kill (2),
|
|
.BR sigaction (2),
|
|
.BR sigprocmask (2),
|
|
.BR sigsuspend (2),
|
|
.BR sigblock (3),
|
|
.BR sigvec (3),
|
|
.BR feature_test_macros (7)
|