mirror of
https://github.com/python/cpython.git
synced 2025-08-04 08:59:19 +00:00
tty module documentation from Moshe, with some editing and an added
"See also" section.
This commit is contained in:
parent
af81a509c3
commit
66239d5530
1 changed files with 36 additions and 0 deletions
36
Doc/lib/libtty.tex
Normal file
36
Doc/lib/libtty.tex
Normal file
|
@ -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}
|
Loading…
Add table
Add a link
Reference in a new issue