/Doc/library/tty.rst

http://unladen-swallow.googlecode.com/ · ReStructuredText · 38 lines · 22 code · 16 blank · 0 comment · 0 complexity · ad1b12de51efa082e40642b5981a6602 MD5 · raw file 

    

  1. :mod:`tty` --- Terminal control functions
    2. 

  2. =========================================
    3. 

  3. 

  4. .. module:: tty
    5. 

  5.    :platform: Unix
    6. 

  6.    :synopsis: Utility functions that perform common terminal control operations.
    7. 

  7. .. moduleauthor:: Steen Lumholt
    8. 

  8. .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
    9. 

  9. 

  10. 

  11. The :mod:`tty` module defines functions for putting the tty into cbreak and raw
    12. 

  12. modes.
    13. 

  13. 

  14. Because it requires the :mod:`termios` module, it will work only on Unix.
    15. 

  15. 

  16. The :mod:`tty` module defines the following functions:
    17. 

  17. 

  18. 

  19. .. function:: setraw(fd[, when])
    20. 

  20. 

  21.    Change the mode of the file descriptor *fd* to raw. If *when* is omitted, it
    22. 

  22.    defaults to :const:`termios.TCSAFLUSH`, and is passed to
    23. 

  23.    :func:`termios.tcsetattr`.
    24. 

  24. 

  25. 

  26. .. function:: setcbreak(fd[, when])
    27. 

  27. 

  28.    Change the mode of file descriptor *fd* to cbreak. If *when* is omitted, it
    29. 

  29.    defaults to :const:`termios.TCSAFLUSH`, and is passed to
    30. 

  30.    :func:`termios.tcsetattr`.
    31. 

  31. 

  32. 

  33. .. seealso::
    34. 

  34. 

  35.    Module :mod:`termios`
    36. 

  36.       Low-level terminal control interface.
    37.