glfs/general/genlib/readline.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY readline-download-http "http://ftp.gnu.org/gnu/readline/readline-&readline-version;.tar.gz">
<!ENTITY readline-download-ftp "ftp://ftp.gnu.org/gnu/readline/readline-&readline-version;.tar.gz">
<!ENTITY readline-size "944 KB">
<!ENTITY readline-buildsize "9.2 MB">
<!ENTITY readline-time "0.10 SBU">

]>

<sect1 id="readline" xreflabel="readline-&readline-version;">
<?dbhtml filename="readline.html"?>
<title>readline-&readline-version;</title>

<sect2>
<title>Introduction to <application>readline</application></title>
                                                                              
<para>The <application>readline</application> library provides a set of
functions for use by applications that allow users to edit command-lines as
they are typed in.  Both <application>Emacs</application> and
<application>vi</application> editing modes are available.</para>
                                                                              
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&readline-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&readline-download-ftp;"/></para></listitem>
<listitem><para>Download size: &readline-size;</para></listitem>
<listitem><para>Estimated Disk space required:
&readline-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&readline-time;</para></listitem></itemizedlist>
</sect3>
                                                                              
                                                                              
</sect2>

<sect2>
<title>Installation of <application>readline</application></title>
                                                                              
<para>Install <application>readline</application> by running the following
commands:</para>
                                                                              
<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make SHLIB_LIBS=-lcurses &amp;&amp;
make install</command></userinput></screen>
                                                                              
</sect2>

<sect2>
<title>Command explanations</title>
                                                                              
<para><command>make SHLIB_LIBS=-lcurses</command>: This command makes the
proper symbols available for applications that assume
<application>readline</application> is compiled with
<application>ncurses</application> links.</para>
                                                                              
</sect2>

<sect2>
<title>Configuring <application>readline</application></title>
                                                                              
<sect3><title>Configuration Information</title>
                                                                              
<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../../lib-config.xml"/>       
                                                                              
</sect3>
                                                                              
</sect2>

<sect2>
<title>Contents</title>
                                                                              
<para>The <application>readline</application> package contains the <filename>
libreadline</filename> libraries and <filename>libhistory</filename> libraries.
</para>
                                                                              
</sect2>

</sect1>