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