Term::ReadLine - Perl interface to various readline packages. If no real package is found, substitutes stubs instead of basic functions.

<!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::ReadLine - Perl interface to various readline packages. If no real package is found, substitutes stubs instead of basic functions. - 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::ReadLine"> <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>  <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.8.0</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Term::ReadLine">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Term::ReadLine">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Term::ReadLine">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/Term::ReadLine">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Term::ReadLine">5.38.2</a> <a class="dropdown-item" href="/5.38.1/Term::ReadLine">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Term::ReadLine">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Term::ReadLine">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Term::ReadLine">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Term::ReadLine">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Term::ReadLine">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Term::ReadLine">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Term::ReadLine">5.34.2</a> <a class="dropdown-item" href="/5.34.1/Term::ReadLine">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Term::ReadLine">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Term::ReadLine">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Term::ReadLine">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Term::ReadLine">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Term::ReadLine">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Term::ReadLine">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Term::ReadLine">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Term::ReadLine">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Term::ReadLine">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Term::ReadLine">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Term::ReadLine">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Term::ReadLine">5.26.3</a> <a class="dropdown-item" href="/5.26.2/Term::ReadLine">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Term::ReadLine">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Term::ReadLine">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/Term::ReadLine">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Term::ReadLine">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Term::ReadLine">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Term::ReadLine">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Term::ReadLine">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Term::ReadLine">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Term::ReadLine">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Term::ReadLine">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Term::ReadLine">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Term::ReadLine">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Term::ReadLine">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Term::ReadLine">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Term::ReadLine">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Term::ReadLine">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Term::ReadLine">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Term::ReadLine">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Term::ReadLine">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Term::ReadLine">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Term::ReadLine">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Term::ReadLine">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Term::ReadLine">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Term::ReadLine">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Term::ReadLine">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Term::ReadLine">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Term::ReadLine">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Term::ReadLine">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Term::ReadLine">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Term::ReadLine">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Term::ReadLine">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Term::ReadLine">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Term::ReadLine">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Term::ReadLine">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Term::ReadLine">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Term::ReadLine">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Term::ReadLine">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Term::ReadLine">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Term::ReadLine">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Term::ReadLine">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Term::ReadLine">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Term::ReadLine">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Term::ReadLine">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Term::ReadLine">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Term::ReadLine">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Term::ReadLine">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Term::ReadLine">5.8.1</a> <a class="dropdown-item active" href="/5.8.0/Term::ReadLine">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Term::ReadLine">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Term::ReadLine">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Term::ReadLine">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Term::ReadLine">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Term::ReadLine">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Term::ReadLine">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Term::ReadLine">5.005_01</a> <a class="dropdown-item" href="/5.005/Term::ReadLine">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::ReadLine">blead</a> <a class="dropdown-item" href="/5.41.10/Term::ReadLine">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Term::ReadLine">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Term::ReadLine">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Term::ReadLine">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Term::ReadLine">5.41.6</a> <a class="dropdown-item" href="/5.41.5/Term::ReadLine">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Term::ReadLine">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Term::ReadLine">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Term::ReadLine">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Term::ReadLine">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Term::ReadLine">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Term::ReadLine">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Term::ReadLine">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Term::ReadLine">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Term::ReadLine">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Term::ReadLine">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Term::ReadLine">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Term::ReadLine">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Term::ReadLine">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Term::ReadLine">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Term::ReadLine">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Term::ReadLine">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Term::ReadLine">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Term::ReadLine">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.8.0/perl">Perl</a> <a class="dropdown-item" href="/5.8.0/perlintro">Intro</a> <a class="dropdown-item" href="/5.8.0/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.8.0/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.8.0/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.0/perlop">Operators</a> <a class="dropdown-item" href="/5.8.0/functions">Functions</a> <a class="dropdown-item" href="/5.8.0/variables">Variables</a> <a class="dropdown-item" href="/5.8.0/modules">Modules</a> <a class="dropdown-item" href="/5.8.0/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.0/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.8.0/perlcommunity">Community</a> <a class="dropdown-item" href="/5.8.0/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.8.0/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.8.0/Term::ReadLine">Term::ReadLine</a> <div id="more"> (<a href="/5.8.0/Term::ReadLine.txt">source</a>, <a href="https://metacpan.org/pod/Term::ReadLine">CPAN</a>) </div> <div id="moduleversion">version 1.00</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.8.0. <a href="/Term::ReadLine">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> </li> <li> <a class="text-decoration-none" href="#Minimal-set-of-supported-functions">Minimal set of supported functions</a> </li> <li> <a class="text-decoration-none" href="#Additional-supported-functions">Additional supported functions</a> </li> <li> <a class="text-decoration-none" href="#EXPORTS">EXPORTS</a> </li> <li> <a class="text-decoration-none" href="#ENVIRONMENT">ENVIRONMENT</a> </li> <li> <a class="text-decoration-none" href="#CAVEATS">CAVEATS</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Term::ReadLine - Perl interface to various <code>readline</code> packages. If no real package is found, substitutes stubs instead of basic functions.</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>use Term::ReadLine; my $term = new Term::ReadLine 'Simple Perl calc'; my $prompt = "Enter your arithmetic expression: "; my $OUT = $term->OUT || \*STDOUT; while ( defined ($_ = $term->readline($prompt)) ) { my $res = eval($_), "\n"; warn $@ if $@; print $OUT $res, "\n" unless $@; $term->addhistory($_) if /\S/; }</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>This package is just a front end to some other packages. At the moment this description is written, the only such package is Term-ReadLine, available on CPAN near you. The real target of this stub package is to set up a common interface to whatever Readline emerges with time.</p> <h1 id="Minimal-set-of-supported-functions"><a class="permalink" href="#Minimal-set-of-supported-functions">#</a><a id="Minimal"></a>Minimal set of supported functions</h1> <p>All the supported functions should be called as methods, i.e., either as</p> <pre><code>$term = new Term::ReadLine 'name';</code></pre> <p>or as</p> <pre><code>$term->addhistory('row');</code></pre> <p>where $term is a return value of Term::ReadLine->Init.</p> <dl> <dt id="ReadLine"><a class="permalink" href="#ReadLine">#</a><code>ReadLine</code></dt> <dd> <p>returns the actual package that executes the commands. Among possible values are <code>Term::ReadLine::Gnu</code>, <code>Term::ReadLine::Perl</code>, <code>Term::ReadLine::Stub</code>.</p> </dd> <dt id="new"><a class="permalink" href="#new">#</a><code>new</code></dt> <dd> <p>returns the handle for subsequent calls to following functions. Argument is the name of the application. Optionally can be followed by two arguments for <code>IN</code> and <code>OUT</code> filehandles. These arguments should be globs.</p> </dd> <dt id="readline"><a class="permalink" href="#readline">#</a><code>readline</code></dt> <dd> <p>gets an input line, <i>possibly</i> with actual <code>readline</code> support. Trailing newline is removed. Returns <code>undef</code> on <code>EOF</code>.</p> </dd> <dt id="addhistory"><a class="permalink" href="#addhistory">#</a><code>addhistory</code></dt> <dd> <p>adds the line to the history of input, from where it can be used if the actual <code>readline</code> is present.</p> </dd> <dt id="IN,-$OUT"><a class="permalink" href="#IN,-$OUT">#</a><a id="IN"></a><a id="IN-OUT"></a><code>IN</code>, $<code>OUT</code></dt> <dd> <p>return the filehandles for input and output or <code>undef</code> if <code>readline</code> input and output cannot be used for Perl.</p> </dd> <dt id="MinLine"><a class="permalink" href="#MinLine">#</a><code>MinLine</code></dt> <dd> <p>If argument is specified, it is an advice on minimal size of line to be included into history. <code>undef</code> means do not include anything into history. Returns the old value.</p> </dd> <dt id="findConsole"><a class="permalink" href="#findConsole">#</a><code>findConsole</code></dt> <dd> <p>returns an array with two strings that give most appropriate names for files for input and output using conventions <code>"<$in"</code>, <code>">out"</code>.</p> </dd> <dt id="Attribs"><a class="permalink" href="#Attribs">#</a>Attribs</dt> <dd> <p>returns a reference to a hash which describes internal configuration of the package. Names of keys in this hash conform to standard conventions with the leading <code>rl_</code> stripped.</p> </dd> <dt id="Features"><a class="permalink" href="#Features">#</a><code>Features</code></dt> <dd> <p>Returns a reference to a hash with keys being features present in current implementation. Several optional features are used in the minimal interface: <code>appname</code> should be present if the first argument to <code>new</code> is recognized, and <code>minline</code> should be present if <code>MinLine</code> method is not dummy. <code>autohistory</code> should be present if lines are put into history automatically (maybe subject to <code>MinLine</code>), and <code>addhistory</code> if <code>addhistory</code> method is not dummy.</p> <p>If <code>Features</code> method reports a feature <code>attribs</code> as present, the method <code>Attribs</code> is not dummy.</p> </dd> </dl> <h1 id="Additional-supported-functions"><a class="permalink" href="#Additional-supported-functions">#</a><a id="Additional"></a>Additional supported functions</h1> <p>Actually <code>Term::ReadLine</code> can use some other package, that will support reacher set of commands.</p> <p>All these commands are callable via method interface and have names which conform to standard conventions with the leading <code>rl_</code> stripped.</p> <p>The stub package included with the perl distribution allows some additional methods:</p> <dl> <dt id="tkRunning"><a class="permalink" href="#tkRunning">#</a><code>tkRunning</code></dt> <dd> <p>makes Tk event loop run when waiting for user input (i.e., during <code>readline</code> method).</p> </dd> <dt id="ornaments"><a class="permalink" href="#ornaments">#</a><code>ornaments</code></dt> <dd> <p>makes the command line stand out by using termcap data. The argument to <code>ornaments</code> should be 0, 1, or a string of a form <code>"aa,bb,cc,dd"</code>. Four components of this string should be names of <i>terminal capacities</i>, first two will be issued to make the prompt standout, last two to make the input line standout.</p> </dd> <dt id="newTTY"><a class="permalink" href="#newTTY">#</a><code>newTTY</code></dt> <dd> <p>takes two arguments which are input filehandle and output filehandle. Switches to use these filehandles.</p> </dd> </dl> <p>One can check whether the currently loaded ReadLine package supports these methods by checking for corresponding <code>Features</code>.</p> <h1 id="EXPORTS"><a class="permalink" href="#EXPORTS">#</a>EXPORTS</h1> <p>None</p> <h1 id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">#</a>ENVIRONMENT</h1> <p>The environment variable <code>PERL_RL</code> governs which ReadLine clone is loaded. If the value is false, a dummy interface is used. If the value is true, it should be tail of the name of the package to use, such as <code>Perl</code> or <code>Gnu</code>.</p> <p>As a special case, if the value of this variable is space-separated, the tail might be used to disable the ornaments by setting the tail to be <code>o=0</code> or <code>ornaments=0</code>. The head should be as described above, say</p> <p>If the variable is not set, or if the head of space-separated list is empty, the best available package is loaded.</p> <pre><code class="plaintext">export "PERL_RL=Perl o=0" # Use Perl ReadLine without ornaments export "PERL_RL= o=0" # Use best available ReadLine without ornaments</code></pre> <p>(Note that processing of <code>PERL_RL</code> for ornaments is in the discretion of the particular used <code>Term::ReadLine::*</code> package).</p> <h1 id="CAVEATS"><a class="permalink" href="#CAVEATS">#</a>CAVEATS</h1> <p>It seems that using Term::ReadLine from Emacs minibuffer doesn't work quite right and one will get an error message like</p> <pre><code class="plaintext">Cannot open /dev/tty for read at ...</code></pre> <p>One possible workaround for this is to explicitly open /dev/tty like this</p> <pre><code>open (FH, "/dev/tty" ) or eval 'sub Term::ReadLine::findConsole { ("&STDIN", "&STDERR") }'; die $@ if $@; close (FH);</code></pre> <p>or you can try using the 4-argument form of Term::ReadLine->new().</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>

CINXE.COM

Term::ReadLine - Perl interface to various readline packages. If no real package is found, substitutes stubs instead of basic functions. - Perldoc Browser