tty module documentation from Moshe, with some editing and an added

"See also" section.

1 files changed, 36 insertions, 0 deletions

diff --git a/Doc/lib/libtty.tex b/Doc/lib/libtty.tex
new file mode 100644
index 0000000..9d2a42a
--- /dev/null
+++ b/Doc/lib/libtty.tex
@@ -0,0 +1,36 @@
+\section{\module{tty} ---
+         Terminal control functions}
+
+\declaremodule{standard}{tty}
+  \platform{Unix}
+\moduleauthor{Steen Lumholt}{}
+\sectionauthor{Moshe Zadka}{mzadka@geocities.com}
+\modulesynopsis{Utility functions that perform common terminal control
+                operations.}
+
+The \module{tty} module defines functions for putting the tty into
+cbreak and raw modes.
+
+Because it requires the \refmodule{termios} module, it will work
+only on \UNIX{}.
+
+The \module{tty} module defines the following functions:
+
+\begin{funcdesc}{setraw}{fd\optional{, when}}
+Change the mode of the file descriptor \var{fd} to raw. If \var{when}
+is omitted, it defaults to \constant{TERMIOS.TCAFLUSH}, and is passed
+to \function{termios.tcsetattr()}.
+\end{funcdesc}
+
+\begin{funcdesc}{setcbreak}{fd\optional{, when}}
+Change the mode of file descriptor \var{fd} to cbreak. If \var{when}
+is omitted, it defaults to \constant{TERMIOS.TCAFLUSH}, and is passed
+to \function{termios.tcsetattr()}.
+\end{funcdesc}
+
+
+\begin{seealso}
+  \seemodule{termios}{Low-level terminal control interface.}
+  \seemodule[TERMIOSuppercase]{TERMIOS}{Constants useful for terminal
+                                        control operations.}
+\end{seealso}