4.4BSD/usr/src/old/man/wait3.2j

.\" Copyright (c) 1980 Regents of the University of California.
.\" All rights reserved.  The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\"	@(#)wait3.2j	4.1 (Berkeley) 5/9/85
.\"
.TH WAIT3 2J
.UC 4
.SH NAME
wait3 \- wait for process to terminate
.SH SYNOPSIS
.nf
.B "#include <wait.h>"
.B "#include <sys/vtimes.h>"
.PP
.B wait3(status, options, vtimep)
.B union wait status;
.B int options;
.B struct vtimes *vtimep;
.PP
.B cc ... \-ljobs
.fi
.SH DESCRIPTION
The
.I status
and
.I option
words are described by definitions and macros in the file
<wait.h>; the union and its bitfield definitions and associated
macros given there provide
convenient and mnemonic access to the word of status returned by a
.I wait3
call.
See this file for more information.
.PP
There are two
.I options,
which may be combined by
.IR or ing
them together.
The first is WNOHANG which causes the
.I wait3
to not hang if there are no
processes which wish to report status, rather returning a pid of 0 in this
case as the result of the
.I wait3.
The second option is WUNTRACED which causes
.I wait3
to return information when children of the current process which are
stopped but not traced (with
.IR ptrace (2))
because they received a SIGTTIN, SIGTTOU, SIGTSTP or SIGSTOP signal.
See
.IR sigsys (2))
for a description of these signals.
.PP
The
.I vtimep
pointer is an optional structure where a
.I vtimes
structure is returned describing the resources used by the terminated
process and all its children.  This may be given as \*(lq0\*(rq if the
information is not desired.  Currently this information is not available
for stopped processes.
.SH "SEE ALSO"
wait(2), exit(2), fork(2), sigsys(2)
.SH DIAGNOSTICS
Returns
\-1 if there are no children not previously waited for, or 0 if the WNOHANG
option is given and there are no stopped or exited children.
.SH BUGS
This call is peculiar to this version of UNIX.
The options and specifications of this system call and even the call itself
are subject to change.  It may be replaced by other facilities in future
versions of the system.