HOME

Mini Shell 1.0
Current File : //usr/local/share/man/man3/IO::Tty.3pm
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Tty 3"
.TH Tty 3 "2021-01-22" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
IO::Tty \- Low\-level allocate a pseudo\-Tty, import constants.
.SH "VERSION"
.IX Header "VERSION"
1.16
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use IO::Tty qw(TIOCNOTTY);
\&    ...
\&    # use only to import constants, see IO::Pty to create ptys.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`IO::Tty\*(C'\fR is used internally by \f(CW\*(C`IO::Pty\*(C'\fR to create a pseudo-tty.
You wouldn't want to use it directly except to import constants, use
\&\f(CW\*(C`IO::Pty\*(C'\fR.  For a list of importable constants, see
IO::Tty::Constant.
.PP
Windows is now supported, but \s-1ONLY\s0 under the Cygwin
environment, see <http://sources.redhat.com/cygwin/>.
.PP
Please note that pty creation is very system-dependend.  From my
experience, any modern \s-1POSIX\s0 system should be fine.  Find below a list
of systems that \f(CW\*(C`IO::Tty\*(C'\fR should work on.  A more detailed table
(which is slowly getting out-of-date) is available from the project
pages document manager at SourceForge
<http://sourceforge.net/projects/expectperl/>.
.PP
If you have problems on your system and your system is listed in the
\&\*(L"verified\*(R" list, you probably have some non-standard setup, e.g. you
compiled your Linux-kernel yourself and disabled ptys (bummer!).
Please ask your friendly sysadmin for help.
.PP
If your system is not listed, unpack the latest version of \f(CW\*(C`IO::Tty\*(C'\fR,
do a \f(CW\*(Aqperl Makefile.PL; make; make test; uname \-a\*(Aq\fR and send me
(\fIRGiersig@cpan.org\fR) the results and I'll see what I can deduce from
that.  There are chances that it will work right out-of-the-box...
.PP
If it's working on your system, please send me a short note with
details (version number, distribution, etc. 'uname \-a' and 'perl \-V'
is a good start; also, the output from \*(L"perl Makefile.PL\*(R" contains a
lot of interesting info, so please include that as well) so I can get
an overview.  Thanks!
.SH "VERIFIED SYSTEMS, KNOWN ISSUES"
.IX Header "VERIFIED SYSTEMS, KNOWN ISSUES"
This is a list of systems that \f(CW\*(C`IO::Tty\*(C'\fR seems to work on ('make
test' passes) with comments about \*(L"features\*(R":
.IP "\(bu" 4
\&\s-1AIX 4.3\s0
.Sp
Returns \s-1EIO\s0 instead of \s-1EOF\s0 when the slave is closed.  Benign.
.IP "\(bu" 4
\&\s-1AIX 5\s0.x
.IP "\(bu" 4
FreeBSD 4.4
.Sp
\&\s-1EOF\s0 on the slave tty is not reported back to the master.
.IP "\(bu" 4
OpenBSD 2.8
.Sp
The ioctl \s-1TIOCSCTTY\s0 sometimes fails.  This is also known in
Tcl/Expect, see http://expect.nist.gov/FAQ.html
.Sp
\&\s-1EOF\s0 on the slave tty is not reported back to the master.
.IP "\(bu" 4
Darwin 7.9.0
.IP "\(bu" 4
\&\s-1HPUX 10.20 & 11.00\s0
.Sp
\&\s-1EOF\s0 on the slave tty is not reported back to the master.
.IP "\(bu" 4
\&\s-1IRIX 6.5\s0
.IP "\(bu" 4
Linux 2.2.x & 2.4.x
.Sp
Returns \s-1EIO\s0 instead of \s-1EOF\s0 when the slave is closed.  Benign.
.IP "\(bu" 4
\&\s-1OSF 4.0\s0
.Sp
\&\s-1EOF\s0 on the slave tty is not reported back to the master.
.IP "\(bu" 4
Solaris 8, 2.7, 2.6
.Sp
Has the \*(L"feature\*(R" of returning \s-1EOF\s0 just once?!
.Sp
\&\s-1EOF\s0 on the slave tty is not reported back to the master.
.IP "\(bu" 4
Windows NT/2k/XP (under Cygwin)
.Sp
When you send (print) a too long line (>160 chars) to a non-raw pty,
the call just hangs forever and even \fIalarm()\fR cannot get you out.
Don't complain to me...
.Sp
\&\s-1EOF\s0 on the slave tty is not reported back to the master.
.IP "\(bu" 4
z/OS
.PP
The following systems have not been verified yet for this version, but
a previous version worked on them:
.IP "\(bu" 4
\&\s-1SCO\s0 Unix
.IP "\(bu" 4
NetBSD
.Sp
probably the same as the other *BSDs...
.PP
If you have additions to these lists, please mail them to
<\fIRGiersig@cpan.org\fR>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IO::Pty, IO::Tty::Constant
.SH "MAILING LISTS"
.IX Header "MAILING LISTS"
As this module is mainly used by Expect, support for it is available
via the two Expect mailing lists, expectperl-announce and
expectperl-discuss, at
.PP
.Vb 1
\&  http://lists.sourceforge.net/lists/listinfo/expectperl\-announce
.Ve
.PP
and
.PP
.Vb 1
\&  http://lists.sourceforge.net/lists/listinfo/expectperl\-discuss
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
Originally by Graham Barr <\fIgbarr@pobox.com\fR>, based on the
Ptty module by Nick Ing-Simmons <\fInik@tiuk.ti.com\fR>.
.PP
Now maintained and heavily rewritten by Roland Giersig
<\fIRGiersig@cpan.org\fR>.
.PP
Contains copyrighted stuff from openssh v3.0p1, authored by Tatu
Ylonen <ylo@cs.hut.fi>, Markus Friedl and Todd C. Miller
<Todd.Miller@courtesan.com>.  I also got a lot of inspiration from
the pty code in Xemacs.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Now all code is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.PP
Nevertheless the above \s-1AUTHORS\s0 retain their copyrights to the various
parts and want to receive credit if their source code is used.
See the source for details.
.SH "DISCLAIMER"
.IX Header "DISCLAIMER"
\&\s-1THIS SOFTWARE IS PROVIDED\s0 ``\s-1AS IS\s0'' \s-1AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES \s0(\s-1INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS
OF USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT \s0(\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.\s0
.PP
In other words: Use at your own risk.  Provided as is.  Your mileage
may vary.  Read the source, Luke!
.PP
And finally, just to be sure:
.PP
Any Use of This Product, in Any Manner Whatsoever, Will Increase the
Amount of Disorder in the Universe. Although No Liability Is Implied
Herein, the Consumer Is Warned That This Process Will Ultimately Lead
to the Heat Death of the Universe.