summaryrefslogtreecommitdiffstats
path: root/Doc/library/tty.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-08-15 14:28:22 (GMT)
committerGeorg Brandl <georg@python.org>2007-08-15 14:28:22 (GMT)
commit116aa62bf54a39697e25f21d6cf6799f7faa1349 (patch)
tree8db5729518ed4ca88e26f1e26cc8695151ca3eb3 /Doc/library/tty.rst
parent739c01d47b9118d04e5722333f0e6b4d0c8bdd9e (diff)
downloadcpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.zip
cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.gz
cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.bz2
Move the 3k reST doc tree in place.
Diffstat (limited to 'Doc/library/tty.rst')
-rw-r--r--Doc/library/tty.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/Doc/library/tty.rst b/Doc/library/tty.rst
new file mode 100644
index 0000000..688faee
--- /dev/null
+++ b/Doc/library/tty.rst
@@ -0,0 +1,38 @@
+
+:mod:`tty` --- Terminal control functions
+=========================================
+
+.. module:: tty
+ :platform: Unix
+ :synopsis: Utility functions that perform common terminal control operations.
+.. moduleauthor:: Steen Lumholt
+.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
+
+
+The :mod:`tty` module defines functions for putting the tty into cbreak and raw
+modes.
+
+Because it requires the :mod:`termios` module, it will work only on Unix.
+
+The :mod:`tty` module defines the following functions:
+
+
+.. function:: setraw(fd[, when])
+
+ Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it
+ defaults to :const:`termios.TCSAFLUSH`, and is passed to
+ :func:`termios.tcsetattr`.
+
+
+.. function:: setcbreak(fd[, when])
+
+ Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it
+ defaults to :const:`termios.TCSAFLUSH`, and is passed to
+ :func:`termios.tcsetattr`.
+
+
+.. seealso::
+
+ Module :mod:`termios`
+ Low-level terminal control interface.
+