Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libtty.tex @ 25838:8540887bcec6 2.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Backport of 2.183: Fix memory leak in add_subclass() found by NealN with valgrind.
author Guido van Rossum <guido@python.org>
date Fri, 18 Oct 2002 13:42:21 +0000
parents bc02c3b09626
children a6eac3fe542f 26e4211865ed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11038
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1 \section{\module{tty} ---
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
2 Terminal control functions}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4 \declaremodule{standard}{tty}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
5 \platform{Unix}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
6 \moduleauthor{Steen Lumholt}{}
15467
d7864345b1c8 Update Moshe Zadka's email address to one works and might last a while.
Fred Drake <fdrake@acm.org>
parents: 11038
diff changeset
7 \sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
11038
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
8 \modulesynopsis{Utility functions that perform common terminal control
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
9 operations.}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
10
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
11 The \module{tty} module defines functions for putting the tty into
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
12 cbreak and raw modes.
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
13
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
14 Because it requires the \refmodule{termios} module, it will work
21062
bc02c3b09626 Clean up some markup cruft. A number of the macros that take no
Fred Drake <fdrake@acm.org>
parents: 15467
diff changeset
15 only on \UNIX.
11038
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
16
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
17 The \module{tty} module defines the following functions:
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
18
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
19 \begin{funcdesc}{setraw}{fd\optional{, when}}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
20 Change the mode of the file descriptor \var{fd} to raw. If \var{when}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
21 is omitted, it defaults to \constant{TERMIOS.TCAFLUSH}, and is passed
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
22 to \function{termios.tcsetattr()}.
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
23 \end{funcdesc}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
24
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
25 \begin{funcdesc}{setcbreak}{fd\optional{, when}}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
26 Change the mode of file descriptor \var{fd} to cbreak. If \var{when}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
27 is omitted, it defaults to \constant{TERMIOS.TCAFLUSH}, and is passed
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
28 to \function{termios.tcsetattr()}.
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
29 \end{funcdesc}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
30
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
31
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
32 \begin{seealso}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
33 \seemodule{termios}{Low-level terminal control interface.}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
34 \seemodule[TERMIOSuppercase]{TERMIOS}{Constants useful for terminal
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
35 control operations.}
5fa96d050319 tty module documentation from Moshe, with some editing and an added
Fred Drake <fdrake@acm.org>
parents:
diff changeset
36 \end{seealso}