chapter06/readline.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-readline" role="wrap">
   9   <?dbhtml filename="readline.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>readline</productname>
  13     <productnumber>&readline-version;</productnumber>
  14     <address>&readline-url;</address>
  15   </sect1info>
  16
  17   <title>Readline-&readline-version;</title>
  18
  19   <indexterm zone="ch-system-readline">
  20     <primary sortas="a-Readline">Readline</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Readline package is a set of libraries that offers command-line
  27     editing and history capabilities.</para>
  28
  29     <segmentedlist>
  30       <segtitle>&buildtime;</segtitle>
  31       <segtitle>&diskspace;</segtitle>
  32
  33       <seglistitem>
  34         <seg>&readline-ch6-sbu;</seg>
  35         <seg>&readline-ch6-du;</seg>
  36       </seglistitem>
  37     </segmentedlist>
  38
  39   </sect2>
  40
  41   <sect2 role="installation">
  42     <title>Installation of Readline</title>
  43
  44     <para>Reinstalling Readline will cause the old libraries to be moved to
  45     &lt;libraryname&gt;.old. While this is normally not a problem, in some cases
  46     it can trigger a linking bug in <command>ldconfig</command>. This can be
  47     avoided by issuing the following two seds:</para>
  48
  49 <screen><userinput remap="pre">sed -i '/MV.*old/d' Makefile.in
  50 sed -i '/{OLDSUFF}/c:' support/shlib-install</userinput></screen>
  51
  52     <para>Prepare Readline for compilation:</para>
  53
  54 <screen><userinput remap="configure">./configure --prefix=/usr    \
  55             --disable-static \
  56             --docdir=/usr/share/doc/readline-&readline-version;</userinput></screen>
  57
  58     <para>Compile the package:</para>
  59
  60 <screen><userinput remap="make">make SHLIB_LIBS=-lncurses</userinput></screen>
  61
  62     <variablelist>
  63       <title>The meaning of the make option:</title>
  64
  65       <varlistentry>
  66         <term><parameter>SHLIB_LIBS=-lncurses</parameter></term>
  67         <listitem>
  68           <para>This option forces Readline to link against the
  69           <filename class="libraryfile">libncurses</filename> (really,
  70           <filename class="libraryfile">libncursesw</filename>) library.</para>
  71         </listitem>
  72       </varlistentry>
  73
  74     </variablelist>
  75
  76     <para>This package does not come with a test suite.</para>
  77
  78     <para>Install the package:</para>
  79
  80 <screen><userinput remap="install">make SHLIB_LIBS=-lncurses install</userinput></screen>
  81
  82     <para>Now move the dynamic libraries to a more appropriate location
  83     and fix up some symbolic links:</para>
  84
  85 <screen><userinput remap="install">mv -v /usr/lib/lib{readline,history}.so.* /lib
  86 ln -sfv ../../lib/$(readlink /usr/lib/libreadline.so) /usr/lib/libreadline.so
  87 ln -sfv ../../lib/$(readlink /usr/lib/libhistory.so ) /usr/lib/libhistory.so</userinput></screen>
  88
  89     <para>If desired, install the documentation:</para>
  90
  91 <screen><userinput remap="install">install -v -m644 doc/*.{ps,pdf,html,dvi} /usr/share/doc/readline-&readline-version;</userinput></screen>
  92
  93   </sect2>
  94
  95   <sect2 id="contents-readline" role="content">
  96     <title>Contents of Readline</title>
  97
  98     <segmentedlist>
  99       <segtitle>Installed libraries</segtitle>
 100       <segtitle>Installed directories</segtitle>
 101
 102       <seglistitem>
 103         <seg>libhistory.so and libreadline.so</seg>
 104         <seg>/usr/include/readline, /usr/share/readline, and
 105         /usr/share/doc/readline-&readline-version;</seg>
 106       </seglistitem>
 107     </segmentedlist>
 108
 109     <variablelist>
 110       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 111       <?dbfo list-presentation="list"?>
 112       <?dbhtml list-presentation="table"?>
 113
 114       <varlistentry id="libhistory">
 115         <term><filename class="libraryfile">libhistory</filename></term>
 116         <listitem>
 117           <para>Provides a consistent user interface for recalling lines
 118           of history</para>
 119           <indexterm zone="ch-system-readline libhistory">
 120             <primary sortas="c-libhistory">libhistory</primary>
 121           </indexterm>
 122         </listitem>
 123       </varlistentry>
 124
 125       <varlistentry id="libreadline">
 126         <term><filename class="libraryfile">libreadline</filename></term>
 127         <listitem>
 128           <para>Aids in the consistency of user interface across discrete
 129           programs that need to provide a command line interface</para>
 130           <indexterm zone="ch-system-readline libreadline">
 131             <primary sortas="c-libreadline">libreadline</primary>
 132           </indexterm>
 133         </listitem>
 134       </varlistentry>
 135
 136     </variablelist>
 137
 138   </sect2>
 139
 140 </sect1>