readline.xml 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-readline" role="wrap">
  7. <title>Readline-&readline-version;</title>
  8. <?dbhtml filename="readline.html"?>
  9. <indexterm zone="ch-system-readline"><primary sortas="a-Readline">Readline</primary></indexterm>
  10. <sect2 role="package"><title/>
  11. <para>The Readline package is a set of libraries that offers command-line
  12. editing and history capabilities.</para>
  13. <segmentedlist>
  14. <segtitle>&buildtime;</segtitle>
  15. <segtitle>&diskspace;</segtitle>
  16. <seglistitem><seg>0.11 SBU</seg><seg>9.1 MB</seg></seglistitem>
  17. </segmentedlist>
  18. <segmentedlist>
  19. <segtitle>&dependencies;</segtitle>
  20. <seglistitem><seg>Binutils, Coreutils, Diffutils, Gawk,
  21. GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
  22. </segmentedlist>
  23. </sect2>
  24. <sect2 role="installation">
  25. <title>Installation of Readline</title>
  26. <para>The following patch includes a fix for a problem where Readline sometimes
  27. only shows 33 characters on a line and then wraps to the next line. It also
  28. includes other fixes recommended by the Readline author.</para>
  29. <screen><userinput>patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
  30. <para>Prepare Readline for compilation:</para>
  31. <screen><userinput>./configure --prefix=/usr --libdir=/lib</userinput></screen>
  32. <para>Compile the package:</para>
  33. <screen><userinput>make SHLIB_XLDFLAGS=-lncurses</userinput></screen>
  34. <para>The meaning of the make option:</para>
  35. <variablelist>
  36. <varlistentry>
  37. <term><parameter>SHLIB_XLDFLAGS=-lncurses</parameter></term>
  38. <listitem><para>This option forces Readline to link against the
  39. <filename class="libraryfile">libncurses</filename> library.</para></listitem>
  40. </varlistentry>
  41. </variablelist>
  42. <para>Install the package:</para>
  43. <screen><userinput>make install</userinput></screen>
  44. <para>Give Readline's dynamic libraries more appropriate permissions:</para>
  45. <screen><userinput>chmod -v 755 /lib/lib{readline,history}.so*</userinput></screen>
  46. <para>Now move the static libraries to a more appropriate location:</para>
  47. <screen><userinput>mv -v /lib/lib{readline,history}.a /usr/lib</userinput></screen>
  48. <para>Next, remove the <filename class="extension">.so</filename> files in
  49. <filename class="directory">/lib</filename> and relink them into <filename
  50. class="directory">/usr/lib</filename>.</para>
  51. <screen><userinput>rm -v /lib/lib{readline,history}.so
  52. ln -sfv ../../lib/libreadline.so.5 /usr/lib/libreadline.so
  53. ln -sfv ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>
  54. </sect2>
  55. <sect2 id="contents-readline" role="content"><title>Contents of Readline</title>
  56. <segmentedlist>
  57. <segtitle>Installed libraries</segtitle>
  58. <seglistitem><seg>libhistory.[a,so], and libreadline.[a,so]</seg></seglistitem>
  59. </segmentedlist>
  60. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  61. <?dbfo list-presentation="list"?>
  62. <?dbhtml list-presentation="table"?>
  63. <varlistentry id="libhistory">
  64. <term><filename class="libraryfile">libhistory</filename></term>
  65. <listitem>
  66. <para>Provides a consistent user interface
  67. for recalling lines of history</para>
  68. <indexterm zone="ch-system-readline libhistory"><primary sortas="c-libhistory">libhistory</primary></indexterm>
  69. </listitem>
  70. </varlistentry>
  71. <varlistentry id="libreadline">
  72. <term><filename class="libraryfile">libreadline</filename></term>
  73. <listitem>
  74. <para>Aids in the consistency of user interface
  75. across discrete programs that need to provide a command line
  76. interface</para>
  77. <indexterm zone="ch-system-readline libreadline"><primary sortas="c-libreadline">libreadline</primary></indexterm>
  78. </listitem>
  79. </varlistentry>
  80. </variablelist>
  81. </sect2>
  82. </sect1>