CINXE.COM
Term::Cap - Perl termcap interface - Perldoc Browser
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Term::Cap - Perl termcap interface - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/Term::Cap"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style> <!-- Global site tag (gtag.js) - Google Analytics --> <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.34.1</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Term::Cap">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Term::Cap">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Term::Cap">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/Term::Cap">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Term::Cap">5.38.2</a> <a class="dropdown-item" href="/5.38.1/Term::Cap">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Term::Cap">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Term::Cap">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Term::Cap">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Term::Cap">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Term::Cap">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Term::Cap">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Term::Cap">5.34.2</a> <a class="dropdown-item active" href="/5.34.1/Term::Cap">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Term::Cap">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Term::Cap">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Term::Cap">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Term::Cap">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Term::Cap">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Term::Cap">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Term::Cap">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Term::Cap">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Term::Cap">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Term::Cap">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Term::Cap">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Term::Cap">5.26.3</a> <a class="dropdown-item" href="/5.26.2/Term::Cap">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Term::Cap">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Term::Cap">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/Term::Cap">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Term::Cap">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Term::Cap">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Term::Cap">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Term::Cap">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Term::Cap">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Term::Cap">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Term::Cap">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Term::Cap">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Term::Cap">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Term::Cap">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Term::Cap">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Term::Cap">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Term::Cap">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Term::Cap">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Term::Cap">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Term::Cap">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Term::Cap">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Term::Cap">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Term::Cap">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Term::Cap">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Term::Cap">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Term::Cap">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Term::Cap">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Term::Cap">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Term::Cap">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Term::Cap">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Term::Cap">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Term::Cap">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Term::Cap">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Term::Cap">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Term::Cap">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Term::Cap">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Term::Cap">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Term::Cap">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Term::Cap">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Term::Cap">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Term::Cap">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Term::Cap">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Term::Cap">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Term::Cap">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Term::Cap">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Term::Cap">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Term::Cap">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Term::Cap">5.8.1</a> <a class="dropdown-item" href="/5.8.0/Term::Cap">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Term::Cap">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Term::Cap">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Term::Cap">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Term::Cap">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Term::Cap">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Term::Cap">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Term::Cap">5.005_01</a> <a class="dropdown-item" href="/5.005/Term::Cap">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/Term::Cap">blead</a> <a class="dropdown-item" href="/5.41.10/Term::Cap">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Term::Cap">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Term::Cap">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Term::Cap">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Term::Cap">5.41.6</a> <a class="dropdown-item" href="/5.41.5/Term::Cap">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Term::Cap">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Term::Cap">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Term::Cap">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Term::Cap">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Term::Cap">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Term::Cap">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Term::Cap">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Term::Cap">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Term::Cap">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Term::Cap">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Term::Cap">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Term::Cap">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Term::Cap">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Term::Cap">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Term::Cap">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Term::Cap">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Term::Cap">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Term::Cap">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.34.1/perl">Perl</a> <a class="dropdown-item" href="/5.34.1/perlintro">Intro</a> <a class="dropdown-item" href="/5.34.1/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.34.1/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.34.1/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.1/perlop">Operators</a> <a class="dropdown-item" href="/5.34.1/functions">Functions</a> <a class="dropdown-item" href="/5.34.1/variables">Variables</a> <a class="dropdown-item" href="/5.34.1/modules">Modules</a> <a class="dropdown-item" href="/5.34.1/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.1/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.34.1/perlcommunity">Community</a> <a class="dropdown-item" href="/5.34.1/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.34.1/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.34.1/Term::Cap">Term::Cap</a> <div id="more"> (<a href="/5.34.1/Term::Cap.txt">source</a>, <a href="https://metacpan.org/pod/Term::Cap">CPAN</a>) </div> <div id="moduleversion">version 1.17</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.34.1. <a href="/Term::Cap">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> <ul> <li> <a class="text-decoration-none" href="#METHODS">METHODS</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#EXAMPLES">EXAMPLES</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Term::Cap - Perl termcap interface</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>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);</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>These are low-level functions to extract and use capabilities from a terminal capability (termcap) database.</p> <p>More information on the terminal capabilities will be found in the termcap manpage on most Unix-like systems.</p> <h2 id="METHODS"><a class="permalink" href="#METHODS">#</a>METHODS</h2> <p>The output strings for <b>Tputs</b> are cached for counts of 1 for performance. <b>Tgoto</b> and <b>Tpad</b> do not cache. <code>$self->{_xx}</code> is the raw termcap data and <code>$self->{xx}</code> is the cached version.</p> <pre><code>print $terminal->Tpad($self->{_xx}, 1);</code></pre> <p><b>Tgoto</b>, <b>Tputs</b>, and <b>Tpad</b> return the string and will also output the string to $FH if specified.</p> <dl> <dt id="Tgetent"><a class="permalink" href="#Tgetent">#</a><b>Tgetent</b></dt> <dd> <p>Returns a blessed object reference which the user can then use to send the control strings to the terminal using <b>Tputs</b> and <b>Tgoto</b>.</p> <p>The function extracts the entry of the specified terminal type <i>TERM</i> (defaults to the environment variable <i>TERM</i>) from the database.</p> <p>It will look in the environment for a <i>TERMCAP</i> variable. If found, and the value does not begin with a slash, and the terminal type name is the same as the environment string <i>TERM</i>, the <i>TERMCAP</i> string is used instead of reading a termcap file. If it does begin with a slash, the string is used as a path name of the termcap file to search. If <i>TERMCAP</i> does not begin with a slash and name is different from <i>TERM</i>, <b>Tgetent</b> searches the files <i>$HOME/.termcap</i>, <i>/etc/termcap</i>, and <i>/usr/share/misc/termcap</i>, in that order, unless the environment variable <i>TERMPATH</i> exists, in which case it specifies a list of file pathnames (separated by spaces or colons) to be searched <b>instead</b>. Whenever multiple files 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 the succeeding files. If there is a <code>:tc=...:</code> in the <i>TERMCAP</i> environment variable string it will continue the search in the files as above.</p> <p>The extracted termcap entry is available in the object as <code>$self->{TERMCAP}</code>.</p> <p>It takes a hash reference as an argument with two optional keys:</p> <dl> <dt id="OSPEED"><a class="permalink" href="#OSPEED">#</a>OSPEED</dt> <dd> <p>The terminal output bit rate (often mistakenly called the baud rate) for this terminal - if not set a warning will be generated and it will be defaulted to 9600. <i>OSPEED</i> can be specified as either a POSIX termios/SYSV termio speeds (where 9600 equals 9600) or an old DSD-style speed ( where 13 equals 9600).</p> </dd> <dt id="TERM"><a class="permalink" href="#TERM">#</a>TERM</dt> <dd> <p>The terminal type whose termcap entry will be used - if not supplied it will default to $ENV{TERM}: if that is not set then <b>Tgetent</b> will croak.</p> </dd> </dl> <p>It calls <code>croak</code> on failure.</p> </dd> <dt id="Tpad"><a class="permalink" href="#Tpad">#</a><b>Tpad</b></dt> <dd> <p>Outputs a literal string with appropriate padding for the current terminal.</p> <p>It takes three arguments:</p> <dl> <dt id="$string"><a class="permalink" href="#$string">#</a><a id="string"></a><b>$string</b></dt> <dd> <p>The literal string to be output. If it starts with a number and an optional '*' then the padding will be increased by an amount relative to this number, if the '*' is present then this amount will be multiplied by $cnt. This part of $string is removed before output/</p> </dd> <dt id="$cnt"><a class="permalink" href="#$cnt">#</a><a id="cnt"></a><b>$cnt</b></dt> <dd> <p>Will be used to modify the padding applied to string as described above.</p> </dd> <dt id="$FH"><a class="permalink" href="#$FH">#</a><a id="FH"></a><b>$FH</b></dt> <dd> <p>An optional filehandle (or IO::Handle ) that output will be printed to.</p> </dd> </dl> <p>The padded $string is returned.</p> </dd> <dt id="Tputs"><a class="permalink" href="#Tputs">#</a><b>Tputs</b></dt> <dd> <p>Output the string for the given capability padded as appropriate without any parameter substitution.</p> <p>It takes three arguments:</p> <dl> <dt id="$cap"><a class="permalink" href="#$cap">#</a><a id="cap"></a><b>$cap</b></dt> <dd> <p>The capability whose string is to be output.</p> </dd> <dt id="$cnt1"><a class="permalink" href="#$cnt1">#</a><a id="cnt1"></a><b>$cnt</b></dt> <dd> <p>A count passed to Tpad to modify the padding applied to the output string. If $cnt is zero or one then the resulting string will be cached.</p> </dd> <dt id="$FH1"><a class="permalink" href="#$FH1">#</a><a id="FH1"></a><b>$FH</b></dt> <dd> <p>An optional filehandle (or IO::Handle ) that output will be printed to.</p> </dd> </dl> <p>The appropriate string for the capability will be returned.</p> </dd> <dt id="Tgoto"><a class="permalink" href="#Tgoto">#</a><b>Tgoto</b></dt> <dd> <p><b>Tgoto</b> decodes a cursor addressing string with the given parameters.</p> <p>There are four arguments:</p> <dl> <dt id="$cap1"><a class="permalink" href="#$cap1">#</a><a id="cap1"></a><b>$cap</b></dt> <dd> <p>The name of the capability to be output.</p> </dd> <dt id="$col"><a class="permalink" href="#$col">#</a><a id="col"></a><b>$col</b></dt> <dd> <p>The first value to be substituted in the output string ( usually the column in a cursor addressing capability )</p> </dd> <dt id="$row"><a class="permalink" href="#$row">#</a><a id="row"></a><b>$row</b></dt> <dd> <p>The second value to be substituted in the output string (usually the row in cursor addressing capabilities)</p> </dd> <dt id="$FH2"><a class="permalink" href="#$FH2">#</a><a id="FH2"></a><b>$FH</b></dt> <dd> <p>An optional filehandle (or IO::Handle ) to which the output string will be printed.</p> </dd> </dl> <p>Substitutions are made with $col and $row in the output string with the following sprintf() line formats:</p> <pre><code>%% output `%' %d output value as in printf %d %2 output value as in printf %2d %3 output value as in printf %3d %. output value as in printf %c %+x add x to value, then do %. %>xy if value > x then add y, no output %r reverse order of two parameters, no output %i increment by one, no output %B BCD (16*(value/10)) + (value%10), no output %n exclusive-or all parameters with 0140 (Datamedia 2500) %D Reverse coding (value - 2*(value%16)), no output (Delta Data)</code></pre> <p>The output string will be returned.</p> </dd> <dt id="Trequire"><a class="permalink" href="#Trequire">#</a><b>Trequire</b></dt> <dd> <p>Takes a list of capabilities as an argument and will croak if one is not found.</p> </dd> </dl> <h1 id="EXAMPLES"><a class="permalink" href="#EXAMPLES">#</a>EXAMPLES</h1> <pre><code>use Term::Cap; # 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);</code></pre> <h1 id="COPYRIGHT-AND-LICENSE"><a class="permalink" href="#COPYRIGHT-AND-LICENSE">#</a><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1> <p>Copyright 1995-2015 (c) perl5 porters.</p> <p>This software is free software and can be modified and distributed under the same terms as Perl itself.</p> <p>Please see the file README in the Perl source distribution for details of the Perl license.</p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>This module is part of the core Perl distribution and is also maintained for CPAN by Jonathan Stowe <jns@gellyfish.co.uk>.</p> <p>The code is hosted on Github: https://github.com/jonathanstowe/Term-Cap please feel free to fork, submit patches etc, etc there.</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p>termcap(5)</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>