Doc/lib/libtty.tex

\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}