1
0

texinfo.xml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  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-texinfo" role="wrap">
  7. <title>Texinfo-&texinfo-version;</title>
  8. <?dbhtml filename="texinfo.html"?>
  9. <indexterm zone="ch-system-texinfo"><primary sortas="a-Texinfo">Texinfo</primary></indexterm>
  10. <sect2 role="package"><title/>
  11. <para>The Texinfo package contains programs for reading, writing, and
  12. converting info pages.</para>
  13. <segmentedlist>
  14. <segtitle>&buildtime;</segtitle>
  15. <segtitle>&diskspace;</segtitle>
  16. <seglistitem><seg>0.2 SBU</seg><seg>14.7 MB</seg></seglistitem>
  17. </segmentedlist>
  18. <segmentedlist>
  19. <segtitle>&dependencies;</segtitle>
  20. <seglistitem><seg>Bash, Binutils, Coreutils,
  21. Diffutils, GCC, Gettext, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
  22. </segmentedlist>
  23. </sect2>
  24. <sect2 role="installation">
  25. <title>Installation of Texinfo</title>
  26. <para>The <command>info</command> program makes assumptions such as that
  27. a string occupies the same number of character cells on the screen and bytes
  28. in memory and that one can break the string anywhere, which fail in
  29. UTF-8 based locales. The patch below makes them valid
  30. by falling back to English messages when a multibyte locale is in use:</para>
  31. <screen><userinput>patch -Np1 -i ../&texinfo-multibyte-patch;</userinput></screen>
  32. <para>Texinfo allows local users to overwrite arbitrary files via a symlink
  33. attack on temporary files. Apply the following patch to fix this:</para>
  34. <screen><userinput>patch -Np1 -i ../&texinfo-tempfile_fix-patch;</userinput></screen>
  35. <para>Prepare Texinfo for compilation:</para>
  36. <screen><userinput>./configure --prefix=/usr</userinput></screen>
  37. <para>Compile the package:</para>
  38. <screen><userinput>make</userinput></screen>
  39. <para>To test the results, issue:
  40. <userinput>make check</userinput>.</para>
  41. <para>Install the package:</para>
  42. <screen><userinput>make install</userinput></screen>
  43. <para>Optionally, install the components belonging in a TeX installation:</para>
  44. <screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen>
  45. <para>The meaning of the make parameter:</para>
  46. <variablelist>
  47. <varlistentry>
  48. <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
  49. <listitem><para>The <envar>TEXMF</envar> makefile variable holds the location of the
  50. root of the TeX tree if, for example, a TeX package will be installed
  51. later.</para></listitem>
  52. </varlistentry>
  53. </variablelist>
  54. <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->
  55. <para>The Info documentation system uses a plain text file to hold its
  56. list of menu entries. The file is located at
  57. <filename>/usr/share/info/dir</filename>. Unfortunately, due to
  58. occasional problems in the Makefiles of various packages, it can
  59. sometimes get out of sync with the info pages installed on the
  60. system. If the <filename>/usr/share/info/dir</filename> file ever
  61. needs to be recreated, the following optional commands will accomplish
  62. the task:</para>
  63. <screen role="nodump"><userinput>cd /usr/share/info
  64. rm dir
  65. for f in *
  66. do install-info $f dir 2&gt;/dev/null
  67. done</userinput></screen>
  68. </sect2>
  69. <sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title>
  70. <segmentedlist>
  71. <segtitle>Installed programs</segtitle>
  72. <seglistitem><seg>info, infokey, install-info,
  73. makeinfo, texi2dvi, texi2pdf, and texindex</seg></seglistitem>
  74. </segmentedlist>
  75. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  76. <?dbfo list-presentation="list"?>
  77. <?dbhtml list-presentation="table"?>
  78. <varlistentry id="info">
  79. <term><command>info</command></term>
  80. <listitem>
  81. <para>Used to read info pages which are similar to man pages, but often go much
  82. deeper than just explaining all the available command line options. For example,
  83. compare <command>man bison</command> and <command>info bison</command>.</para>
  84. <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm>
  85. </listitem>
  86. </varlistentry>
  87. <varlistentry id="infokey">
  88. <term><command>infokey</command></term>
  89. <listitem>
  90. <para>Compiles a source file containing Info customizations into a
  91. binary format</para>
  92. <indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry id="install-info">
  96. <term><command>install-info</command></term>
  97. <listitem>
  98. <para>Used to install info pages; it updates entries in the
  99. <command>info</command> index file</para>
  100. <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm>
  101. </listitem>
  102. </varlistentry>
  103. <varlistentry id="makeinfo">
  104. <term><command>makeinfo</command></term>
  105. <listitem>
  106. <para>Translates the given Texinfo source documents into
  107. info pages, plain text, or HTML</para>
  108. <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm>
  109. </listitem>
  110. </varlistentry>
  111. <varlistentry id="texi2dvi">
  112. <term><command>texi2dvi</command></term>
  113. <listitem>
  114. <para>Used to format the given Texinfo document into a
  115. device-independent file that can be printed</para>
  116. <indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm>
  117. </listitem>
  118. </varlistentry>
  119. <varlistentry id="texi2pdf">
  120. <term><command>texi2pdf</command></term>
  121. <listitem>
  122. <para>Used to format the given Texinfo document into a
  123. Portable Document Format (PDF) file</para>
  124. <indexterm zone="ch-system-texinfo texi2pdf"><primary sortas="b-texi2pdf">texi2pdf</primary></indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="texindex">
  128. <term><command>texindex</command></term>
  129. <listitem>
  130. <para>Used to sort Texinfo index files</para>
  131. <indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm>
  132. </listitem>
  133. </varlistentry>
  134. </variablelist>
  135. </sect2>
  136. </sect1>