source: BOOK/final-system/common/readline.xml @ d4469fc

clfs-3.0.0-systemdsystemd
Last change on this file since d4469fc was f698055a, checked in by Chris Staub <chris@…>, 10 years ago

Improve consistency in package installation lists, mainly removing 'and'

  • Property mode set to 100644
File size: 3.7 KB
Line 
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="a">Prepare Readline for compilation:</para>
34
35<screen os="b"><userinput>./configure --prefix=/usr --libdir=/lib \
36    --docdir=/usr/share/doc/readline-&readline-version;</userinput></screen>
37
38    <para os="c">Compile the package:</para>
39
40<screen os="d"><userinput>make SHLIB_LIBS=-lncurses</userinput></screen>
41
42    <para os="e">This package does not come with a test suite.</para>
43
44    <para os="f">Install the package:</para>
45
46<screen os="g"><userinput>make SHLIB_LIBS=-lncurses htmldir=/usr/share/doc/readline-&readline-version; install</userinput></screen>
47
48    <para os="h">Now move the static libraries to a more appropriate location:</para>
49
50<screen os="i"><userinput>mv -v /lib/lib{readline,history}.a /usr/lib</userinput></screen>
51
52    <para os="j">Next, relink the dynamic libraries into <filename class="directory">/usr/lib</filename> and remove the <filename class="extension">.so</filename> files in <filename class="directory">/lib</filename>.</para>
53
54<screen os="k"><userinput>ln -svf ../../lib/$(readlink /lib/libreadline.so) /usr/lib/libreadline.so
55ln -svf ../../lib/$(readlink /lib/libhistory.so) /usr/lib/libhistory.so
56rm -v /lib/lib{readline,history}.so</userinput></screen>
57
58  </sect2>
59
60  <sect2 id="contents-readline" role="content">
61    <title>Contents of Readline</title>
62
63    <segmentedlist>
64      <segtitle>Installed libraries</segtitle>
65      <segtitle>Installed directories</segtitle>
66
67      <seglistitem>
68        <seg>libhistory.[a,so], libreadline.[a,so]</seg>
69        <seg>/usr/include/readline, /usr/share/doc/readline-&readline-version;, /usr/share/readline</seg>
70      </seglistitem>
71    </segmentedlist>
72
73    <variablelist>
74      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
75      <?dbfo list-presentation="list"?>
76      <?dbhtml list-presentation="table"?>
77
78      <varlistentry id="libhistory">
79        <term><filename class="libraryfile">libhistory</filename></term>
80        <listitem>
81          <para>Provides a consistent user interface
82          for recalling lines of history</para>
83          <indexterm zone="ch-system-readline libhistory">
84            <primary sortas="c-libhistory">libhistory</primary>
85          </indexterm>
86        </listitem>
87      </varlistentry>
88
89      <varlistentry id="libreadline">
90        <term><filename class="libraryfile">libreadline</filename></term>
91        <listitem>
92          <para>Aids in the consistency of user interface
93          across discrete programs that need to provide a command line
94          interface</para>
95          <indexterm zone="ch-system-readline libreadline">
96            <primary sortas="c-libreadline">libreadline</primary>
97          </indexterm>
98        </listitem>
99      </varlistentry>
100
101    </variablelist>
102
103  </sect2>
104
105</sect1>
Note: See TracBrowser for help on using the repository browser.