texinfo.xml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  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 "a string
  27. occupies the same number of character cells on the screen and bytes in memory"
  28. and "one can break the string anywhere" that are incorrect in UTF-8 locales.
  29. While the patch below is not the proper solution, it at least hides the problem
  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. <para>The Info documentation system uses a plain text file to hold its
  55. list of menu entries. The file is located at
  56. <filename>/usr/share/info/dir</filename>. Unfortunately, due to
  57. occasional problems in the Makefiles of various packages, it can
  58. sometimes get out of sync with the info pages installed on the
  59. system. If the <filename>/usr/share/info/dir</filename> file ever
  60. needs to be recreated, the following optional commands will accomplish
  61. the task:</para>
  62. <screen role="nodump"><userinput>cd /usr/share/info
  63. rm dir
  64. for f in *
  65. do install-info $f dir 2&gt;/dev/null
  66. done</userinput></screen>
  67. </sect2>
  68. <sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title>
  69. <segmentedlist>
  70. <segtitle>Installed programs</segtitle>
  71. <seglistitem><seg>info, infokey, install-info,
  72. makeinfo, texi2dvi, texi2pdf, and texindex</seg></seglistitem>
  73. </segmentedlist>
  74. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  75. <?dbfo list-presentation="list"?>
  76. <?dbhtml list-presentation="table"?>
  77. <varlistentry id="info">
  78. <term><command>info</command></term>
  79. <listitem>
  80. <para>Used to read info pages which are similar to man pages, but often go much
  81. deeper than just explaining all the available command line options. For example,
  82. compare <command>man bison</command> and <command>info bison</command>.</para>
  83. <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm>
  84. </listitem>
  85. </varlistentry>
  86. <varlistentry id="infokey">
  87. <term><command>infokey</command></term>
  88. <listitem>
  89. <para>Compiles a source file containing Info customizations into a
  90. binary format</para>
  91. <indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry id="install-info">
  95. <term><command>install-info</command></term>
  96. <listitem>
  97. <para>Used to install info pages; it updates entries in the
  98. <command>info</command> index file</para>
  99. <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm>
  100. </listitem>
  101. </varlistentry>
  102. <varlistentry id="makeinfo">
  103. <term><command>makeinfo</command></term>
  104. <listitem>
  105. <para>Translates the given Texinfo source documents into
  106. info pages, plain text, or HTML</para>
  107. <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm>
  108. </listitem>
  109. </varlistentry>
  110. <varlistentry id="texi2dvi">
  111. <term><command>texi2dvi</command></term>
  112. <listitem>
  113. <para>Used to format the given Texinfo document into a
  114. device-independent file that can be printed</para>
  115. <indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry id="texi2pdf">
  119. <term><command>texi2pdf</command></term>
  120. <listitem>
  121. <para>Used to format the given Texinfo document into a
  122. Portable Document Format (PDF) file</para>
  123. <indexterm zone="ch-system-texinfo texi2pdf"><primary sortas="b-texi2pdf">texi2pdf</primary></indexterm>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry id="texindex">
  127. <term><command>texindex</command></term>
  128. <listitem>
  129. <para>Used to sort Texinfo index files</para>
  130. <indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm>
  131. </listitem>
  132. </varlistentry>
  133. </variablelist>
  134. </sect2>
  135. </sect1>