xref: /third_party/python/Doc/library/tty.rst (revision 7db96d56)
17db96d56Sopenharmony_ci:mod:`tty` --- Terminal control functions
27db96d56Sopenharmony_ci=========================================
37db96d56Sopenharmony_ci
47db96d56Sopenharmony_ci.. module:: tty
57db96d56Sopenharmony_ci   :platform: Unix
67db96d56Sopenharmony_ci   :synopsis: Utility functions that perform common terminal control operations.
77db96d56Sopenharmony_ci
87db96d56Sopenharmony_ci.. moduleauthor:: Steen Lumholt
97db96d56Sopenharmony_ci.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
107db96d56Sopenharmony_ci
117db96d56Sopenharmony_ci**Source code:** :source:`Lib/tty.py`
127db96d56Sopenharmony_ci
137db96d56Sopenharmony_ci--------------
147db96d56Sopenharmony_ci
157db96d56Sopenharmony_ciThe :mod:`tty` module defines functions for putting the tty into cbreak and raw
167db96d56Sopenharmony_cimodes.
177db96d56Sopenharmony_ci
187db96d56Sopenharmony_ciBecause it requires the :mod:`termios` module, it will work only on Unix.
197db96d56Sopenharmony_ci
207db96d56Sopenharmony_ciThe :mod:`tty` module defines the following functions:
217db96d56Sopenharmony_ci
227db96d56Sopenharmony_ci
237db96d56Sopenharmony_ci.. function:: setraw(fd, when=termios.TCSAFLUSH)
247db96d56Sopenharmony_ci
257db96d56Sopenharmony_ci   Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it
267db96d56Sopenharmony_ci   defaults to :const:`termios.TCSAFLUSH`, and is passed to
277db96d56Sopenharmony_ci   :func:`termios.tcsetattr`.
287db96d56Sopenharmony_ci
297db96d56Sopenharmony_ci
307db96d56Sopenharmony_ci.. function:: setcbreak(fd, when=termios.TCSAFLUSH)
317db96d56Sopenharmony_ci
327db96d56Sopenharmony_ci   Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it
337db96d56Sopenharmony_ci   defaults to :const:`termios.TCSAFLUSH`, and is passed to
347db96d56Sopenharmony_ci   :func:`termios.tcsetattr`.
357db96d56Sopenharmony_ci
367db96d56Sopenharmony_ci
377db96d56Sopenharmony_ci.. seealso::
387db96d56Sopenharmony_ci
397db96d56Sopenharmony_ci   Module :mod:`termios`
407db96d56Sopenharmony_ci      Low-level terminal control interface.
417db96d56Sopenharmony_ci
42