usr/src/man/man3head/wait.h.3head

   1 '\" te
   2 .\" Copyright 1989 AT&T. Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH WAIT.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 wait.h, wait \- wait status
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fB#include <sys/wait.h>\fR
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 When a process waits for status from its children using either the
  23 \fBwait\fR(3C) or \fBwaitpid\fR(3C) function, the status returned can be
  24 evaluated with the following macros, defined in <\fBsys/wait.h\fR>. These
  25 macros evaluate to integral expressions. The \fIstat\fR argument to these
  26 macros is the integer value returned from \fBwait()\fR or \fBwaitpid()\fR.
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fBWCOREDUMP\fR(\fIstat\fR)\fR
  31 .ad
  32 .RS 22n
  33 If the value of \fBWIFSIGNALED\fR (\fIstat\fR) is non-zero, this macro
  34 evaluates to a non-zero value if a core image of the terminated child was
  35 created.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBWEXITSTATUS\fR(\fIstat\fR)\fR
  42 .ad
  43 .RS 22n
  44 If the value of  \fBWIFEXITED(\fR\fIstat\fR\fB)\fR is non-zero, this macro
  45 evaluates to the exit code that the child process passed to  \fB_exit()\fR (see
  46 \fBexit\fR(2)) or \fBexit\fR(3C), or the value that the child process returned
  47 from \fBmain\fR.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBWIFCONTINUED\fR(\fIstat\fR)\fR
  54 .ad
  55 .RS 22n
  56 Evaluates to a non-zero value if status was returned for a child process that
  57 has continued.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBWIFEXITED\fR(\fIstat\fR)\fR
  64 .ad
  65 .RS 22n
  66 Evaluates to a non-zero value if status was returned for a child process that
  67 terminated normally.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBWIFSIGNALED\fR(\fIstat\fR)\fR
  74 .ad
  75 .RS 22n
  76 Evaluates to a non-zero value if status was returned for a child process that
  77 terminated due to the receipt of a signal.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBWIFSTOPPED\fR(\fIstat\fR)\fR
  84 .ad
  85 .RS 22n
  86 Evaluates to a non-zero value if status was returned for a child process that
  87 is currently stopped.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBWSTOPSIG\fR(\fIstat\fR)\fR
  94 .ad
  95 .RS 22n
  96 If the value of \fBWIFSTOPPED(\fR\fIstat\fR\fB)\fR is non-zero, this macro
  97 evaluates to the number of the signal that caused the child process to stop.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBWTERMSIG\fR(\fIstat\fR)\fR
 104 .ad
 105 .RS 22n
 106 If the value of  \fBWIFSIGNALED\fR(\fIstat\fR) is non-zero, this macro
 107 evaluates to the number of the signal that caused the termination of the child
 108 process.
 109 .RE
 110
 111 .sp
 112 .LP
 113 The <\fBsys/wait.h\fR> header defines the symbolic constants listed below for
 114 use with \fBwaitpid\fR(3C).
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBWNOHANG\fR\fR
 119 .ad
 120 .RS 13n
 121 Do not hang if no status is available; return immediately.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBWUNTRACED\fR\fR
 128 .ad
 129 .RS 13n
 130 Report status of stopped child process.
 131 .RE
 132
 133 .sp
 134 .LP
 135 The symbolic constants listed below are defined as possible values for the
 136 \fIoptions\fR argument to \fBwaitid\fR(2).
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBWEXITED\fR\fR
 141 .ad
 142 .RS 14n
 143 Wait for processes that have exited.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBWSTOPPED\fR\fR
 150 .ad
 151 .RS 14n
 152 Status is returned for any child that has stopped upon receipt of a signal.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBWCONTINUED\fR\fR
 159 .ad
 160 .RS 14n
 161 Status is returned for any child that was stopped and has been continued.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBWNOHANG\fR\fR
 168 .ad
 169 .RS 14n
 170 Return immediately if there are no children to wait for.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBWNOWAIT\fR\fR
 177 .ad
 178 .RS 14n
 179 Keep the process whose status is returned in \fBinfop\fR in a waitable state.
 180 .RE
 181
 182 .sp
 183 .LP
 184 The type \fBidtype_t\fR is defined as an enumeration type whose possible values
 185 include the following:
 186 .sp
 187 .in +2
 188 .nf
 189 P_ALL
 190 P_PID
 191 P_PGID
 192 .fi
 193 .in -2
 194
 195 .sp
 196 .LP
 197 The \fBid_t\fR and \fBpid_t\fR types are defined as described in
 198 <\fBsys/types.h\fR>.
 199 .sp
 200 .LP
 201 The \fBsiginfo_t\fR type is defined as described in <\fBsignal.h\fR>.
 202 .sp
 203 .LP
 204 The \fBrusage\fR structure is defined as described in <\fBsys/resource.h\fR>.
 205 .sp
 206 .LP
 207 Inclusion of the <\fBsys/wait.h\fR> header can also make visible all symbols
 208 from <\fBsignal.h\fR> and <\fBsys/resource.h\fR>.
 209 .SH ATTRIBUTES
 210 .sp
 211 .LP
 212 See \fBattributes\fR(5) for descriptions of the following attributes:
 213 .sp
 214
 215 .sp
 216 .TS
 217 box;
 218 c | c
 219 l | l .
 220 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 221 _
 222 Interface Stability     Standard
 223 .TE
 224
 225 .SH SEE ALSO
 226 .sp
 227 .LP
 228 \fBexit\fR(2), \fBwaitid\fR(2), \fBexit\fR(3C), \fBwait\fR(3C),
 229 \fBwaitpid\fR(3C),\fBattributes\fR(5), \fBstandards\fR(5)