sam-t2/devtools/amd64/html/python/lib/module-termios.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-tty.html" />
<link rel="prev" href="module-gdbm.html" />
<link rel="parent" href="unix.html" />
<link rel="next" href="node433.html" />
<meta name='aesop' content='information' />
<title>8.8 termios -- POSIX style tty control</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.7 gdbm  "
  href="module-gdbm.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="8. Unix Specific Services"
  href="unix.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="8.8.1 Example"
  href="node433.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-gdbm.html">8.7 gdbm  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="unix.html">8. Unix Specific Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node433.html">8.8.1 Example</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0010800000000000000000">
8.8 <tt class="module">termios</tt> --
         POSIX style tty control</A>
</H1>

<P>
<A NAME="module-termios"></A>
<p class="availability">Availability: <span
 class="platform">Unix</span>.</p>

<P>
<a id='l2h-3008' xml:id='l2h-3008'></a><a id='l2h-3009' xml:id='l2h-3009'></a>
<P>
This module provides an interface to the POSIX calls for tty I/O
control.  For a complete description of these calls, see the POSIX or
<span class="Unix">Unix</span> manual pages.  It is only available for those <span class="Unix">Unix</span> versions
that support POSIX <em>termios</em> style tty I/O control (and then
only if configured at installation time).

<P>
All functions in this module take a file descriptor <var>fd</var> as their
first argument.  This can be an integer file descriptor, such as
returned by <code>sys.stdin.fileno()</code>, or a file object, such as
<code>sys.stdin</code> itself.

<P>
This module also defines all the constants needed to work with the
functions provided here; these have the same name as their
counterparts in C.  Please refer to your system documentation for more
information on using these terminal control interfaces.

<P>
The module defines the following functions:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3010' xml:id='l2h-3010' class="function">tcgetattr</tt></b>(</nobr></td>
  <td><var>fd</var>)</td></tr></table></dt>
<dd>
Return a list containing the tty attributes for file descriptor
<var>fd</var>, as follows: <code>[</code><var>iflag</var>, <var>oflag</var>, <var>cflag</var>,
<var>lflag</var>, <var>ispeed</var>, <var>ospeed</var>, <var>cc</var><code>]</code> where
<var>cc</var> is a list of the tty special characters (each a string of
length 1, except the items with indices <tt class="constant">VMIN</tt> and
<tt class="constant">VTIME</tt>, which are integers when these fields are
defined).  The interpretation of the flags and the speeds as well as
the indexing in the <var>cc</var> array must be done using the symbolic
constants defined in the <tt class="module">termios</tt>
module.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3011' xml:id='l2h-3011' class="function">tcsetattr</tt></b>(</nobr></td>
  <td><var>fd, when, attributes</var>)</td></tr></table></dt>
<dd>
Set the tty attributes for file descriptor <var>fd</var> from the
<var>attributes</var>, which is a list like the one returned by
<tt class="function">tcgetattr()</tt>.  The <var>when</var> argument determines when the
attributes are changed: <tt class="constant">TCSANOW</tt> to change immediately,
<tt class="constant">TCSADRAIN</tt> to change after transmitting all queued output,
or <tt class="constant">TCSAFLUSH</tt> to change after transmitting all queued
output and discarding all queued input.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3012' xml:id='l2h-3012' class="function">tcsendbreak</tt></b>(</nobr></td>
  <td><var>fd, duration</var>)</td></tr></table></dt>
<dd>
Send a break on file descriptor <var>fd</var>.  A zero <var>duration</var> sends
a break for 0.25-0.5 seconds; a nonzero <var>duration</var> has a system
dependent meaning.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3013' xml:id='l2h-3013' class="function">tcdrain</tt></b>(</nobr></td>
  <td><var>fd</var>)</td></tr></table></dt>
<dd>
Wait until all output written to file descriptor <var>fd</var> has been
transmitted.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3014' xml:id='l2h-3014' class="function">tcflush</tt></b>(</nobr></td>
  <td><var>fd, queue</var>)</td></tr></table></dt>
<dd>
Discard queued data on file descriptor <var>fd</var>.  The <var>queue</var>
selector specifies which queue: <tt class="constant">TCIFLUSH</tt> for the input
queue, <tt class="constant">TCOFLUSH</tt> for the output queue, or
<tt class="constant">TCIOFLUSH</tt> for both queues.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3015' xml:id='l2h-3015' class="function">tcflow</tt></b>(</nobr></td>
  <td><var>fd, action</var>)</td></tr></table></dt>
<dd>
Suspend or resume input or output on file descriptor <var>fd</var>.  The
<var>action</var> argument can be <tt class="constant">TCOOFF</tt> to suspend output,
<tt class="constant">TCOON</tt> to restart output, <tt class="constant">TCIOFF</tt> to suspend
input, or <tt class="constant">TCION</tt> to restart input.
</dl>

<P>
<div class="seealso">
  <p class="heading">See Also:</p>

  <dl compact="compact" class="seemodule">
    <dt>Module <b><tt class="module"><a href="module-tty.html">tty</a></tt>:</b>
    <dd>Convenience functions for common terminal control
                  operations.
  </dl>
</div>

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="node433.html">8.8.1 Example</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="8.7 gdbm  "
  href="module-gdbm.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="8. Unix Specific Services"
  href="unix.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="8.8.1 Example"
  href="node433.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-gdbm.html">8.7 gdbm  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="unix.html">8. Unix Specific Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node433.html">8.8.1 Example</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>