source: final-system/common/readline.xml @ dd9906e

Last change on this file since dd9906e was dd9906e, checked in by Jim Gifford <clfs@…>, 18 years ago

r1167@server (orig r1165): chris | 2006-02-11 08:13:02 -0800
Added -v to commands in the rest of the book

  • Property mode set to 100644
File size: 4.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3  "http://www.oasis-open.org/docbook/xml/4.4/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    <segmentedlist>
24      <segtitle>&dependencies;</segtitle>
25
26      <seglistitem>
27        <seg>Binutils, Coreutils, Diffutils, Gawk,
28        GCC, Glibc, Grep, Make, Ncurses, Patch, and Sed</seg>
29      </seglistitem>
30    </segmentedlist>
31
32  </sect2>
33
34  <sect2 role="installation">
35    <title>Installation of Readline</title>
36
37    <para os="p1">The following patch are updates from the maintainer. The
38    maintainer of Readline only releases these patches to fix serious issues.</para>
39
40<screen os="p2"><userinput>patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
41
42    <para os="c">Prepare Readline for compilation:</para>
43
44<screen os="d"><userinput>./configure --prefix=/usr --libdir=/lib</userinput></screen>
45
46    <para os="e">Compile the package:</para>
47
48<screen os="f"><userinput>make SHLIB_XLDFLAGS=-lncurses</userinput></screen>
49
50    <variablelist os="g">
51      <title>The meaning of the make option:</title>
52
53      <varlistentry>
54        <term><parameter>SHLIB_XLDFLAGS=-lncurses</parameter></term>
55        <listitem>
56          <para>This option forces Readline to link against the
57          <filename class="libraryfile">libncurses</filename> library.</para>
58        </listitem>
59      </varlistentry>
60    </variablelist>
61
62    <para os="h">This package does not come with a test suite.</para>
63
64    <para os="i">Install the package:</para>
65
66<screen os="j"><userinput>make install</userinput></screen>
67
68    <para os="k">Give Readline's dynamic libraries more appropriate
69    permissions:</para>
70
71<screen os="l"><userinput>chmod -v 755 /lib/lib{readline,history}.so*</userinput></screen>
72
73    <para os="m">Now move the static libraries to a more appropriate location:</para>
74
75<screen os="n"><userinput>mv -v /lib/lib{readline,history}.a /usr/lib</userinput></screen>
76
77    <para os="o">Next, remove the <filename class="extension">.so</filename>
78    files in <filename class="directory">/lib</filename> and relink them into
79    <filename class="directory">/usr/lib</filename>.</para>
80
81<screen os="p"><userinput>rm -v /lib/lib{readline,history}.so
82ln -svf ../../lib/libreadline.so.5 /usr/lib/libreadline.so
83ln -svf ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>
84
85  </sect2>
86
87  <sect2 id="contents-readline" role="content">
88    <title>Contents of Readline</title>
89
90    <segmentedlist>
91      <segtitle>Installed libraries</segtitle>
92
93      <seglistitem>
94        <seg>libhistory.[a,so], and libreadline.[a,so]</seg>
95      </seglistitem>
96    </segmentedlist>
97
98    <variablelist>
99      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
100      <?dbfo list-presentation="list"?>
101      <?dbhtml list-presentation="table"?>
102
103      <varlistentry id="libhistory">
104        <term><filename class="libraryfile">libhistory</filename></term>
105        <listitem>
106          <para>Provides a consistent user interface
107          for recalling lines of history</para>
108          <indexterm zone="ch-system-readline libhistory">
109            <primary sortas="c-libhistory">libhistory</primary>
110          </indexterm>
111        </listitem>
112      </varlistentry>
113
114      <varlistentry id="libreadline">
115        <term><filename class="libraryfile">libreadline</filename></term>
116        <listitem>
117          <para>Aids in the consistency of user interface
118          across discrete programs that need to provide a command line
119          interface</para>
120          <indexterm zone="ch-system-readline libreadline">
121            <primary sortas="c-libreadline">libreadline</primary>
122          </indexterm>
123        </listitem>
124      </varlistentry>
125
126    </variablelist>
127
128  </sect2>
129
130</sect1>
Note: See TracBrowser for help on using the repository browser.