readline.xml 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.5/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. <sect1info condition="script">
  10. <productname>readline</productname>
  11. <productnumber>&readline-version;</productnumber>
  12. <address>&readline-url;</address>
  13. </sect1info>
  14. <title>Readline-&readline-version;</title>
  15. <indexterm zone="ch-system-readline">
  16. <primary sortas="a-Readline">Readline</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Readline package is a set of libraries that offers command-line
  21. editing and history capabilities.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&readline-ch6-sbu;</seg>
  27. <seg>&readline-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Readline</title>
  33. <para>First install some patches to fix various bugs that have been
  34. addressed upstream:</para>
  35. <screen><userinput remap="pre">patch -Np1 -i ../&readline-fixes-patch;</userinput></screen>
  36. <para>Reinstalling Readline will cause the old libraries to be moved to
  37. &lt;libraryname&gt;.old. While this is normally not a problem, in some cases
  38. it can trigger a linking bug in <command>ldconfig</command>. This can be
  39. avoided by issuing the following two seds:</para>
  40. <screen><userinput remap="pre">sed -i '/MV.*old/d' Makefile.in
  41. sed -i '/{OLDSUFF}/c:' support/shlib-install</userinput></screen>
  42. <para>Prepare Readline for compilation:</para>
  43. <screen><userinput remap="configure">./configure --prefix=/usr \
  44. --disable-static \
  45. --docdir=/usr/share/doc/readline-&readline-version;</userinput></screen>
  46. <para>Compile the package:</para>
  47. <screen><userinput remap="make">make SHLIB_LIBS=-lncurses</userinput></screen>
  48. <variablelist>
  49. <title>The meaning of the make option:</title>
  50. <varlistentry>
  51. <term><parameter>SHLIB_LIBS=-lncurses</parameter></term>
  52. <listitem>
  53. <para>This option forces Readline to link against the
  54. <filename class="libraryfile">libncurses</filename> (really,
  55. <filename class="libraryfile">libncursesw</filename>) library.</para>
  56. </listitem>
  57. </varlistentry>
  58. </variablelist>
  59. <para>This package does not come with a test suite.</para>
  60. <para>Install the package:</para>
  61. <screen><userinput remap="install">make SHLIB_LIBS=-lncurses install</userinput></screen>
  62. <para>Now move the dynamic libraries to a more appropriate location
  63. and fix up some symbolic links:</para>
  64. <screen><userinput remap="install">mv -v /usr/lib/lib{readline,history}.so.* /lib
  65. ln -sfv ../../lib/$(readlink /usr/lib/libreadline.so) /usr/lib/libreadline.so
  66. ln -sfv ../../lib/$(readlink /usr/lib/libhistory.so ) /usr/lib/libhistory.so</userinput></screen>
  67. <para>If desired, install the documentation:</para>
  68. <screen><userinput remap="install">install -v -m644 doc/*.{ps,pdf,html,dvi} /usr/share/doc/readline-&readline-version;</userinput></screen>
  69. </sect2>
  70. <sect2 id="contents-readline" role="content">
  71. <title>Contents of Readline</title>
  72. <segmentedlist>
  73. <segtitle>Installed libraries</segtitle>
  74. <segtitle>Installed directories</segtitle>
  75. <seglistitem>
  76. <seg>libhistory.{a,so} and libreadline.{a,so}</seg>
  77. <seg>/usr/include/readline, /usr/share/readline, and
  78. /usr/share/doc/readline-&readline-version;</seg>
  79. </seglistitem>
  80. </segmentedlist>
  81. <variablelist>
  82. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  83. <?dbfo list-presentation="list"?>
  84. <?dbhtml list-presentation="table"?>
  85. <varlistentry id="libhistory">
  86. <term><filename class="libraryfile">libhistory</filename></term>
  87. <listitem>
  88. <para>Provides a consistent user interface for recalling lines
  89. of history</para>
  90. <indexterm zone="ch-system-readline libhistory">
  91. <primary sortas="c-libhistory">libhistory</primary>
  92. </indexterm>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry id="libreadline">
  96. <term><filename class="libraryfile">libreadline</filename></term>
  97. <listitem>
  98. <para>Aids in the consistency of user interface across discrete
  99. programs that need to provide a command line interface</para>
  100. <indexterm zone="ch-system-readline libreadline">
  101. <primary sortas="c-libreadline">libreadline</primary>
  102. </indexterm>
  103. </listitem>
  104. </varlistentry>
  105. </variablelist>
  106. </sect2>
  107. </sect1>