Thomas Wouters <thomas@xs4all.net>:

Documentation updates related to the addition of openpty() and forkpty().

2 files changed, 25 insertions, 0 deletions

diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex
index e9302d1..c506a05 100644
--- a/Doc/lib/libos.tex
+++ b/Doc/lib/libos.tex
@@ -367,6 +367,14 @@ object'' with \method{read()} and \method{write()} methods (and many
 more).
 \end{funcdesc}
 
+\begin{funcdesc}{openpty}{}
+Open a new pseudo-terminal pair. Return a pair of file descriptors
+\code{(\var{master}, \var{slave})} for the pty and the tty,
+respectively. For a (slightly) more portable approach, use the
+\refmodule{pty}\refstmodindex{pty} module.
+Availability: Some flavors of \UNIX{}
+\end{funcdesc}
+
 \begin{funcdesc}{pipe}{}
 Create a pipe.  Return a pair of file descriptors \code{(\var{r},
 \var{w})} usable for reading and writing, respectively.
@@ -791,6 +799,16 @@ process id in the parent.
 Availability: \UNIX{}.
 \end{funcdesc}
 
+\begin{funcdesc}{forkpty}{}
+Fork a child process, using a new pseudo-terminal as the child's
+controlling terminal. Return a pair of \code{(\var{pid}, \var{fd})},
+where \var{pid} is \code{0} in the child, the new child's process id
+in the parent, and \code{fd} is the file descriptor of the master end
+of the pseudo-terminal.  For a more portable approach, use the
+\refmodule{pty} module.
+Availability: Some flavors of \UNIX{}
+\end{funcdesc}
+
 \begin{funcdesc}{kill}{pid, sig}
 \index{process!killing}
 \index{process!signalling}
diff --git a/Doc/lib/libpty.tex b/Doc/lib/libpty.tex
index 5ef3d0f..aca9052 100644
--- a/Doc/lib/libpty.tex
+++ b/Doc/lib/libpty.tex
@@ -26,6 +26,13 @@ descriptor connected to the child's controlling terminal (and also
 to the child's standard input and output.
 \end{funcdesc}
 
+\begin{funcdesc}{openpty}{}
+Open a new pseudo-terminal pair, using \function{os.openpty()} if
+possible, or emulation code for SGI and generic \UNIX{} systems.
+Return a pair of file descriptors \code{(\var{master}, \var{slave})},
+for the master and the slave end, respectively.
+\end{funcdesc}
+
 \begin{funcdesc}{spawn}{argv\optional{, master_read\optional{, stdin_read}}}
 Spawn a process, and connect its controlling terminal with the current 
 process's standard io. This is often used to baffle programs which