usr/src/man/man2/pause.2

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PAUSE 2 "Dec 28, 1996"
   7 .SH NAME
   8 pause \- suspend process until signal
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <unistd.h>
  13
  14 \fBint\fR \fBpause\fR(\fBvoid\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBpause()\fR function suspends the calling process until it receives a
  21 signal. The signal must be one that is not currently set to be ignored by the
  22 calling process.
  23 .sp
  24 .LP
  25 If the signal causes termination of the calling process, \fBpause()\fR does not
  26 return.
  27 .sp
  28 .LP
  29 If the signal is caught by the calling process and control is returned from the
  30 signal-catching function (see \fBsignal\fR(3C)), the calling process resumes
  31 execution from the point of suspension.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 Since \fBpause()\fR suspends thread  execution indefinitely unless interrupted
  36 by a signal, there is no successful completion return value.  If interrupted,
  37 it returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  38 .SH ERRORS
  39 .sp
  40 .LP
  41 The \fBpause()\fR function will fail if:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBEINTR\fR\fR
  46 .ad
  47 .RS 9n
  48 A signal is caught by the calling process and control is returned from the
  49 signal-catching function.
  50 .RE
  51
  52 .SH ATTRIBUTES
  53 .sp
  54 .LP
  55 See \fBattributes\fR(5) for descriptions of the following attributes:
  56 .sp
  57
  58 .sp
  59 .TS
  60 box;
  61 c | c
  62 l | l .
  63 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  64 _
  65 Interface Stability     Standard
  66 _
  67 MT-Level        Async-Signal-Safe
  68 .TE
  69
  70 .SH SEE ALSO
  71 .sp
  72 .LP
  73 \fBalarm\fR(2), \fBkill\fR(2), \fBsignal\fR(3C), \fBwait\fR(3C),
  74 \fBattributes\fR(5), \fBstandards\fR(5)