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 | <sect1info condition="script">
|
---|
12 | <productname>readline</productname>
|
---|
13 | <productnumber>&readline-version;</productnumber>
|
---|
14 | <address>&readline-url;</address>
|
---|
15 | </sect1info>
|
---|
16 |
|
---|
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/>
|
---|
25 |
|
---|
26 | <para>The Readline package is a set of libraries that offers command-line
|
---|
27 | editing and history capabilities.</para>
|
---|
28 |
|
---|
29 | <segmentedlist>
|
---|
30 | <segtitle>&buildtime;</segtitle>
|
---|
31 | <segtitle>&diskspace;</segtitle>
|
---|
32 |
|
---|
33 | <seglistitem>
|
---|
34 | <seg>&readline-ch6-sbu;</seg>
|
---|
35 | <seg>&readline-ch6-du;</seg>
|
---|
36 | </seglistitem>
|
---|
37 | </segmentedlist>
|
---|
38 |
|
---|
39 | </sect2>
|
---|
40 |
|
---|
41 | <sect2 role="installation">
|
---|
42 | <title>Installation of Readline</title>
|
---|
43 |
|
---|
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 |
|
---|
49 | <screen><userinput remap="pre">sed -i '/MV.*old/d' Makefile.in
|
---|
50 | sed -i '/{OLDSUFF}/c:' support/shlib-install</userinput></screen>
|
---|
51 |
|
---|
52 | <para>Apply a patch to fix a known bug that has been fixed upstream:</para>
|
---|
53 |
|
---|
54 | <screen><userinput remap="pre">patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
|
---|
55 |
|
---|
56 | <para>Prepare Readline for compilation:</para>
|
---|
57 |
|
---|
58 | <screen><userinput remap="configure">./configure --prefix=/usr --libdir=/lib</userinput></screen>
|
---|
59 |
|
---|
60 | <para>Compile the package:</para>
|
---|
61 |
|
---|
62 | <screen><userinput remap="make">make SHLIB_LIBS=-lncurses</userinput></screen>
|
---|
63 |
|
---|
64 | <variablelist>
|
---|
65 | <title>The meaning of the make option:</title>
|
---|
66 |
|
---|
67 | <varlistentry>
|
---|
68 | <term><parameter>SHLIB_LIBS=-lncurses</parameter></term>
|
---|
69 | <listitem>
|
---|
70 | <para>This option forces Readline to link against the
|
---|
71 | <filename class="libraryfile">libncurses</filename> (really,
|
---|
72 | <filename class="libraryfile">libncursesw</filename>) library.</para>
|
---|
73 | </listitem>
|
---|
74 | </varlistentry>
|
---|
75 |
|
---|
76 | </variablelist>
|
---|
77 |
|
---|
78 | <para>This package does not come with a test suite.</para>
|
---|
79 |
|
---|
80 | <para>Install the package:</para>
|
---|
81 |
|
---|
82 | <screen><userinput remap="install">make install</userinput></screen>
|
---|
83 |
|
---|
84 | <para>Now move the static libraries to a more appropriate location:</para>
|
---|
85 |
|
---|
86 | <screen><userinput remap="install">mv -v /lib/lib{readline,history}.a /usr/lib</userinput></screen>
|
---|
87 |
|
---|
88 | <para>Next, remove the <filename class="extension">.so</filename> files in
|
---|
89 | <filename class="directory">/lib</filename> and relink them into <filename
|
---|
90 | class="directory">/usr/lib</filename>:</para>
|
---|
91 |
|
---|
92 | <screen><userinput remap="install">rm -v /lib/lib{readline,history}.so
|
---|
93 | ln -sfv ../../lib/libreadline.so.6 /usr/lib/libreadline.so
|
---|
94 | ln -sfv ../../lib/libhistory.so.6 /usr/lib/libhistory.so</userinput></screen>
|
---|
95 |
|
---|
96 | <para>If desired, install the documentation:</para>
|
---|
97 |
|
---|
98 | <screen><userinput remap="install">mkdir -v /usr/share/doc/readline-&readline-version;
|
---|
99 | install -v -m644 doc/*.{ps,pdf,html,dvi} \
|
---|
100 | /usr/share/doc/readline-&readline-version;</userinput></screen>
|
---|
101 |
|
---|
102 | </sect2>
|
---|
103 |
|
---|
104 | <sect2 id="contents-readline" role="content">
|
---|
105 | <title>Contents of Readline</title>
|
---|
106 |
|
---|
107 | <segmentedlist>
|
---|
108 | <segtitle>Installed libraries</segtitle>
|
---|
109 | <segtitle>Installed directories</segtitle>
|
---|
110 |
|
---|
111 | <seglistitem>
|
---|
112 | <seg>libhistory.{a,so}, and libreadline.{a,so}</seg>
|
---|
113 | <seg>/usr/include/readline, /usr/share/readline,
|
---|
114 | /usr/share/doc/readline-&readline-version;</seg>
|
---|
115 | </seglistitem>
|
---|
116 | </segmentedlist>
|
---|
117 |
|
---|
118 | <variablelist>
|
---|
119 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
120 | <?dbfo list-presentation="list"?>
|
---|
121 | <?dbhtml list-presentation="table"?>
|
---|
122 |
|
---|
123 | <varlistentry id="libhistory">
|
---|
124 | <term><filename class="libraryfile">libhistory</filename></term>
|
---|
125 | <listitem>
|
---|
126 | <para>Provides a consistent user interface for recalling lines
|
---|
127 | of history</para>
|
---|
128 | <indexterm zone="ch-system-readline libhistory">
|
---|
129 | <primary sortas="c-libhistory">libhistory</primary>
|
---|
130 | </indexterm>
|
---|
131 | </listitem>
|
---|
132 | </varlistentry>
|
---|
133 |
|
---|
134 | <varlistentry id="libreadline">
|
---|
135 | <term><filename class="libraryfile">libreadline</filename></term>
|
---|
136 | <listitem>
|
---|
137 | <para>Aids in the consistency of user interface across discrete
|
---|
138 | programs that need to provide a command line interface</para>
|
---|
139 | <indexterm zone="ch-system-readline libreadline">
|
---|
140 | <primary sortas="c-libreadline">libreadline</primary>
|
---|
141 | </indexterm>
|
---|
142 | </listitem>
|
---|
143 | </varlistentry>
|
---|
144 |
|
---|
145 | </variablelist>
|
---|
146 |
|
---|
147 | </sect2>
|
---|
148 |
|
---|
149 | </sect1>
|
---|