texinfo.xml 7.5 KB

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