MAN page from RedHat Other perl-5.004-0.1.i386.rpm

Term::Cap

Section: Perl Programmers Reference Guide (3)
Updated: perl 5.004, patch 04
Index

NAME

Term::Cap - Perl termcap interface

SYNOPSIS

    require Term::Cap;    $terminal = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };    $terminal->Trequire(qw/ce ku kd/);    $terminal->Tgoto('cm', $col, $row, $FH);    $terminal->Tputs('dl', $count, $FH);    $terminal->Tpad($string, $count, $FH);

DESCRIPTION

These are low-level functions to extract and use capabilities froma terminal capability (termcap) database.

The Tgetent function extracts the entry of the specified terminaltype TERM (defaults to the environment variable TERM) from thedatabase.

It will look in the environment for a TERMCAP variable. Iffound, and the value does not begin with a slash, and the terminaltype name is the same as the environment string TERM, theTERMCAP string is used instead of reading a termcap file. Ifit does begin with a slash, the string is used as a path name ofthe termcap file to search. If TERMCAP does not begin with aslash and name is different from TERM, Tgetent searches thefiles $HOME/.termcap, /etc/termcap, and /usr/share/misc/termcap,in that order, unless the environment variable TERMPATH exists,in which case it specifies a list of file pathnames (separated byspaces or colons) to be searched instead. Whenever multiplefiles are searched and a tc field occurs in the requested entry,the entry it names must be found in the same file or one of thesucceeding files. If there is a :tc=...: in the TERMCAPenvironment variable string it will continue the search in thefiles as above.

OSPEED is the terminal output bit rate (often mistakenly calledthe baud rate). OSPEED can be specified as either a POSIXtermios/SYSV termio speeds (where 9600 equals 9600) or an oldBSD-style speeds (where 13 equals 9600).

Tgetent returns a blessed object reference which the user canthen use to send the control strings to the terminal using Tputsand Tgoto. It calls croak on failure.

Tgoto decodes a cursor addressing string with the given parameters.

The output strings for Tputs are cached for counts of 1 for performance.Tgoto and Tpad do not cache. $self->{_xx} is the raw termcapdata and $self->{xx} is the cached version.

    print $terminal->Tpad($self->{_xx}, 1);

Tgoto, Tputs, and Tpad return the string and will alsooutput the string to $FH if specified.

The extracted termcap entry is available in the objectas $self->{TERMCAP}.

EXAMPLES

    # Get terminal output speed    require POSIX;    my $termios = new POSIX::Termios;    $termios->getattr;    my $ospeed = $termios->getospeed;

    # Old-style ioctl code to get ospeed:    #     require 'ioctl.pl';    #     ioctl(TTY,$TIOCGETP,$sgtty);    #     ($ispeed,$ospeed) = unpack('cc',$sgtty);

    # allocate and initialize a terminal structure    $terminal = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };

    # require certain capabilities to be available    $terminal->Trequire(qw/ce ku kd/);

    # Output Routines, if $FH is undefined these just return the string

    # Tgoto does the % expansion stuff with the given args    $terminal->Tgoto('cm', $col, $row, $FH);

    # Tputs doesn't do any % expansion.    $terminal->Tputs('dl', $count = 1, $FH);

This document was created byman2html,using the manual pages.