source: chapter08/readline.xml@ e0850a7

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

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

  <sect1info condition="script">
    <productname>readline</productname>
    <productnumber>&readline-version;</productnumber>
    <address>&readline-url;</address>
  </sect1info>

  <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 offer command-line
    editing and history capabilities.</para>

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

      <seglistitem>
        <seg>&readline-fin-sbu;</seg>
        <seg>&readline-fin-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para>Reinstalling Readline will cause the old libraries to be moved to
    &lt;libraryname&gt;.old. While this is normally not a problem, in some cases
    it can trigger a linking bug in <command>ldconfig</command>. This can be
    avoided by issuing the following two seds:</para>

<screen><userinput remap="pre">sed -i '/MV.*old/d' Makefile.in
sed -i '/{OLDSUFF}/c:' support/shlib-install</userinput></screen>

    <para>Prevent hard coding library search paths (rpath) into
    the shared libraries.  This package does not need rpath for an
    installation into the standard location, and rpath may sometimes cause
    unwanted effects or even security issues:</para>

<screen><userinput>sed -i 's/-Wl,-rpath,[^ ]*//' support/shobj-conf</userinput></screen>

    <para>Now fix a problem identified upstream:</para>

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

    <para>Prepare Readline for compilation:</para>

<screen><userinput remap="configure">./configure --prefix=/usr    \
            --disable-static \
            --with-curses    \
            --docdir=/usr/share/doc/readline-&readline-version;</userinput></screen>

     <variablelist>
      <title>The meaning of the new configure option:</title>

      <varlistentry>
        <term><parameter>--with-curses</parameter></term>
        <listitem>
          <para>This option tells Readline that it can find the termcap
          library functions in the curses library, not a separate
          termcap library. This will generate the correct
          <filename>readline.pc</filename> file.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>Compile the package:</para>

<screen><userinput remap="make">make SHLIB_LIBS="-lncursesw"</userinput></screen>

    <variablelist>
      <title>The meaning of the make option:</title>

      <varlistentry>
        <term><parameter>SHLIB_LIBS="-lncursesw"</parameter></term>
        <listitem>
          <para>This option forces Readline to link against the
          <filename class="libraryfile">libncursesw</filename> library.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>This package does not come with a test suite.</para>

    <para>Install the package:</para>

<screen><userinput remap="install">make SHLIB_LIBS="-lncursesw" install</userinput></screen>

    <para>If desired, install the documentation:</para>

<screen><userinput remap="install">install -v -m644 doc/*.{ps,pdf,html,dvi} /usr/share/doc/readline-&readline-version;</userinput></screen>

  </sect2>

  <!-- - - - - - - - - - -->
  <!-- Multilib - 32bit  -->
  <!-- - - - - - - - - - -->
  
  <sect2 arch="ml_32,ml_all" role="installation">
    <title>Installation of Readline - 32bit</title>

    <para>Clean previous build:</para>

<screen><userinput remap="pre">make distclean</userinput></screen>

    <para>Prepare Readline for compilation:</para>

<screen><userinput remap="configure">CC="gcc -m32" ./configure \
    --host=i686-pc-linux-gnu      \
    --prefix=/usr                 \
    --libdir=/usr/lib32           \
    --disable-static              \
    --with-curses</userinput></screen>

    <para>Compile the package:</para>

<screen><userinput remap="make">make SHLIB_LIBS="-lncursesw"</userinput></screen>

    <para>Install the package:</para>

<screen><userinput remap="install">make SHLIB_LIBS="-lncursesw" DESTDIR=$PWD/DESTDIR install
cp -Rv DESTDIR/usr/lib32/* /usr/lib32
rm -rf DESTDIR</userinput></screen>

  </sect2><!-- m32 -->

  <!-- - - - - - - - - - -->
  <!-- Multilib - x32bit -->
  <!-- - - - - - - - - - -->
  
  <sect2 arch="ml_x32,ml_all" role="installation">
    <title>Installation of Readline - x32bit</title>

    <para>Clean previous build:</para>

<screen><userinput remap="pre">make distclean</userinput></screen>

    <para>Prepare Readline for compilation:</para>

<screen><userinput remap="configure">CC="gcc -mx32" ./configure \
    --host=x86_64-pc-linux-gnux32 \
    --prefix=/usr                 \
    --libdir=/usr/libx32          \
    --disable-static              \
    --with-curses</userinput></screen>

    <para>Compile the package:</para>

<screen><userinput remap="make">make SHLIB_LIBS="-lncursesw"</userinput></screen>

    <para>Install the package:</para>

<screen><userinput remap="install">make SHLIB_LIBS="-lncursesw" DESTDIR=$PWD/DESTDIR install
cp -Rv DESTDIR/usr/libx32/* /usr/libx32
rm -rf DESTDIR</userinput></screen>

  </sect2><!-- mx32 -->

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

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

      <seglistitem>
        <seg>libhistory.so and libreadline.so</seg>
        <seg>/usr/include/readline and
        /usr/share/doc/readline-&readline-version;</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>Provides a set of commands for manipulating text entered in an
          interactive session of a program</para>
          <indexterm zone="ch-system-readline libreadline">
            <primary sortas="c-libreadline">libreadline</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>