aboutsummaryrefslogtreecommitdiffstats
path: root/chapter06/readline.xml
diff options
context:
space:
mode:
Diffstat (limited to 'chapter06/readline.xml')
-rw-r--r--chapter06/readline.xml66
1 files changed, 57 insertions, 9 deletions
diff --git a/chapter06/readline.xml b/chapter06/readline.xml
index cd15918ec..7c3a1b3d0 100644
--- a/chapter06/readline.xml
+++ b/chapter06/readline.xml
@@ -3,27 +3,35 @@
<!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities;
]>
-<sect1 id="ch-system-readline" xreflabel="Readline" role="wrap">
+<sect1 id="ch-system-readline" role="wrap">
<title>Readline-&readline-version;</title>
<?dbhtml filename="readline.html"?>
<indexterm zone="ch-system-readline"><primary sortas="a-Readline">Readline</primary></indexterm>
<sect2 role="package"><title/>
+<para>The Readline package contains the Readline command-line library.</para>
<segmentedlist>
<segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
-<seglistitem><seg>XXX SBU</seg><seg>3.8 MB</seg></seglistitem>
+<seglistitem><seg>0.11 SBU</seg><seg>3.8 MB</seg></seglistitem>
</segmentedlist>
+<segmentedlist>
+<segtitle>Readline installation depends on</segtitle>
+<seglistitem><seg>Binutils, Coreutils, Diffutils, Gawk,
+GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
+</segmentedlist>
</sect2>
<sect2 role="installation">
<title>Installation of Readline</title>
-<!-- NEW set of commands-->
-<para>Apply a patch.</para>
+<para>The following patch includes a fix for the problem where
+Readline sometimes only shows 33 characters on a line and then wraps
+to the next line. It also includes other fixes recommended by the
+Readline author.</para>
<screen><userinput>patch -Np1 -i ../readline-&readline-version;-fixes-1.patch</userinput></screen>
@@ -35,31 +43,71 @@
<screen><userinput>make SHLIB_XLDFLAGS=-lncurses</userinput></screen>
+<para>The meaning of the make option:</para>
+
+<variablelist>
+<varlistentry>
+<term><parameter>SHLIB_XLDFLAGS=-lncurses</parameter></term>
+<listitem><para>This option forces Readline to link against the
+<filename class="libraryfile">libncurses</filename> library.</para></listitem>
+</varlistentry>
+</variablelist>
+
<para>Install the package:</para>
<screen><userinput>make install</userinput></screen>
-<para>Give Readline's dynamic libraries to a more appropriate permissions:</para>
+<para>Give Readline's dynamic libraries more appropriate permissions:</para>
<screen><userinput>chmod 755 /lib/lib{readline,history}.so*</userinput></screen>
-<para>Now we move the static libraries to a more appropriate location:</para>
+<para>Now we move the static libraries to a more appropriate
+location:</para>
<screen><userinput>mv /lib/lib{readline,history}.a /usr/lib</userinput></screen>
-<para>Now we will remove the old, .so files in /lib and relink them into /usr/lib.</para>
+<para>Next we will remove the old, <filename>.so</filename> files in
+<filename class="directory">/lib</filename> and relink them into
+<filename class="directory">/usr/lib</filename>.</para>
<screen><userinput>rm /lib/lib{readline,history}.so
ln -sf ../../lib/libreadline.so.5 /usr/lib/libreadline.so
ln -sf ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>
+
</sect2>
<sect2 id="contents-readline" role="content"><title>Contents of Readline</title>
+<segmentedlist>
+<segtitle>Installed libraries</segtitle>
+<seglistitem><seg>libhistory.[a,so], and libreadline.[a,so]</seg></seglistitem>
+</segmentedlist>
-<para>See testing</para>
+<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
+<?dbfo list-presentation="list"?>
+
+<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>Aids in the consistency of user interface
+across discrete programs that need to provide a command line
+interface</para>
+<indexterm zone="ch-system-readline libreadline"><primary sortas="c-libreadline">libreadline</primary></indexterm>
+</listitem>
+</varlistentry>
+
+</variablelist>
</sect2>
-
</sect1>
+