Blame man-pages-posix-2013-a/man3p/pause.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH PAUSE "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
pause
Packit 7cfc04
\(em suspend the thread until a signal is received
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <unistd.h>
Packit 7cfc04
.P
Packit 7cfc04
int pause(void);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
\fIpause\fR()
Packit 7cfc04
function shall suspend the calling thread until delivery of a signal
Packit 7cfc04
whose action is either to execute a signal-catching function or to
Packit 7cfc04
terminate the process.
Packit 7cfc04
.P
Packit 7cfc04
If the action is to terminate the process,
Packit 7cfc04
\fIpause\fR()
Packit 7cfc04
shall not return.
Packit 7cfc04
.P
Packit 7cfc04
If the action is to execute a signal-catching function,
Packit 7cfc04
\fIpause\fR()
Packit 7cfc04
shall return after the signal-catching function returns.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Since
Packit 7cfc04
\fIpause\fR()
Packit 7cfc04
suspends thread execution indefinitely unless interrupted by a signal,
Packit 7cfc04
there is no successful completion return value. A value of \(mi1 shall
Packit 7cfc04
be returned and
Packit 7cfc04
.IR errno
Packit 7cfc04
set to indicate the error.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
The
Packit 7cfc04
\fIpause\fR()
Packit 7cfc04
function shall fail if:
Packit 7cfc04
.TP
Packit 7cfc04
.BR EINTR
Packit 7cfc04
A signal is caught by the calling process and control is returned from
Packit 7cfc04
the signal-catching function.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
Many common uses of
Packit 7cfc04
\fIpause\fR()
Packit 7cfc04
have timing windows. The scenario involves checking a condition
Packit 7cfc04
related to a signal and, if the signal has not occurred, calling
Packit 7cfc04
\fIpause\fR().
Packit 7cfc04
When the signal occurs between the check and the call to
Packit 7cfc04
\fIpause\fR(),
Packit 7cfc04
the process often blocks indefinitely. The
Packit 7cfc04
\fIsigprocmask\fR()
Packit 7cfc04
and
Packit 7cfc04
\fIsigsuspend\fR()
Packit 7cfc04
functions can be used to avoid this type of problem.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
None.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIsigsuspend\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "\fB<unistd.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .