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>First install some patches to fix various bugs that have been
|
---|
45 | addressed upstream:</para>
|
---|
46 |
|
---|
47 | <screen><userinput remap="pre">patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
|
---|
48 |
|
---|
49 | <para>Reinstalling Readline will cause the old libraries to be moved to
|
---|
50 | <libraryname>.old. While this is normally not a problem, in some cases
|
---|
51 | it can trigger a linking bug in <command>ldconfig</command>. This can be
|
---|
52 | avoided by issuing the following two seds:</para>
|
---|
53 |
|
---|
54 | <screen><userinput remap="pre">sed -i '/MV.*old/d' Makefile.in
|
---|
55 | sed -i '/{OLDSUFF}/c:' support/shlib-install</userinput></screen>
|
---|
56 |
|
---|
57 | <para>Prepare Readline for compilation:</para>
|
---|
58 |
|
---|
59 | <screen><userinput remap="configure">./configure --prefix=/usr --docdir=/usr/share/doc/readline-&readline-version;</userinput></screen>
|
---|
60 |
|
---|
61 | <para>Compile the package:</para>
|
---|
62 |
|
---|
63 | <screen><userinput remap="make">make SHLIB_LIBS=-lncurses</userinput></screen>
|
---|
64 |
|
---|
65 | <variablelist>
|
---|
66 | <title>The meaning of the make option:</title>
|
---|
67 |
|
---|
68 | <varlistentry>
|
---|
69 | <term><parameter>SHLIB_LIBS=-lncurses</parameter></term>
|
---|
70 | <listitem>
|
---|
71 | <para>This option forces Readline to link against the
|
---|
72 | <filename class="libraryfile">libncurses</filename> (really,
|
---|
73 | <filename class="libraryfile">libncursesw</filename>) library.</para>
|
---|
74 | </listitem>
|
---|
75 | </varlistentry>
|
---|
76 |
|
---|
77 | </variablelist>
|
---|
78 |
|
---|
79 | <para>This package does not come with a test suite.</para>
|
---|
80 |
|
---|
81 | <para>Install the package:</para>
|
---|
82 |
|
---|
83 | <screen><userinput remap="install">make SHLIB_LIBS=-lncurses install</userinput></screen>
|
---|
84 |
|
---|
85 | <para>Now move the dynamic libraries to a more appropriate location
|
---|
86 | and fix up some symbolic links:</para>
|
---|
87 |
|
---|
88 | <screen><userinput remap="install">mv -v /usr/lib/lib{readline,history}.so.* /lib
|
---|
89 | ln -sfv ../../lib/$(readlink /usr/lib/libreadline.so) /usr/lib/libreadline.so
|
---|
90 | ln -sfv ../../lib/$(readlink /usr/lib/libhistory.so ) /usr/lib/libhistory.so</userinput></screen>
|
---|
91 |
|
---|
92 | <para>If desired, install the documentation:</para>
|
---|
93 |
|
---|
94 | <screen><userinput remap="install">install -v -m644 doc/*.{ps,pdf,html,dvi} /usr/share/doc/readline-&readline-version;</userinput></screen>
|
---|
95 |
|
---|
96 | </sect2>
|
---|
97 |
|
---|
98 | <sect2 id="contents-readline" role="content">
|
---|
99 | <title>Contents of Readline</title>
|
---|
100 |
|
---|
101 | <segmentedlist>
|
---|
102 | <segtitle>Installed libraries</segtitle>
|
---|
103 | <segtitle>Installed directories</segtitle>
|
---|
104 |
|
---|
105 | <seglistitem>
|
---|
106 | <seg>libhistory.{a,so}, and libreadline.{a,so}</seg>
|
---|
107 | <seg>/usr/include/readline, /usr/share/readline,
|
---|
108 | /usr/share/doc/readline-&readline-version;</seg>
|
---|
109 | </seglistitem>
|
---|
110 | </segmentedlist>
|
---|
111 |
|
---|
112 | <variablelist>
|
---|
113 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
114 | <?dbfo list-presentation="list"?>
|
---|
115 | <?dbhtml list-presentation="table"?>
|
---|
116 |
|
---|
117 | <varlistentry id="libhistory">
|
---|
118 | <term><filename class="libraryfile">libhistory</filename></term>
|
---|
119 | <listitem>
|
---|
120 | <para>Provides a consistent user interface for recalling lines
|
---|
121 | of history</para>
|
---|
122 | <indexterm zone="ch-system-readline libhistory">
|
---|
123 | <primary sortas="c-libhistory">libhistory</primary>
|
---|
124 | </indexterm>
|
---|
125 | </listitem>
|
---|
126 | </varlistentry>
|
---|
127 |
|
---|
128 | <varlistentry id="libreadline">
|
---|
129 | <term><filename class="libraryfile">libreadline</filename></term>
|
---|
130 | <listitem>
|
---|
131 | <para>Aids in the consistency of user interface across discrete
|
---|
132 | programs that need to provide a command line interface</para>
|
---|
133 | <indexterm zone="ch-system-readline libreadline">
|
---|
134 | <primary sortas="c-libreadline">libreadline</primary>
|
---|
135 | </indexterm>
|
---|
136 | </listitem>
|
---|
137 | </varlistentry>
|
---|
138 |
|
---|
139 | </variablelist>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | </sect1>
|
---|