Doc/lib/libtty.tex

   1 \section{\module{tty} ---
   2          Terminal control functions}
   3
   4 \declaremodule{standard}{tty}
   5   \platform{Unix}
   6 \moduleauthor{Steen Lumholt}{}
   7 \sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
   8 \modulesynopsis{Utility functions that perform common terminal control
   9                 operations.}
  10
  11 The \module{tty} module defines functions for putting the tty into
  12 cbreak and raw modes.
  13
  14 Because it requires the \refmodule{termios} module, it will work
  15 only on \UNIX.
  16
  17 The \module{tty} module defines the following functions:
  18
  19 \begin{funcdesc}{setraw}{fd\optional{, when}}
  20 Change the mode of the file descriptor \var{fd} to raw. If \var{when}
  21 is omitted, it defaults to \constant{termios.TCSAFLUSH}, and is passed
  22 to \function{termios.tcsetattr()}.
  23 \end{funcdesc}
  24
  25 \begin{funcdesc}{setcbreak}{fd\optional{, when}}
  26 Change the mode of file descriptor \var{fd} to cbreak. If \var{when}
  27 is omitted, it defaults to \constant{termios.TCSAFLUSH}, and is passed
  28 to \function{termios.tcsetattr()}.
  29 \end{funcdesc}
  30
  31
  32 \begin{seealso}
  33   \seemodule{termios}{Low-level terminal control interface.}
  34 \end{seealso}