source: clfs-sysroot/BOOK/final-system/common/readline.xml

Last change on this file was ceca635c, checked in by Joe Ciccone <jciccone@…>, 13 years ago

Added readline branch update patch.

  • Property mode set to 100644
File size: 3.8 KB
Line 
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  <title>Readline-&readline-version;</title>
12
13  <indexterm zone="ch-system-readline">
14    <primary sortas="a-Readline">Readline</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Readline package is a set of libraries that offers command-line
21    editing and history capabilities.</para>
22
23  </sect2>
24
25  &env-target;
26
27  <sect2 role="installation">
28    <title>Installation of Readline</title>
29
30    <para os="p1">The following patch contains updates from the maintainer. The
31    maintainer of Readline only releases these patches to fix serious issues:</para>
32
33<screen os="p2"><userinput>patch -Np1 -i ../&readline-branch_update-patch;</userinput></screen>
34
35    <para os="s1">This option forces Readline to link against the
36          <filename class="libraryfile">libncursesw</filename> library:</para>
37
38<screen os="s2"><userinput>sed -i 's:^SHLIB_LIBS=:SHLIB_LIBS=-lncursesw:' support/shobj-conf</userinput></screen>
39
40    <para os="a">Prepare Readline for compilation:</para>
41
42<screen os="b"><userinput>./configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
43    --prefix=/usr --libdir=/lib</userinput></screen>
44
45    <para os="c">Compile the package:</para>
46
47<screen os="d"><userinput>make</userinput></screen>
48
49    <para os="e">Install the package:</para>
50
51<screen os="f"><userinput>make DESTDIR=${CLFS} install</userinput></screen>
52
53    <para os="h">Install the documentation:</para>
54
55<screen os="i"><userinput>make DESTDIR=${CLFS} install-doc</userinput></screen>
56
57    <para os="j">Now move the static libraries to a more appropriate location:</para>
58
59<screen os="k"><userinput>mv -v ${CLFS}/lib/lib{readline,history}.a ${CLFS}/usr/lib</userinput></screen>
60
61    <para os="l">Next, remove the <filename class="extension">.so</filename>
62    files in <filename class="directory">/lib</filename> and relink them into
63    <filename class="directory">/usr/lib</filename>.</para>
64
65<screen os="m"><userinput>rm -v ${CLFS}/lib/lib{readline,history}.so
66ln -sfv ../../lib/libreadline.so.&readline-version2; ${CLFS}/usr/lib/libreadline.so
67ln -sfv ../../lib/libhistory.so.&readline-version2; ${CLFS}/usr/lib/libhistory.so</userinput></screen>
68
69  </sect2>
70
71  <sect2 id="contents-readline" role="content">
72    <title>Contents of Readline</title>
73
74    <segmentedlist>
75      <segtitle>Installed libraries</segtitle>
76
77      <seglistitem>
78        <seg>libhistory.[a,so], and libreadline.[a,so]</seg>
79      </seglistitem>
80    </segmentedlist>
81
82    <variablelist>
83      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
84      <?dbfo list-presentation="list"?>
85      <?dbhtml list-presentation="table"?>
86
87      <varlistentry id="libhistory">
88        <term><filename class="libraryfile">libhistory</filename></term>
89        <listitem>
90          <para>Provides a consistent user interface
91          for recalling lines of history</para>
92          <indexterm zone="ch-system-readline libhistory">
93            <primary sortas="c-libhistory">libhistory</primary>
94          </indexterm>
95        </listitem>
96      </varlistentry>
97
98      <varlistentry id="libreadline">
99        <term><filename class="libraryfile">libreadline</filename></term>
100        <listitem>
101          <para>Aids in the consistency of user interface
102          across discrete programs that need to provide a command line
103          interface</para>
104          <indexterm zone="ch-system-readline libreadline">
105            <primary sortas="c-libreadline">libreadline</primary>
106          </indexterm>
107        </listitem>
108      </varlistentry>
109
110    </variablelist>
111
112  </sect2>
113
114</sect1>
Note: See TracBrowser for help on using the repository browser.