readline.xml 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  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 contains the Readline command-line library.</para>
  12. <segmentedlist>
  13. <segtitle>&buildtime;</segtitle>
  14. <segtitle>&diskspace;</segtitle>
  15. <seglistitem><seg>0.11 SBU</seg><seg>3.8 MB</seg></seglistitem>
  16. </segmentedlist>
  17. <segmentedlist>
  18. <segtitle>Readline installation depends on</segtitle>
  19. <seglistitem><seg>Binutils, Coreutils, Diffutils, Gawk,
  20. GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
  21. </segmentedlist>
  22. </sect2>
  23. <sect2 role="installation">
  24. <title>Installation of Readline</title>
  25. <para>The following patch includes a fix for the problem where
  26. Readline sometimes only shows 33 characters on a line and then wraps
  27. to the next line. It also includes other fixes recommended by the
  28. Readline author.</para>
  29. <screen><userinput>patch -Np1 -i ../readline-&readline-version;-fixes-1.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 755 /lib/lib{readline,history}.so*</userinput></screen>
  46. <para>Now we move the static libraries to a more appropriate
  47. location:</para>
  48. <screen><userinput>mv /lib/lib{readline,history}.a /usr/lib</userinput></screen>
  49. <para>Next we will remove the old, <filename class="extension">.so</filename> files in
  50. <filename class="directory">/lib</filename> and relink them into
  51. <filename class="directory">/usr/lib</filename>.</para>
  52. <screen><userinput>rm /lib/lib{readline,history}.so
  53. ln -sf ../../lib/libreadline.so.5 /usr/lib/libreadline.so
  54. ln -sf ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>
  55. </sect2>
  56. <sect2 id="contents-readline" role="content"><title>Contents of Readline</title>
  57. <segmentedlist>
  58. <segtitle>Installed libraries</segtitle>
  59. <seglistitem><seg>libhistory.[a,so], and libreadline.[a,so]</seg></seglistitem>
  60. </segmentedlist>
  61. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  62. <?dbfo list-presentation="list"?>
  63. <?dbhtml list-presentation="table"?>
  64. <varlistentry id="libhistory">
  65. <term><filename class="libraryfile">libhistory</filename></term>
  66. <listitem>
  67. <para>Provides a consistent user interface
  68. for recalling lines of history</para>
  69. <indexterm zone="ch-system-readline libhistory"><primary sortas="c-libhistory">libhistory</primary></indexterm>
  70. </listitem>
  71. </varlistentry>
  72. <varlistentry id="libreadline">
  73. <term><filename class="libraryfile">libreadline</filename></term>
  74. <listitem>
  75. <para>Aids in the consistency of user interface
  76. across discrete programs that need to provide a command line
  77. interface</para>
  78. <indexterm zone="ch-system-readline libreadline"><primary sortas="c-libreadline">libreadline</primary></indexterm>
  79. </listitem>
  80. </varlistentry>
  81. </variablelist>
  82. </sect2>
  83. </sect1>