BOOK/chapter06/texinfo.xml

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