texinfo.xml 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  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-texinfo" role="wrap">
  8. <?dbhtml filename="texinfo.html"?>
  9. <sect1info condition="script">
  10. <productname>texinfo</productname>
  11. <productnumber>&texinfo-version;</productnumber>
  12. <address>&texinfo-url;</address>
  13. </sect1info>
  14. <title>Texinfo-&texinfo-version;</title>
  15. <indexterm zone="ch-system-texinfo">
  16. <primary sortas="a-Texinfo">Texinfo</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Texinfo package contains programs for reading, writing, and
  21. converting info pages.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&texinfo-fin-sbu;</seg>
  27. <seg>&texinfo-fin-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Texinfo</title>
  33. <para>Prepare Texinfo for compilation:</para>
  34. <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
  35. <!--
  36. <variablelist>
  37. <title>The meaning of the configure option:</title>
  38. <varlistentry>
  39. <term><parameter>- -disable-static</parameter></term>
  40. <listitem>
  41. <para>In this case, the top-level configure script will complain that
  42. this is an unrecognized option, but the configure script for
  43. XSParagraph recognizes it and uses it to disable installing a static
  44. <filename class="libraryfile">XSParagraph.a</filename> to <filename
  45. class="directory">/usr/lib/texinfo</filename>.</para>
  46. </listitem>
  47. </varlistentry>
  48. </variablelist>
  49. -->
  50. <para>Compile the package:</para>
  51. <screen><userinput remap="make">make</userinput></screen>
  52. <para>To test the results, issue:</para>
  53. <screen><userinput remap="test">make check</userinput></screen>
  54. <para>Install the package:</para>
  55. <screen><userinput remap="install">make install</userinput></screen>
  56. <para>Optionally, install the components belonging in a TeX
  57. installation:</para>
  58. <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->
  59. <screen><userinput remap="install">make TEXMF=/usr/share/texmf install-tex</userinput></screen>
  60. <variablelist>
  61. <title>The meaning of the make parameter:</title>
  62. <varlistentry>
  63. <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
  64. <listitem>
  65. <para>The <envar>TEXMF</envar> makefile variable holds the location
  66. of the root of the TeX tree if, for example, a TeX package will be
  67. installed later.</para>
  68. </listitem>
  69. </varlistentry>
  70. </variablelist>
  71. <para>The Info documentation system uses a plain text file to hold its list of
  72. menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
  73. Unfortunately, due to occasional problems in the Makefiles of various packages,
  74. it can sometimes get out of sync with the info pages installed on the system.
  75. If the <filename>/usr/share/info/dir</filename> file ever needs to be
  76. recreated, the following optional commands will accomplish the task:</para>
  77. <screen role="nodump"><userinput>pushd /usr/share/info
  78. rm -v dir
  79. for f in *
  80. do install-info $f dir 2&gt;/dev/null
  81. done
  82. popd</userinput></screen>
  83. </sect2>
  84. <sect2 id="contents-texinfo" role="content">
  85. <title>Contents of Texinfo</title>
  86. <segmentedlist>
  87. <segtitle>Installed programs</segtitle>
  88. <segtitle>Installed library</segtitle>
  89. <segtitle>Installed directories</segtitle>
  90. <seglistitem>
  91. <seg>info, install-info, makeinfo (link to texi2any),
  92. pdftexi2dvi, pod2texi, texi2any, texi2dvi, texi2pdf, and texindex</seg>
  93. <seg>MiscXS.so, Parsetexi.so, and XSParagraph.so
  94. (all in /usr/lib/texinfo)</seg>
  95. <seg>/usr/share/texinfo and /usr/lib/texinfo</seg>
  96. </seglistitem>
  97. </segmentedlist>
  98. <variablelist>
  99. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  100. <?dbfo list-presentation="list"?>
  101. <?dbhtml list-presentation="table"?>
  102. <varlistentry id="info">
  103. <term><command>info</command></term>
  104. <listitem>
  105. <para>Used to read info pages which are similar to man pages, but
  106. often go much deeper than just explaining all the available command
  107. line options [For example, compare <command>man bison</command> and
  108. <command>info bison</command>.]</para>
  109. <indexterm zone="ch-system-texinfo info">
  110. <primary sortas="b-info">info</primary>
  111. </indexterm>
  112. </listitem>
  113. </varlistentry>
  114. <varlistentry id="install-info">
  115. <term><command>install-info</command></term>
  116. <listitem>
  117. <para>Used to install info pages; it updates entries in the
  118. <command>info</command> index file</para>
  119. <indexterm zone="ch-system-texinfo install-info">
  120. <primary sortas="b-install-info">install-info</primary>
  121. </indexterm>
  122. </listitem>
  123. </varlistentry>
  124. <varlistentry id="makeinfo">
  125. <term><command>makeinfo</command></term>
  126. <listitem>
  127. <para>Translates the given Texinfo source documents into
  128. info pages, plain text, or HTML</para>
  129. <indexterm zone="ch-system-texinfo makeinfo">
  130. <primary sortas="b-makeinfo">makeinfo</primary>
  131. </indexterm>
  132. </listitem>
  133. </varlistentry>
  134. <varlistentry id="pdftexi2dvi">
  135. <term><command>pdftexi2dvi</command></term>
  136. <listitem>
  137. <para>Used to format the given Texinfo document into a
  138. Portable Document Format (PDF) file</para>
  139. <indexterm zone="ch-system-texinfo pdftexi2dvi">
  140. <primary sortas="b-pdftexi2dvi">pdftexi2dvi</primary>
  141. </indexterm>
  142. </listitem>
  143. </varlistentry>
  144. <varlistentry id="pod2texi">
  145. <term><command>pod2texi</command></term>
  146. <listitem>
  147. <para>Converts Pod to Texinfo format</para>
  148. <indexterm zone="ch-system-texinfo pod2texi">
  149. <primary sortas="b-pod2texi">pod2texi</primary>
  150. </indexterm>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry id="texi2any">
  154. <term><command>texi2any</command></term>
  155. <listitem>
  156. <para>Translate Texinfo source documentation to
  157. various other formats</para>
  158. <indexterm zone="ch-system-texinfo texi2any">
  159. <primary sortas="b-texiany">texi2any</primary>
  160. </indexterm>
  161. </listitem>
  162. </varlistentry>
  163. <varlistentry id="texi2dvi">
  164. <term><command>texi2dvi</command></term>
  165. <listitem>
  166. <para>Used to format the given Texinfo document into a
  167. device-independent file that can be printed</para>
  168. <indexterm zone="ch-system-texinfo texi2dvi">
  169. <primary sortas="b-texi2dvi">texi2dvi</primary>
  170. </indexterm>
  171. </listitem>
  172. </varlistentry>
  173. <varlistentry id="texi2pdf">
  174. <term><command>texi2pdf</command></term>
  175. <listitem>
  176. <para>Used to format the given Texinfo document into a
  177. Portable Document Format (PDF) file</para>
  178. <indexterm zone="ch-system-texinfo texi2pdf">
  179. <primary sortas="b-texi2pdf">texi2pdf</primary>
  180. </indexterm>
  181. </listitem>
  182. </varlistentry>
  183. <varlistentry id="texindex">
  184. <term><command>texindex</command></term>
  185. <listitem>
  186. <para>Used to sort Texinfo index files</para>
  187. <indexterm zone="ch-system-texinfo texindex">
  188. <primary sortas="b-texindex">texindex</primary>
  189. </indexterm>
  190. </listitem>
  191. </varlistentry>
  192. </variablelist>
  193. </sect2>
  194. </sect1>