aboutsummaryrefslogtreecommitdiff
path: root/unix/os/doc/zclcpr.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /unix/os/doc/zclcpr.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'unix/os/doc/zclcpr.hlp')
-rw-r--r--unix/os/doc/zclcpr.hlp33
1 files changed, 33 insertions, 0 deletions
diff --git a/unix/os/doc/zclcpr.hlp b/unix/os/doc/zclcpr.hlp
new file mode 100644
index 00000000..55574785
--- /dev/null
+++ b/unix/os/doc/zclcpr.hlp
@@ -0,0 +1,33 @@
+.help zclcpr May84 "System Interface"
+.ih
+NAME
+zclcpr -- close or disconnect a connected subprocess
+.ih
+SYNOPSIS
+.nf
+zclcpr (pid, exit_status)
+
+int pid # process id (a magic integer)
+int exit_status # termination code from process
+.fi
+.ih
+DESCRIPTION
+Disconnect a subprocess previously connected with \fBzopcpr\fR,
+i.e., close the IPC channels and wait for the subprocess to terminate.
+Control does not return until the child process has terminated.
+
+If the child process attempts to write to the parent after the IPC channels
+have been closed the X_IPC exception will be raised in the child process.
+If the child attempts to read from the parent after the parent has
+disconnected, the child will see EOF on the read and will shutdown.
+.ih
+RETURN VALUE
+The integer termination code of the child process is returned in
+\fIexit_status\fR. A status of OK (zero) indicates normal termination.
+ERR is returned for an illegal \fIpid\fR.
+If the child terminates abnormally, i.e., if a panic exit occurs, the positive
+integer error code of the error which caused process termination is returned.
+.ih
+SEE ALSO
+zopcpr, zintpr, zxwhen
+.endhelp