readline.xml 3.8 KB

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