.. _spkg_readline:

readline: Command line editing library
======================================

Description
-----------

The GNU Readline library provides a set of functions for use by
applications that allow users to edit command lines as they are typed
in. Both Emacs and vi editing modes are available. The Readline library
includes additional functions to maintain a list of previously-entered
command lines, to recall and perhaps reedit those lines, and perform
csh-like history expansion on previous commands.

Website: http://tiswww.case.edu/php/chet/readline/rltop.html

License
-------

-  GPL V3+


Upstream Contact
----------------

-  Chet Ramey at http://cnswww.cns.cwru.edu/~chet

Dependencies
------------

-  ncurses


Special Update/Build Instructions
---------------------------------

We build readline using ncurses. Readline needs to be told to link with
libtinfo (part of ncurses), this is what the patch 0002-ltinfo.patch
does.

Patches
-------

-  0001-macports.patch: Changes to shobj.conf for OS/X, from macports:

   https://trac.macports.org/browser/trunk/dports/devel/readline/files/patch-shobj-conf.diff

-  0002-ltinfo.patch: We build readline using ncurses, and for that it
   needs to be told to link with libtinfo (part of ncurses).

Type
----

standard


Version Information
-------------------

package-version.txt::

    8.0
    


Equivalent System Packages
--------------------------

arch:

.. CODE-BLOCK:: bash

    $ sudo pacman -S  readline-devel

conda:

.. CODE-BLOCK:: bash

    $ conda install readline-devel

cygwin:

.. CODE-BLOCK:: bash

    $ apt-cyg install readline-devel

Debian/Ubuntu:

.. CODE-BLOCK:: bash

    $ sudo apt-get install  readline-devel

Fedora/Redhat/CentOS:

.. CODE-BLOCK:: bash

    $ sudo yum install  readline-devel

freebsd:

.. CODE-BLOCK:: bash

    $ sudo pkg install readline-devel

homebrew:

.. CODE-BLOCK:: bash

    $ brew install readline-devel

nix:

.. CODE-BLOCK:: bash

    $ nix-env --install readline-devel

opensuse:

.. CODE-BLOCK:: bash

    $ sudo zypper install readline-devel

slackware:

.. CODE-BLOCK:: bash

    $ sudo slackpkg install readline-devel

void:

.. CODE-BLOCK:: bash

    $ sudo xbps-install  readline-devel

See https://repology.org/project/readline-devel/versions

If the system package is installed, ./configure will check whether it can be used.