Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "Tty 3" | |
132 | .TH Tty 3 "2002-04-02" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | IO::Tty \- Low\-level allocate a pseudo\-Tty, import constants. | |
135 | .SH "VERSION" | |
136 | .IX Header "VERSION" | |
137 | 1.02 | |
138 | .SH "SYNOPSIS" | |
139 | .IX Header "SYNOPSIS" | |
140 | .Vb 3 | |
141 | \& use IO::Tty qw(TIOCNOTTY); | |
142 | \& ... | |
143 | \& # use only to import constants, see IO::Pty to create ptys. | |
144 | .Ve | |
145 | .SH "DESCRIPTION" | |
146 | .IX Header "DESCRIPTION" | |
147 | \&\f(CW\*(C`IO::Tty\*(C'\fR is used internally by \f(CW\*(C`IO::Pty\*(C'\fR to create a pseudo\-tty. | |
148 | You wouldn't want to use it directly except to import constants, use | |
149 | \&\f(CW\*(C`IO::Pty\*(C'\fR. For a list of importable constants, see | |
150 | IO::Tty::Constant. | |
151 | .PP | |
152 | Windows is now supported, not natively but under the Cygwin | |
153 | environment, see <http://sources.redhat.com/cygwin/>. | |
154 | .PP | |
155 | Please note that pty creation is very system\-dependend. From my | |
156 | experience, any modern \s-1POSIX\s0 system should be fine. Find below a list | |
157 | of systems that \f(CW\*(C`IO::Tty\*(C'\fR should work on. A more detailed table is | |
158 | available from the project pages document manager at SourceForge | |
159 | <http://sourceforge.net/projects/expectperl/>. | |
160 | .PP | |
161 | If you have problems on your system and your system is listed in the | |
162 | \&\*(L"verified\*(R" list, you probably have some non-standard setup, e.g. you | |
163 | compiled your Linux-kernel yourself and disabled ptys (bummer!). | |
164 | Please ask your friendly sysadmin for help. | |
165 | .PP | |
166 | If your system is not listed, unpack the latest version of \f(CW\*(C`IO::Tty\*(C'\fR, | |
167 | do a \f(CW'perl Makefile.PL; make; make test; uname \-a'\fR and send me | |
168 | (\fIRGiersig@cpan.org\fR) the results and I'll see what I can deduce from | |
169 | that. There are chances that it will work right out\-of\-the\-box... | |
170 | .PP | |
171 | If it's working on your system, please send me a short note with | |
172 | details (version number, distribution, etc. \f(CW'uname \-a'\fR is a good | |
173 | start) so I can get an overview. Thanks! | |
174 | .SH "VERIFIED SYSTEMS, KNOWN ISSUES" | |
175 | .IX Header "VERIFIED SYSTEMS, KNOWN ISSUES" | |
176 | This is a list of systems that \f(CW\*(C`IO::Tty\*(C'\fR seems to work on ('make | |
177 | test' passes) with comments about \*(L"features\*(R": | |
178 | .IP "\(bu \s-1AIX\s0 4.3" 4 | |
179 | .IX Item "AIX 4.3" | |
180 | Returns \s-1EIO\s0 instead of \s-1EOF\s0 when the slave is closed. Benign. | |
181 | .IP "\(bu FreeBSD 4.4" 4 | |
182 | .IX Item "FreeBSD 4.4" | |
183 | \&\s-1EOF\s0 on the slave tty is not reported back to the master. | |
184 | .IP "\(bu OpenBSD 2.8" 4 | |
185 | .IX Item "OpenBSD 2.8" | |
186 | The ioctl \s-1TIOCSCTTY\s0 sometimes fails. This is also known in | |
187 | Tcl/Expect, see http://expect.nist.gov/FAQ.html | |
188 | .Sp | |
189 | \&\s-1EOF\s0 on the slave tty is not reported back to the master. | |
190 | .IP "\(bu \s-1HPUX\s0 10.20 & 11.00" 4 | |
191 | .IX Item "HPUX 10.20 & 11.00" | |
192 | \&\s-1EOF\s0 on the slave tty is not reported back to the master. | |
193 | .IP "\(bu \s-1IRIX\s0 6.5" 4 | |
194 | .IX Item "IRIX 6.5" | |
195 | .PD 0 | |
196 | .IP "\(bu Linux 2.2.x & 2.4.x" 4 | |
197 | .IX Item "Linux 2.2.x & 2.4.x" | |
198 | .PD | |
199 | Returns \s-1EIO\s0 instead of \s-1EOF\s0 when the slave is closed. Benign. | |
200 | .IP "\(bu \s-1OSF\s0 4.0" 4 | |
201 | .IX Item "OSF 4.0" | |
202 | \&\s-1EOF\s0 on the slave tty is not reported back to the master. | |
203 | .IP "\(bu Solaris 8, 2.7, 2.6" 4 | |
204 | .IX Item "Solaris 8, 2.7, 2.6" | |
205 | Has the \*(L"feature\*(R" of returning \s-1EOF\s0 just once?! | |
206 | .Sp | |
207 | \&\s-1EOF\s0 on the slave tty is not reported back to the master. | |
208 | .IP "\(bu Windows NT/2k (under Cygwin)" 4 | |
209 | .IX Item "Windows NT/2k (under Cygwin)" | |
210 | When you send (print) a too long line (>160 chars) to a non-raw pty, | |
211 | the call just hangs forever and even \fIalarm()\fR cannot get you out. | |
212 | Don't complain to me... | |
213 | .Sp | |
214 | \&\s-1EOF\s0 on the slave tty is not reported back to the master. | |
215 | .PP | |
216 | The following systems have not been verified yet for this version, but | |
217 | a previous version worked on them: | |
218 | .IP "\(bu \s-1SCO\s0 Unix" 4 | |
219 | .IX Item "SCO Unix" | |
220 | .PD 0 | |
221 | .IP "\(bu NetBSD" 4 | |
222 | .IX Item "NetBSD" | |
223 | .PD | |
224 | probably the same as the other *BSDs... | |
225 | .PP | |
226 | If you have additions to these lists, please mail them to | |
227 | <\fIRGiersig@cpan.org\fR>. | |
228 | .SH "SEE ALSO" | |
229 | .IX Header "SEE ALSO" | |
230 | IO::Pty, IO::Tty::Constant | |
231 | .SH "MAILING LISTS" | |
232 | .IX Header "MAILING LISTS" | |
233 | As this module is mainly used by Expect, support for it is available | |
234 | via the two Expect mailing lists, expectperl-announce and | |
235 | expectperl\-discuss, at | |
236 | .PP | |
237 | .Vb 1 | |
238 | \& http://lists.sourceforge.net/lists/listinfo/expectperl-announce | |
239 | .Ve | |
240 | .PP | |
241 | and | |
242 | .PP | |
243 | .Vb 1 | |
244 | \& http://lists.sourceforge.net/lists/listinfo/expectperl-discuss | |
245 | .Ve | |
246 | .SH "AUTHORS" | |
247 | .IX Header "AUTHORS" | |
248 | Originally by Graham Barr <\fIgbarr@pobox.com\fR>, based on the | |
249 | Ptty module by Nick Ing-Simmons <\fInik@tiuk.ti.com\fR>. | |
250 | .PP | |
251 | Now maintained and heavily rewritten by Roland Giersig | |
252 | <\fIRGiersig@cpan.org\fR>. | |
253 | .PP | |
254 | Contains copyrighted stuff from openssh v3.0p1, authored by Tatu | |
255 | Ylonen <ylo@cs.hut.fi>, Markus Friedl and Todd C. Miller | |
256 | <Todd.Miller@courtesan.com>. I also got a lot of inspiry from the pty | |
257 | code in Xemacs. | |
258 | .SH "COPYRIGHT" | |
259 | .IX Header "COPYRIGHT" | |
260 | Now all code is free software; you can redistribute it and/or modify | |
261 | it under the same terms as Perl itself. | |
262 | .PP | |
263 | Nevertheless the above \s-1AUTHORS\s0 retain their copyrights to the various | |
264 | parts and want to receive credit if their source code is used. | |
265 | See the source for details. | |
266 | .SH "DISCLAIMER" | |
267 | .IX Header "DISCLAIMER" | |
268 | \&\s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 ``\s-1AS\s0 \s-1IS\s0'' \s-1AND\s0 \s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0 | |
269 | \&\s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0 | |
270 | \&\s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0 \s-1ARE\s0 \s-1DISCLAIMED\s0. | |
271 | \&\s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1SHALL\s0 \s-1THE\s0 \s-1AUTHORS\s0 \s-1BE\s0 \s-1LIABLE\s0 \s-1FOR\s0 \s-1ANY\s0 \s-1DIRECT\s0, \s-1INDIRECT\s0, | |
272 | \&\s-1INCIDENTAL\s0, \s-1SPECIAL\s0, \s-1EXEMPLARY\s0, \s-1OR\s0 \s-1CONSEQUENTIAL\s0 \s-1DAMAGES\s0 (\s-1INCLUDING\s0, | |
273 | \&\s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1PROCUREMENT\s0 \s-1OF\s0 \s-1SUBSTITUTE\s0 \s-1GOODS\s0 \s-1OR\s0 \s-1SERVICES\s0; \s-1LOSS\s0 | |
274 | \&\s-1OF\s0 \s-1USE\s0, \s-1DATA\s0, \s-1OR\s0 \s-1PROFITS\s0; \s-1OR\s0 \s-1BUSINESS\s0 \s-1INTERRUPTION\s0) \s-1HOWEVER\s0 \s-1CAUSED\s0 \s-1AND\s0 | |
275 | \&\s-1ON\s0 \s-1ANY\s0 \s-1THEORY\s0 \s-1OF\s0 \s-1LIABILITY\s0, \s-1WHETHER\s0 \s-1IN\s0 \s-1CONTRACT\s0, \s-1STRICT\s0 \s-1LIABILITY\s0, \s-1OR\s0 | |
276 | \&\s-1TORT\s0 (\s-1INCLUDING\s0 \s-1NEGLIGENCE\s0 \s-1OR\s0 \s-1OTHERWISE\s0) \s-1ARISING\s0 \s-1IN\s0 \s-1ANY\s0 \s-1WAY\s0 \s-1OUT\s0 \s-1OF\s0 \s-1THE\s0 | |
277 | \&\s-1USE\s0 \s-1OF\s0 \s-1THIS\s0 \s-1SOFTWARE\s0, \s-1EVEN\s0 \s-1IF\s0 \s-1ADVISED\s0 \s-1OF\s0 \s-1THE\s0 \s-1POSSIBILITY\s0 \s-1OF\s0 \s-1SUCH\s0 | |
278 | \&\s-1DAMAGE\s0. | |
279 | .PP | |
280 | In other words: Use at your own risk. Provided as is. Your mileage | |
281 | may vary. Read the source, Luke! | |
282 | .PP | |
283 | And finally, just to be sure: | |
284 | .PP | |
285 | Any Use of This Product, in Any Manner Whatsoever, Will Increase the | |
286 | Amount of Disorder in the Universe. Although No Liability Is Implied | |
287 | Herein, the Consumer Is Warned That This Process Will Ultimately Lead | |
288 | to the Heat Death of the Universe. |