/ 
Term-ReadLine-Perl5-1.31
River stage zero No dependents
/ Term::ReadLine::Perl5

NAME

Term::ReadLine::Perl5 - A Perl5 implementation GNU Readline

SYNOPSIS

use Term::ReadLine::Perl5;
$term = new Term::ReadLine::Perl5 'ProgramName';
while ( defined ($_ = $term->readline('prompt>')) ) {
  ...
}

DESCRIPTION

Overview

This is a implementation of the GNU Readline/History Library written in Perl5.

GNU Readline reads lines from an interactive terminal with emacs or vi editing capabilities. It provides as mechanism for saving history of previous input.

This package typically used in command-line interfaces and REPLs (Read, Eval, Print, Loop).

SUBROUTINES

Term::ReadLine::Perl->new($name, [*IN, [*OUT])

Returns a handle for subsequent calls to readline functions.

$name is the name of the application.

Optionally you can add two arguments for input and output filehandles. These arguments should be globs.

This routine might also be called via Term::ReadLine->new($term_name) if other Term::ReadLine packages like Term::ReadLine::Gnu is not available or if you have $ENV{PERL_RL} set to 'Perl5';

At present, because this code has lots of global state, we currently don't support more than one readline instance.

Somebody please volunteer to rewrite this code!

stifle_history

stifle_history($max)

Stifle or put a cap on the history list, remembering only $max number of lines.

Minline

MinLine([$minlength])

If $minlength is given, set $readline::minlength the minimum length a $line for it to go into the readline history.

The previous value is returned.

remove_history

remove_history($which)

Remove history element $which from the history. The removed element is returned.

Variables

Following GNU Readline/History Library variables can be accessed from Perl program. See 'GNU Readline Library Manual' and ' GNU History Library Manual' for each variable. You can access them via the Attribs method. Names of keys in this hash conform to standard conventions with the leading rl_ stripped.

Example:

$term = new Term::ReadLine::Perl5 'ReadLineTest'
$attribs = $term->Attribs;
$v = $attribs->{history_base};	# history_base

Attribute Names

	completion_suppress_append (bool)
	history_base               (int)
	history_stifled            (int)
        history_length             (int)
        max_input_history          (int)
	outstream                  (file handle)

INSTALL

To install this module type:

perl Build.PL
make
# for interactive testing:
make test
# for non-interactive testing
AUTOMATED_TESTING=1 make test
make install # might need sudo make install

DEVELOPMENT HISTORY

The first implementation was in Perl4 (mostly) by Jeffrey Friedl. He referenced FSF the code Roland Schemers line_edit.pl.

Ilya Zakharevich turned this into a Perl5 module called Term::ReadLine::Perl. Some of the changes he made include using Term::ReadKey if present, and made this work under xterm. The file Term/ReadLine/Perl5/CHANGES up to but not including version 1.04 contains a list of his changes.

Starting with version 1.04 Rocky Bernstein forked the code, adding GNU readline history. He put it into a public git repository (github) and also started modernizing it by doing the things CPAN prefers, including adding POD documentation, non-interactive tests, and respecting CPAN module namespaces.

BUGS

Bugs are accepted via the github issues tracker.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free Software Foundation; version 2, or

b) the "Artistic License" which comes with Perl.