Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="module-tty.html" /> | |
13 | <link rel="prev" href="module-gdbm.html" /> | |
14 | <link rel="parent" href="unix.html" /> | |
15 | <link rel="next" href="node433.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>8.8 termios -- POSIX style tty control</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="8.7 gdbm " | |
25 | href="module-gdbm.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="8. Unix Specific Services" | |
28 | href="unix.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="8.8.1 Example" | |
31 | href="node433.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python Library Reference</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="module-gdbm.html">8.7 gdbm </A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="unix.html">8. Unix Specific Services</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="node433.html">8.8.1 Example</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H1><A NAME="SECTION0010800000000000000000"> | |
56 | 8.8 <tt class="module">termios</tt> -- | |
57 | POSIX style tty control</A> | |
58 | </H1> | |
59 | ||
60 | <P> | |
61 | <A NAME="module-termios"></A> | |
62 | <p class="availability">Availability: <span | |
63 | class="platform">Unix</span>.</p> | |
64 | ||
65 | <P> | |
66 | <a id='l2h-3008' xml:id='l2h-3008'></a><a id='l2h-3009' xml:id='l2h-3009'></a> | |
67 | <P> | |
68 | This module provides an interface to the POSIX calls for tty I/O | |
69 | control. For a complete description of these calls, see the POSIX or | |
70 | <span class="Unix">Unix</span> manual pages. It is only available for those <span class="Unix">Unix</span> versions | |
71 | that support POSIX <em>termios</em> style tty I/O control (and then | |
72 | only if configured at installation time). | |
73 | ||
74 | <P> | |
75 | All functions in this module take a file descriptor <var>fd</var> as their | |
76 | first argument. This can be an integer file descriptor, such as | |
77 | returned by <code>sys.stdin.fileno()</code>, or a file object, such as | |
78 | <code>sys.stdin</code> itself. | |
79 | ||
80 | <P> | |
81 | This module also defines all the constants needed to work with the | |
82 | functions provided here; these have the same name as their | |
83 | counterparts in C. Please refer to your system documentation for more | |
84 | information on using these terminal control interfaces. | |
85 | ||
86 | <P> | |
87 | The module defines the following functions: | |
88 | ||
89 | <P> | |
90 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
91 | <td><nobr><b><tt id='l2h-3010' xml:id='l2h-3010' class="function">tcgetattr</tt></b>(</nobr></td> | |
92 | <td><var>fd</var>)</td></tr></table></dt> | |
93 | <dd> | |
94 | Return a list containing the tty attributes for file descriptor | |
95 | <var>fd</var>, as follows: <code>[</code><var>iflag</var>, <var>oflag</var>, <var>cflag</var>, | |
96 | <var>lflag</var>, <var>ispeed</var>, <var>ospeed</var>, <var>cc</var><code>]</code> where | |
97 | <var>cc</var> is a list of the tty special characters (each a string of | |
98 | length 1, except the items with indices <tt class="constant">VMIN</tt> and | |
99 | <tt class="constant">VTIME</tt>, which are integers when these fields are | |
100 | defined). The interpretation of the flags and the speeds as well as | |
101 | the indexing in the <var>cc</var> array must be done using the symbolic | |
102 | constants defined in the <tt class="module">termios</tt> | |
103 | module. | |
104 | </dl> | |
105 | ||
106 | <P> | |
107 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
108 | <td><nobr><b><tt id='l2h-3011' xml:id='l2h-3011' class="function">tcsetattr</tt></b>(</nobr></td> | |
109 | <td><var>fd, when, attributes</var>)</td></tr></table></dt> | |
110 | <dd> | |
111 | Set the tty attributes for file descriptor <var>fd</var> from the | |
112 | <var>attributes</var>, which is a list like the one returned by | |
113 | <tt class="function">tcgetattr()</tt>. The <var>when</var> argument determines when the | |
114 | attributes are changed: <tt class="constant">TCSANOW</tt> to change immediately, | |
115 | <tt class="constant">TCSADRAIN</tt> to change after transmitting all queued output, | |
116 | or <tt class="constant">TCSAFLUSH</tt> to change after transmitting all queued | |
117 | output and discarding all queued input. | |
118 | </dl> | |
119 | ||
120 | <P> | |
121 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
122 | <td><nobr><b><tt id='l2h-3012' xml:id='l2h-3012' class="function">tcsendbreak</tt></b>(</nobr></td> | |
123 | <td><var>fd, duration</var>)</td></tr></table></dt> | |
124 | <dd> | |
125 | Send a break on file descriptor <var>fd</var>. A zero <var>duration</var> sends | |
126 | a break for 0.25-0.5 seconds; a nonzero <var>duration</var> has a system | |
127 | dependent meaning. | |
128 | </dl> | |
129 | ||
130 | <P> | |
131 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
132 | <td><nobr><b><tt id='l2h-3013' xml:id='l2h-3013' class="function">tcdrain</tt></b>(</nobr></td> | |
133 | <td><var>fd</var>)</td></tr></table></dt> | |
134 | <dd> | |
135 | Wait until all output written to file descriptor <var>fd</var> has been | |
136 | transmitted. | |
137 | </dl> | |
138 | ||
139 | <P> | |
140 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
141 | <td><nobr><b><tt id='l2h-3014' xml:id='l2h-3014' class="function">tcflush</tt></b>(</nobr></td> | |
142 | <td><var>fd, queue</var>)</td></tr></table></dt> | |
143 | <dd> | |
144 | Discard queued data on file descriptor <var>fd</var>. The <var>queue</var> | |
145 | selector specifies which queue: <tt class="constant">TCIFLUSH</tt> for the input | |
146 | queue, <tt class="constant">TCOFLUSH</tt> for the output queue, or | |
147 | <tt class="constant">TCIOFLUSH</tt> for both queues. | |
148 | </dl> | |
149 | ||
150 | <P> | |
151 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
152 | <td><nobr><b><tt id='l2h-3015' xml:id='l2h-3015' class="function">tcflow</tt></b>(</nobr></td> | |
153 | <td><var>fd, action</var>)</td></tr></table></dt> | |
154 | <dd> | |
155 | Suspend or resume input or output on file descriptor <var>fd</var>. The | |
156 | <var>action</var> argument can be <tt class="constant">TCOOFF</tt> to suspend output, | |
157 | <tt class="constant">TCOON</tt> to restart output, <tt class="constant">TCIOFF</tt> to suspend | |
158 | input, or <tt class="constant">TCION</tt> to restart input. | |
159 | </dl> | |
160 | ||
161 | <P> | |
162 | <div class="seealso"> | |
163 | <p class="heading">See Also:</p> | |
164 | ||
165 | <dl compact="compact" class="seemodule"> | |
166 | <dt>Module <b><tt class="module"><a href="module-tty.html">tty</a></tt>:</b> | |
167 | <dd>Convenience functions for common terminal control | |
168 | operations. | |
169 | </dl> | |
170 | </div> | |
171 | ||
172 | <P> | |
173 | ||
174 | <p><br /></p><hr class='online-navigation' /> | |
175 | <div class='online-navigation'> | |
176 | <!--Table of Child-Links--> | |
177 | <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a> | |
178 | ||
179 | <UL CLASS="ChildLinks"> | |
180 | <LI><A href="node433.html">8.8.1 Example</a> | |
181 | </ul> | |
182 | <!--End of Table of Child-Links--> | |
183 | </div> | |
184 | ||
185 | <DIV CLASS="navigation"> | |
186 | <div class='online-navigation'> | |
187 | <p></p><hr /> | |
188 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
189 | <tr> | |
190 | <td class='online-navigation'><a rel="prev" title="8.7 gdbm " | |
191 | href="module-gdbm.html"><img src='../icons/previous.png' | |
192 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
193 | <td class='online-navigation'><a rel="parent" title="8. Unix Specific Services" | |
194 | href="unix.html"><img src='../icons/up.png' | |
195 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
196 | <td class='online-navigation'><a rel="next" title="8.8.1 Example" | |
197 | href="node433.html"><img src='../icons/next.png' | |
198 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
199 | <td align="center" width="100%">Python Library Reference</td> | |
200 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
201 | href="contents.html"><img src='../icons/contents.png' | |
202 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
203 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
204 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
205 | <td class='online-navigation'><a rel="index" title="Index" | |
206 | href="genindex.html"><img src='../icons/index.png' | |
207 | border='0' height='32' alt='Index' width='32' /></A></td> | |
208 | </tr></table> | |
209 | <div class='online-navigation'> | |
210 | <b class="navlabel">Previous:</b> | |
211 | <a class="sectref" rel="prev" href="module-gdbm.html">8.7 gdbm </A> | |
212 | <b class="navlabel">Up:</b> | |
213 | <a class="sectref" rel="parent" href="unix.html">8. Unix Specific Services</A> | |
214 | <b class="navlabel">Next:</b> | |
215 | <a class="sectref" rel="next" href="node433.html">8.8.1 Example</A> | |
216 | </div> | |
217 | </div> | |
218 | <hr /> | |
219 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
220 | </DIV> | |
221 | <!--End of Navigation Panel--> | |
222 | <ADDRESS> | |
223 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
224 | </ADDRESS> | |
225 | </BODY> | |
226 | </HTML> |