projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| bbf12550 KM |
1 | .\" Copyright (c) 1980 Regents of the University of California. |
| 2 | .\" All rights reserved. The Berkeley software License Agreement | |
| 3 | .\" specifies the terms and conditions for redistribution. | |
| 4 | .\" | |
| 5 | .\" @(#)wait3.2j 4.1 (Berkeley) %G% | |
| 6 | .\" | |
| 7 | .TH WAIT3 2J | |
| 8 | .UC 4 | |
| 9 | .SH NAME | |
| 10 | wait3 \- wait for process to terminate | |
| 11 | .SH SYNOPSIS | |
| 12 | .nf | |
| 13 | .B "#include <wait.h>" | |
| 14 | .B "#include <sys/vtimes.h>" | |
| 15 | .PP | |
| 16 | .B wait3(status, options, vtimep) | |
| 17 | .B union wait status; | |
| 18 | .B int options; | |
| 19 | .B struct vtimes *vtimep; | |
| 20 | .PP | |
| 21 | .B cc ... \-ljobs | |
| 22 | .fi | |
| 23 | .SH DESCRIPTION | |
| 24 | The | |
| 25 | .I status | |
| 26 | and | |
| 27 | .I option | |
| 28 | words are described by definitions and macros in the file | |
| 29 | <wait.h>; the union and its bitfield definitions and associated | |
| 30 | macros given there provide | |
| 31 | convenient and mnemonic access to the word of status returned by a | |
| 32 | .I wait3 | |
| 33 | call. | |
| 34 | See this file for more information. | |
| 35 | .PP | |
| 36 | There are two | |
| 37 | .I options, | |
| 38 | which may be combined by | |
| 39 | .IR or ing | |
| 40 | them together. | |
| 41 | The first is WNOHANG which causes the | |
| 42 | .I wait3 | |
| 43 | to not hang if there are no | |
| 44 | processes which wish to report status, rather returning a pid of 0 in this | |
| 45 | case as the result of the | |
| 46 | .I wait3. | |
| 47 | The second option is WUNTRACED which causes | |
| 48 | .I wait3 | |
| 49 | to return information when children of the current process which are | |
| 50 | stopped but not traced (with | |
| 51 | .IR ptrace (2)) | |
| 52 | because they received a SIGTTIN, SIGTTOU, SIGTSTP or SIGSTOP signal. | |
| 53 | See | |
| 54 | .IR sigsys (2)) | |
| 55 | for a description of these signals. | |
| 56 | .PP | |
| 57 | The | |
| 58 | .I vtimep | |
| 59 | pointer is an optional structure where a | |
| 60 | .I vtimes | |
| 61 | structure is returned describing the resources used by the terminated | |
| 62 | process and all its children. This may be given as \*(lq0\*(rq if the | |
| 63 | information is not desired. Currently this information is not available | |
| 64 | for stopped processes. | |
| 65 | .SH "SEE ALSO" | |
| 66 | wait(2), exit(2), fork(2), sigsys(2) | |
| 67 | .SH DIAGNOSTICS | |
| 68 | Returns | |
| 69 | \-1 if there are no children not previously waited for, or 0 if the WNOHANG | |
| 70 | option is given and there are no stopped or exited children. | |
| 71 | .SH BUGS | |
| 72 | This call is peculiar to this version of UNIX. | |
| 73 | The options and specifications of this system call and even the call itself | |
| 74 | are subject to change. It may be replaced by other facilities in future | |
| 75 | versions of the system. |