[7152faa] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[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 |
|
---|
[cc197d0] | 26 | <para>The Readline package is a set of libraries that offer command-line
|
---|
[3f3931b0] | 27 | editing and history capabilities.</para>
|
---|
[3125dfb] | 28 |
|
---|
[3f3931b0] | 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
[3125dfb] | 32 |
|
---|
[3f3931b0] | 33 | <seglistitem>
|
---|
[fb386e0] | 34 | <seg>&readline-fin-sbu;</seg>
|
---|
| 35 | <seg>&readline-fin-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>
|
---|
[67e8a9b] | 51 |
|
---|
[2ef9bea] | 52 | <para>Prevent hard coding library search paths (rpath) into
|
---|
| 53 | the shared libraries. This package does not need rpath for an
|
---|
| 54 | installation into the standard location, and rpath may sometimes cause
|
---|
| 55 | unwanted effects or even security issues:</para>
|
---|
| 56 |
|
---|
| 57 | <screen><userinput>sed -i 's/-Wl,-rpath,[^ ]*//' support/shobj-conf</userinput></screen>
|
---|
| 58 |
|
---|
[efae039] | 59 | <para>Now fix a problem identified upstream:</para>
|
---|
| 60 |
|
---|
| 61 | <screen><userinput remap="pre">patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
|
---|
| 62 |
|
---|
[3f3931b0] | 63 | <para>Prepare Readline for compilation:</para>
|
---|
[3125dfb] | 64 |
|
---|
[73b2841] | 65 | <screen><userinput remap="configure">./configure --prefix=/usr \
|
---|
| 66 | --disable-static \
|
---|
[a5dddcb] | 67 | --with-curses \
|
---|
[73b2841] | 68 | --docdir=/usr/share/doc/readline-&readline-version;</userinput></screen>
|
---|
[3125dfb] | 69 |
|
---|
[a5dddcb] | 70 | <variablelist>
|
---|
[cc197d0] | 71 | <title>The meaning of the new configure option:</title>
|
---|
[a5dddcb] | 72 |
|
---|
| 73 | <varlistentry>
|
---|
[45cd4bf] | 74 | <term><parameter>--with-curses</parameter></term>
|
---|
[a5dddcb] | 75 | <listitem>
|
---|
| 76 | <para>This option tells Readline that it can find the termcap
|
---|
[cc197d0] | 77 | library functions in the curses library, not a separate
|
---|
| 78 | termcap library. This will generate the correct
|
---|
[c37e846] | 79 | <filename>readline.pc</filename> file.</para>
|
---|
[a5dddcb] | 80 | </listitem>
|
---|
| 81 | </varlistentry>
|
---|
| 82 |
|
---|
| 83 | </variablelist>
|
---|
| 84 |
|
---|
[3f3931b0] | 85 | <para>Compile the package:</para>
|
---|
[3125dfb] | 86 |
|
---|
[efcb393] | 87 | <screen><userinput remap="make">make SHLIB_LIBS="-lncursesw"</userinput></screen>
|
---|
[3125dfb] | 88 |
|
---|
[3f3931b0] | 89 | <variablelist>
|
---|
| 90 | <title>The meaning of the make option:</title>
|
---|
[81fd230] | 91 |
|
---|
[3f3931b0] | 92 | <varlistentry>
|
---|
[efcb393] | 93 | <term><parameter>SHLIB_LIBS="-lncursesw"</parameter></term>
|
---|
[3f3931b0] | 94 | <listitem>
|
---|
| 95 | <para>This option forces Readline to link against the
|
---|
[1e472fb] | 96 | <filename class="libraryfile">libncursesw</filename> library.</para>
|
---|
[3f3931b0] | 97 | </listitem>
|
---|
| 98 | </varlistentry>
|
---|
[81fd230] | 99 |
|
---|
[3f3931b0] | 100 | </variablelist>
|
---|
[0be3d41] | 101 |
|
---|
[3f3931b0] | 102 | <para>This package does not come with a test suite.</para>
|
---|
| 103 |
|
---|
| 104 | <para>Install the package:</para>
|
---|
[3125dfb] | 105 |
|
---|
[efcb393] | 106 | <screen><userinput remap="install">make SHLIB_LIBS="-lncursesw" install</userinput></screen>
|
---|
[3125dfb] | 107 |
|
---|
[52e836a] | 108 | <para>If desired, install the documentation:</para>
|
---|
| 109 |
|
---|
[a57d556] | 110 | <screen><userinput remap="install">install -v -m644 doc/*.{ps,pdf,html,dvi} /usr/share/doc/readline-&readline-version;</userinput></screen>
|
---|
[52e836a] | 111 |
|
---|
[3f3931b0] | 112 | </sect2>
|
---|
| 113 |
|
---|
| 114 | <sect2 id="contents-readline" role="content">
|
---|
| 115 | <title>Contents of Readline</title>
|
---|
| 116 |
|
---|
| 117 | <segmentedlist>
|
---|
| 118 | <segtitle>Installed libraries</segtitle>
|
---|
[fe05b08] | 119 | <segtitle>Installed directories</segtitle>
|
---|
[3f3931b0] | 120 |
|
---|
| 121 | <seglistitem>
|
---|
[040ecb6] | 122 | <seg>libhistory.so and libreadline.so</seg>
|
---|
[78cc3be] | 123 | <seg>/usr/include/readline and
|
---|
[fe05b08] | 124 | /usr/share/doc/readline-&readline-version;</seg>
|
---|
[3f3931b0] | 125 | </seglistitem>
|
---|
| 126 | </segmentedlist>
|
---|
| 127 |
|
---|
| 128 | <variablelist>
|
---|
| 129 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 130 | <?dbfo list-presentation="list"?>
|
---|
| 131 | <?dbhtml list-presentation="table"?>
|
---|
| 132 |
|
---|
| 133 | <varlistentry id="libhistory">
|
---|
| 134 | <term><filename class="libraryfile">libhistory</filename></term>
|
---|
| 135 | <listitem>
|
---|
| 136 | <para>Provides a consistent user interface for recalling lines
|
---|
| 137 | of history</para>
|
---|
| 138 | <indexterm zone="ch-system-readline libhistory">
|
---|
| 139 | <primary sortas="c-libhistory">libhistory</primary>
|
---|
| 140 | </indexterm>
|
---|
| 141 | </listitem>
|
---|
| 142 | </varlistentry>
|
---|
| 143 |
|
---|
| 144 | <varlistentry id="libreadline">
|
---|
| 145 | <term><filename class="libraryfile">libreadline</filename></term>
|
---|
| 146 | <listitem>
|
---|
[0d84af1] | 147 | <para>Provides a set of commands for manipulating text entered in an
|
---|
[8d35535] | 148 | interactive session of a program</para>
|
---|
[3f3931b0] | 149 | <indexterm zone="ch-system-readline libreadline">
|
---|
| 150 | <primary sortas="c-libreadline">libreadline</primary>
|
---|
| 151 | </indexterm>
|
---|
| 152 | </listitem>
|
---|
| 153 | </varlistentry>
|
---|
| 154 |
|
---|
| 155 | </variablelist>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|
[3125dfb] | 158 |
|
---|
| 159 | </sect1>
|
---|