source: final-system/common/readline.xml @ bf8c11f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  <!ENTITY % patches-entities SYSTEM "../../patches.ent">
  %general-entities;
  %patches-entities;
]>

<sect1 id="ch-system-readline" role="wrap">
  <?dbhtml filename="readline.html"?>

  <title>Readline-&readline-version;</title>

  <indexterm zone="ch-system-readline">
    <primary sortas="a-Readline">Readline</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Readline package is a set of libraries that offers command-line
    editing and history capabilities.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>Not checked yet</seg>
        <seg>Not checked yet</seg>
      </seglistitem>
    </segmentedlist>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Binutils, Coreutils, Diffutils, Gawk,
        GCC, Glibc, Grep, Make, Ncurses, and Sed</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Readline</title>

    <para os="a">The following patch includes a fix for a problem where Readline
    sometimes only shows 33 characters on a line and then wraps to the
    next line. It also includes other fixes recommended by the Readline
    author.</para>

<screen os="b"><userinput>patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>

    <para os="c">Prepare Readline for compilation:</para>

<screen><userinput>./configure --prefix=/usr --libdir=/lib</userinput></screen>

    <para os="d">Compile the package:</para>

<screen os="e"><userinput>make SHLIB_XLDFLAGS=-lncurses</userinput></screen>

    <variablelist os="f">
      <title>The meaning of the make option:</title>

      <varlistentry>
        <term><parameter>SHLIB_XLDFLAGS=-lncurses</parameter></term>
        <listitem>
          <para>This option forces Readline to link against the
          <filename class="libraryfile">libncurses</filename> library.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para os="g">Install the package:</para>

<screen os="h"><userinput>make install</userinput></screen>

    <para os="i">Give Readline's dynamic libraries to a more appropriate
    permissions:</para>

<screen os="j"><userinput>chmod 755 /lib/lib{readline,history}.so*</userinput></screen>

    <para os="k">Now move the static libraries to a more appropriate location:</para>

<screen os="l"><userinput>mv /lib/lib{readline,history}.a /usr/lib</userinput></screen>

    <para os="m">Next, remove the <filename class="extension">.so</filename>
    files in <filename class="directory">/lib</filename> and relink them into
    <filename class="directory">/usr/lib</filename>.</para>

<screen os="n"><userinput>rm /lib/lib{readline,history}.so
ln -sf ../../lib/libreadline.so.5 /usr/lib/libreadline.so
ln -sf ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>

  </sect2>

  <sect2 id="contents-readline" role="content">
    <title>Contents of Readline</title>

    <segmentedlist>
      <segtitle>Installed libraries</segtitle>

      <seglistitem>
        <seg>libhistory.[a,so], and libreadline.[a,so]</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libhistory">
        <term><filename class="libraryfile">libhistory</filename></term>
        <listitem>
          <para>Provides a consistent user interface
          for recalling lines of history</para>
          <indexterm zone="ch-system-readline libhistory">
            <primary sortas="c-libhistory">libhistory</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libreadline">
        <term><filename class="libraryfile">libreadline</filename></term>
        <listitem>
          <para>Aids in the consistency of user interface
          across discrete programs that need to provide a command line
          interface</para>
          <indexterm zone="ch-system-readline libreadline">
            <primary sortas="c-libreadline">libreadline</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>