2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (C) 2004 Andries Brouwer (aeb@cwi.nl)
|
|
|
|
.\"
|
|
|
|
.\" 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.
|
|
|
|
.\"
|
2005-11-29 15:13:21 +00:00
|
|
|
.TH SIGPAUSE 3 2005-12-01 "Linux 2.6" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.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 */"
|
|
|
|
.sp
|
2005-11-29 15:13:21 +00:00
|
|
|
.BI "int sigpause(int " sig "); /* System V / Unix95 */"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
Don't use this function. Use
|
|
|
|
.BR sigsuspend (2)
|
|
|
|
instead.
|
|
|
|
.LP
|
|
|
|
The function
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR sigpause ()
|
2004-11-03 13:51:07 +00:00
|
|
|
is designed to wait for some signal.
|
2005-11-29 15:13:21 +00:00
|
|
|
It changes the process's signal mask (set of blocked signals),
|
2004-11-03 13:51:07 +00:00
|
|
|
and then waits for a signal to arrive.
|
|
|
|
Upon arrival of a signal, the original signal mask is restored.
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
If
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR sigpause ()
|
2004-11-03 13:51:07 +00:00
|
|
|
returns, it was interrupted by a signal and the return value is \-1
|
|
|
|
with
|
|
|
|
.I errno
|
|
|
|
set to
|
|
|
|
.BR EINTR .
|
|
|
|
.SH HISTORY
|
|
|
|
The classical BSD version of this function appeared in 4.2BSD.
|
2005-11-29 15:13:21 +00:00
|
|
|
It sets the process's signal mask to
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR sigmask .
|
2005-11-29 15:13:21 +00:00
|
|
|
Unix95 standardized the incompatible System V version of
|
2006-06-03 01:26:30 +00:00
|
|
|
this function, which removes only the specified signal
|
2004-11-03 13:51:07 +00:00
|
|
|
.I sig
|
|
|
|
from the process' signal mask.
|
2006-08-03 13:57:30 +00:00
|
|
|
.\" __xpg_sigpause: Unix 95, spec 1170, SVID, SVr4, XPG
|
2004-11-03 13:51:07 +00:00
|
|
|
The unfortunate situation with two incompatible functions with the
|
|
|
|
same name was solved by the
|
|
|
|
.BR \%sigsuspend (2)
|
|
|
|
function, that takes a
|
2005-11-29 15:13:21 +00:00
|
|
|
.I "sigset_t *"
|
|
|
|
parameter (instead of an
|
|
|
|
.IR int ).
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
On Linux, this routine is a system call only on the Sparc (sparc64)
|
|
|
|
architecture. Libc4 and libc5 only know about the BSD version.
|
|
|
|
Glibc uses the BSD version unless _XOPEN_SOURCE is defined.
|
|
|
|
.\" .SH NOTE
|
|
|
|
.\" 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),
|
2005-11-29 15:01:54 +00:00
|
|
|
.BR sigblock (3),
|
|
|
|
.BR sigvec (3)
|