diff options
Diffstat (limited to 'doc/DetachPids.3')
| -rw-r--r-- | doc/DetachPids.3 | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/doc/DetachPids.3 b/doc/DetachPids.3 index 818fb32..39a51d3 100644 --- a/doc/DetachPids.3 +++ b/doc/DetachPids.3 @@ -5,10 +5,8 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: DetachPids.3,v 1.3 2001/04/03 14:53:45 andreas_kupries Exp $ -'\" -.so man.macros .TH Tcl_DetachPids 3 "" Tcl "Tcl Library Procedures" +.so man.macros .BS .SH NAME Tcl_DetachPids, Tcl_ReapDetachedProcs, Tcl_WaitPid \- manage child processes in background @@ -21,18 +19,18 @@ Tcl_DetachPids, Tcl_ReapDetachedProcs, Tcl_WaitPid \- manage child processes in \fBTcl_ReapDetachedProcs\fR() .sp Tcl_Pid -\fBTcl_WaitPid\fR(\fIpid, statPtr, options\fR) +\fBTcl_WaitPid\fR(\fIpid, statusPtr, options\fR) .SH ARGUMENTS -.AS int *statusPtr +.AS Tcl_Pid *statusPtr out .AP int numPids in Number of process ids contained in the array pointed to by \fIpidPtr\fR. .AP int *pidPtr in Address of array containing \fInumPids\fR process ids. .AP Tcl_Pid pid in The id of the process (pipe) to wait for. -.AP int* statPtr out +.AP int *statusPtr out The result of waiting on a process (pipe). Either 0 or ECHILD. -.AP int options +.AP int options in The options controlling the wait. WNOHANG specifies not to wait when checking the process. .BE @@ -51,16 +49,16 @@ overflow, even if all the children have exited. \fBTcl_DetachPids\fR may be called to ask Tcl to take responsibility for one or more processes whose process ids are contained in the \fIpidPtr\fR array passed as argument. The caller presumably -has started these processes running in background and doesn't +has started these processes running in background and does not want to have to deal with them again. .PP \fBTcl_ReapDetachedProcs\fR invokes the \fBwaitpid\fR kernel call on each of the background processes so that its state can be cleaned -up if it has exited. If the process hasn't exited yet, -\fBTcl_ReapDetachedProcs\fR doesn't wait for it to exit; it will check again +up if it has exited. If the process has not exited yet, +\fBTcl_ReapDetachedProcs\fR does not wait for it to exit; it will check again the next time it is invoked. Tcl automatically calls \fBTcl_ReapDetachedProcs\fR each time the -\fBexec\fR command is executed, so in most cases it isn't necessary +\fBexec\fR command is executed, so in most cases it is not necessary for any code outside of Tcl to invoke \fBTcl_ReapDetachedProcs\fR. However, if you call \fBTcl_DetachPids\fR in situations where the \fBexec\fR command may never get executed, you may wish to call |