texinfo.xml 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-texinfo" xreflabel="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 documents.</para>
  13. <segmentedlist>
  14. <segtitle>&buildtime;</segtitle>
  15. <segtitle>&diskspace;</segtitle>
  16. <seglistitem><seg>0.2 SBU</seg><seg>17 MB</seg></seglistitem>
  17. </segmentedlist>
  18. <segmentedlist>
  19. <segtitle>Texinfo installation depends on</segtitle>
  20. <seglistitem><seg>Bash, Binutils, Coreutils,
  21. Diffutils, GCC, Gettext, Glibc, Grep, Make, Ncurses, Sed</seg></seglistitem>
  22. </segmentedlist>
  23. </sect2>
  24. <sect2 role="installation">
  25. <title>Installation of Texinfo</title>
  26. <para>Prepare Texinfo for compilation:</para>
  27. <screen><userinput>./configure --prefix=/usr</userinput></screen>
  28. <para>Compile the package:</para>
  29. <screen><userinput>make</userinput></screen>
  30. <para>To test the results, issue:
  31. <userinput>make check</userinput>.</para>
  32. <para>Install the package:</para>
  33. <screen><userinput>make install</userinput></screen>
  34. <para>Optionally install the components belonging in a TeX installation:</para>
  35. <screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen>
  36. <para>The meaning of the make parameter:</para>
  37. <itemizedlist>
  38. <listitem><para><userinput>TEXMF=/usr/share/texmf</userinput>: The TEXMF
  39. makefile variable holds the location of the root of your TeX tree if, for
  40. example, you plan to install a TeX package later on.</para></listitem>
  41. </itemizedlist>
  42. <para>The Info documentation system uses a plain text file to hold its list of
  43. menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
  44. Unfortunately, due to occasional problems in the Makefiles of various packages,
  45. it can sometimes get out of step with the Info manuals actually installed on the
  46. system. If ever you need to recreate the
  47. <filename>/usr/share/info/dir</filename> file, the following optional commands
  48. will accomplish the task:</para>
  49. <screen><userinput>cd /usr/share/info
  50. rm dir
  51. for f in *
  52. do install-info $f dir 2&gt;/dev/null
  53. done</userinput></screen>
  54. </sect2>
  55. <sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title>
  56. <segmentedlist>
  57. <segtitle>Installed programs</segtitle>
  58. <seglistitem><seg>info, infokey, install-info,
  59. makeinfo, texi2dvi and texindex</seg></seglistitem>
  60. </segmentedlist>
  61. <variablelist><title>Short descriptions</title>
  62. <varlistentry>
  63. <term id="info"><command>info</command></term>
  64. <listitem>
  65. <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm>
  66. <para>is used to read Info documents. Info
  67. documents are a bit like man pages, but often go much deeper than just
  68. explaining all the flags. Compare for example man tar and info tar.</para>
  69. </listitem>
  70. </varlistentry>
  71. <varlistentry>
  72. <term id="infokey"><command>infokey</command></term>
  73. <listitem>
  74. <indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm>
  75. <para>compiles a source file containing Info
  76. customizations into a binary format.</para>
  77. </listitem>
  78. </varlistentry>
  79. <varlistentry>
  80. <term id="install-info"><command>install-info</command></term>
  81. <listitem>
  82. <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm>
  83. <para>is used to install Info files. It updates entries in the Info index file.</para>
  84. </listitem>
  85. </varlistentry>
  86. <varlistentry>
  87. <term id="makeinfo"><command>makeinfo</command></term>
  88. <listitem>
  89. <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm>
  90. <para>translates the given Texinfo source
  91. documents into various other formats: Info files, plain text, or HTML.</para>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry>
  95. <term id="texi2dvi"><command>texi2dvi</command></term>
  96. <listitem>
  97. <indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm>
  98. <para>is used to format the given Texinfo
  99. document into a device-independent file that can be printed.</para>
  100. </listitem>
  101. </varlistentry>
  102. <varlistentry>
  103. <term id="texindex"><command>texindex</command></term>
  104. <listitem>
  105. <indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm>
  106. <para>is used to sort Texinfo index files.</para>
  107. </listitem>
  108. </varlistentry>
  109. </variablelist>
  110. </sect2>
  111. </sect1>