/ 
Term-ReadLine-Gnu-1.44
River stage two • 24 direct dependents • 98 total dependents
⭐ Starred 5 GitHub stars
/ INSTALL.md

How to Install Term::ReadLine::Gnu

You need the GNU Readline library installed. Except for this, you can install this module by the standard method, i.e.

% perl Makefile.PL && make install

Make and install

% perl Makefile.PL [--prefix=...] [--includedir=...] [--libdir=...]
% make
% make test
% make install

If you have installed the GNU Readline Library (libreadline.{a,so} and readline/readline.h, etc.) on directories for which your perl is not configured to search (refer the value of ccflags and libpath in the output of perl -V), specify the paths as follows:

% perl Makefile.PL --includedir=/mydir/include --libdir=/mydir/lib

You may also use --prefix option. The example above is equivalent to the following:

% perl Makefile.PL --prefix=/mydir

You can specify multiple directories by separating them with colons;

% perl Makefile.PL --prefix=/termcap/dir:/readline/dir

If you are not an administrator and cannot install Perl module in your system directory, see the section: How do I keep my own module/library directory? in perlfaq8.

Trouble Shooting

If you have any troubles when using or installing this module or find a bug, please open a ticket on the bug tracker on GitHub.

It will help other people who have the same problem.

When you report your issue, be sure to send me the following information:

% perl -V
% perl Makefile.PL verbose
% make test TEST_VERBOSE=1
% perl -Mblib t/00checkver.t
% echo $TERM

Segmentation fault by the pager command in Perl debugger

If the pager command (| or ||) in Perl debugger causes segmentation fault, you need to fix perl5db.pl. See this ticket for details. The patch was applied on perl 5.19.9.

How to Install the GNU Readline Library

Now this module supports only the GNU Readline Library 2.1 and later. But the GNU Readline 2.2 has some bugs, so Use 2.2.1 instead. The GNU Readline Library 4.2 is not supported. Use 4.2a instead.

Executing perl Makefile.PL detects which version of the GNU Readline Library is installed and warns you if you have the unsupported version.

The following example assumes that the install prefix directory is /usr/local/gnu.

If you have any reasons in which you must use one of the following old libraries, see INSTALL file which is included in Term-ReadLine-Gnu-1.11.

Install from source code of the GNU Readline Library

  1. get and extract readline-XX.tar.gz
  2. configure
% ./configure --prefix=/usr/local/gnu
  1. make and install
% make install

Install on macOS

On macOS Big Sur or later 'perl Makefile.PL' may be warned as

Could not find neither libtermcap, libtinfo, libncurses, or libcurses.

You should be able to ignore this warning if you have Xcode installed. See https://github.com/Perl-Toolchain-Gang/ExtUtils-MakeMaker/issues/381 for details. To suppress this message, use ExtUtils::MakeMaker 7.58 or later.

/usr/bin/perl on macOS 10.5 (Leopard) and later supports 32bit/64bit universal binary. Make Makefile as follows:

# tested only on Mavericks
ARCHFLAGS='-arch x86_64' perl Makefile.PL --prefix=/usr/local/gnu

Or build 32bit/64bit-universal GNU Readline Library as follows. (works on the GNU Readline 6.3 and later)

Enable the following lines in support/shobj-conf in the GNU Readline 6.3 distribution;

# for 32 and 64bit universal library
#SHOBJ_ARCHFLAGS='-arch i386 -arch x86_64'
#SHOBJ_CFLAGS=${SHOBJ_CFLAGS}' -arch i386 -arch x86_64'

Run configure script and do make install and make Makefile simply:

# tested only on Mavericks
perl Makefile.PL --prefix=/usr/local/gnu

Using Package

apt based Linux

On apt-based Linux you need to install libncurses-dev package in addition to ibreadline-dev package.

% sudo apt install libncurses-dev libreadline-dev

RPM based Linux

On RPM-based Linux you need to install ncurses-devel package in addition to readline-devel package.

% sudo yum install ncurses-devel
% sudo yum install readline-devel

Homebrew on macOS

  1. Install Homebrew See https://brew.sh/.

  2. Use homebrew to install the GNU Readline Library:

% brew install readline

Because the GNU Readline library conflicts with the the similarly-named-but-different library installed in the base OS, homebrew does not link readline into /usr/local (it is "keg-only").

Makefile.PL uses brew prefix readline to find and use the "keg" directory so things work seamlessly.

  1. Build Term::ReadLine::Gnu as described above:
% perl Makefile.PL
% make
% make test
% make install

brew cleanup will not remove keg-only formula, to avoid breaking things that have been linked against it. However, if you force it, brew cleanup --force, then it will remove the keg-only formula and Term::ReadLine::Gnu will cease to work. You'll need to rebuild Term::ReadLine::GNU so that it links against whichever newer version you have installed.

MSYS2

  1. Install MSYS2: See https://www.msys2.org/ .

  2. Install additional packages:

% pacman -S msys2-devel msys2-runtime-devel msys/libreadline-devel libcrypt-devel
  1. Build: on MSYS2 environment:
% perl Makefile.PL
% make
% make test
% make install