readline.xml 4.3 KB

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