[3125dfb] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[b06ca36] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[3125dfb] | 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
[3f3931b0] | 7 |
|
---|
[81fd230] | 8 | <sect1 id="ch-system-readline" role="wrap">
|
---|
[3f3931b0] | 9 | <?dbhtml filename="readline.html"?>
|
---|
| 10 |
|
---|
[e747759] | 11 | <sect1info condition="script">
|
---|
| 12 | <productname>readline</productname>
|
---|
| 13 | <productnumber>&readline-version;</productnumber>
|
---|
| 14 | <address>&readline-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
[3f3931b0] | 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/>
|
---|
[3125dfb] | 25 |
|
---|
[3f3931b0] | 26 | <para>The Readline package is a set of libraries that offers command-line
|
---|
| 27 | editing and history capabilities.</para>
|
---|
[3125dfb] | 28 |
|
---|
[3f3931b0] | 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
[3125dfb] | 32 |
|
---|
[3f3931b0] | 33 | <seglistitem>
|
---|
[e4a5635] | 34 | <seg>&readline-ch6-sbu;</seg>
|
---|
| 35 | <seg>&readline-ch6-du;</seg>
|
---|
[3f3931b0] | 36 | </seglistitem>
|
---|
| 37 | </segmentedlist>
|
---|
[3125dfb] | 38 |
|
---|
[3f3931b0] | 39 | </sect2>
|
---|
| 40 |
|
---|
| 41 | <sect2 role="installation">
|
---|
| 42 | <title>Installation of Readline</title>
|
---|
| 43 |
|
---|
[2ed4bb3f] | 44 | <para>Reinstalling Readline will cause the old libraries to be moved to
|
---|
| 45 | <libraryname>.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 |
|
---|
[0445a3d] | 49 | <screen><userinput remap="pre">sed -i '/MV.*old/d' Makefile.in
|
---|
[2ed4bb3f] | 50 | sed -i '/{OLDSUFF}/c:' support/shlib-install</userinput></screen>
|
---|
| 51 |
|
---|
[c38b204] | 52 | <para>Readline contains a bug in its handling of non-multibyte characters,
|
---|
| 53 | which can lead to incorrect display calculations and incorrect redisplay.
|
---|
| 54 | Fix this issue by applying the following patch from the upstream maintainer:
|
---|
| 55 | </para>
|
---|
| 56 |
|
---|
[0445a3d] | 57 | <screen><userinput remap="pre">patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
|
---|
[c38b204] | 58 |
|
---|
[3f3931b0] | 59 | <para>Prepare Readline for compilation:</para>
|
---|
[3125dfb] | 60 |
|
---|
[0445a3d] | 61 | <screen><userinput remap="configure">./configure --prefix=/usr --libdir=/lib</userinput></screen>
|
---|
[3125dfb] | 62 |
|
---|
[3f3931b0] | 63 | <para>Compile the package:</para>
|
---|
[3125dfb] | 64 |
|
---|
[0445a3d] | 65 | <screen><userinput remap="make">make SHLIB_LIBS=-lncurses</userinput></screen>
|
---|
[3125dfb] | 66 |
|
---|
[3f3931b0] | 67 | <variablelist>
|
---|
| 68 | <title>The meaning of the make option:</title>
|
---|
[81fd230] | 69 |
|
---|
[3f3931b0] | 70 | <varlistentry>
|
---|
| 71 | <term><parameter>SHLIB_LIBS=-lncurses</parameter></term>
|
---|
| 72 | <listitem>
|
---|
| 73 | <para>This option forces Readline to link against the
|
---|
| 74 | <filename class="libraryfile">libncurses</filename> (really,
|
---|
| 75 | <filename class="libraryfile">libncursesw</filename>) library.</para>
|
---|
| 76 | </listitem>
|
---|
| 77 | </varlistentry>
|
---|
[81fd230] | 78 |
|
---|
[3f3931b0] | 79 | </variablelist>
|
---|
[0be3d41] | 80 |
|
---|
[3f3931b0] | 81 | <para>This package does not come with a test suite.</para>
|
---|
| 82 |
|
---|
| 83 | <para>Install the package:</para>
|
---|
[3125dfb] | 84 |
|
---|
[0445a3d] | 85 | <screen><userinput remap="install">make install</userinput></screen>
|
---|
[3125dfb] | 86 |
|
---|
[3f3931b0] | 87 | <para>Now move the static libraries to a more appropriate location:</para>
|
---|
[3125dfb] | 88 |
|
---|
[0445a3d] | 89 | <screen><userinput remap="install">mv -v /lib/lib{readline,history}.a /usr/lib</userinput></screen>
|
---|
[3125dfb] | 90 |
|
---|
[3f3931b0] | 91 | <para>Next, remove the <filename class="extension">.so</filename> files in
|
---|
| 92 | <filename class="directory">/lib</filename> and relink them into <filename
|
---|
[e1060de] | 93 | class="directory">/usr/lib</filename>:</para>
|
---|
[7111666] | 94 |
|
---|
[0445a3d] | 95 | <screen><userinput remap="install">rm -v /lib/lib{readline,history}.so
|
---|
[5998892] | 96 | ln -sfv ../../lib/libreadline.so.5 /usr/lib/libreadline.so
|
---|
| 97 | ln -sfv ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>
|
---|
[81fd230] | 98 |
|
---|
[3f3931b0] | 99 | </sect2>
|
---|
| 100 |
|
---|
| 101 | <sect2 id="contents-readline" role="content">
|
---|
| 102 | <title>Contents of Readline</title>
|
---|
| 103 |
|
---|
| 104 | <segmentedlist>
|
---|
| 105 | <segtitle>Installed libraries</segtitle>
|
---|
| 106 |
|
---|
| 107 | <seglistitem>
|
---|
[0090db5] | 108 | <seg>libhistory.{a,so}, and libreadline.{a,so}</seg>
|
---|
[3f3931b0] | 109 | </seglistitem>
|
---|
| 110 | </segmentedlist>
|
---|
| 111 |
|
---|
| 112 | <variablelist>
|
---|
| 113 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 114 | <?dbfo list-presentation="list"?>
|
---|
| 115 | <?dbhtml list-presentation="table"?>
|
---|
| 116 |
|
---|
| 117 | <varlistentry id="libhistory">
|
---|
| 118 | <term><filename class="libraryfile">libhistory</filename></term>
|
---|
| 119 | <listitem>
|
---|
| 120 | <para>Provides a consistent user interface for recalling lines
|
---|
| 121 | of history</para>
|
---|
| 122 | <indexterm zone="ch-system-readline libhistory">
|
---|
| 123 | <primary sortas="c-libhistory">libhistory</primary>
|
---|
| 124 | </indexterm>
|
---|
| 125 | </listitem>
|
---|
| 126 | </varlistentry>
|
---|
| 127 |
|
---|
| 128 | <varlistentry id="libreadline">
|
---|
| 129 | <term><filename class="libraryfile">libreadline</filename></term>
|
---|
| 130 | <listitem>
|
---|
| 131 | <para>Aids in the consistency of user interface across discrete
|
---|
| 132 | programs that need to provide a command line interface</para>
|
---|
| 133 | <indexterm zone="ch-system-readline libreadline">
|
---|
| 134 | <primary sortas="c-libreadline">libreadline</primary>
|
---|
| 135 | </indexterm>
|
---|
| 136 | </listitem>
|
---|
| 137 | </varlistentry>
|
---|
| 138 |
|
---|
| 139 | </variablelist>
|
---|
| 140 |
|
---|
| 141 | </sect2>
|
---|
[3125dfb] | 142 |
|
---|
| 143 | </sect1>
|
---|