source: chapter06/texinfo.xml@ 5e81f02

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<sect1 id="ch-system-texinfo" xreflabel="Texinfo" role="wrap">
<title>Texinfo-&texinfo-version;</title>
<?dbhtml filename="texinfo.html"?>

<indexterm zone="ch-system-texinfo"><primary sortas="a-Texinfo">Texinfo</primary></indexterm>

<sect2 role="package"><title/>
<para>The Texinfo package contains programs for reading, writing, and
converting Info documents.</para>

<segmentedlist>
<segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.2 SBU</seg><seg>17 MB</seg></seglistitem>
</segmentedlist>

<segmentedlist>
<segtitle>Texinfo installation depends on</segtitle>
<seglistitem><seg>Bash, Binutils, Coreutils,
Diffutils, GCC, Gettext, Glibc, Grep, Make, Ncurses, Sed</seg></seglistitem>
</segmentedlist>
</sect2>

<sect2 role="installation">
<title>Installation of Texinfo</title>

<para>Prepare Texinfo for compilation:</para>

<screen><userinput>./configure --prefix=/usr</userinput></screen>

<para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>To test the results, issue:
<userinput>make check</userinput>.</para>

<para>Install the package:</para>

<screen><userinput>make install</userinput></screen>

<para>Optionally install the components belonging in a TeX installation:</para>

<screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen>

<para>The meaning of the make parameter:</para>

<variablelist>
<varlistentry>
<term><parameter>TEXMF=/usr/share/texmf</parameter></term>
<listitem><para>The TEXMF
makefile variable holds the location of the root of your TeX tree if, for
example, you plan to install a TeX package later on.</para></listitem>
</varlistentry>
</variablelist>

<para>The Info documentation system uses a plain text file to hold its list of
menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
Unfortunately, due to occasional problems in the Makefiles of various packages,
it can sometimes get out of step with the Info manuals actually installed on the
system. If ever you need to recreate the
<filename>/usr/share/info/dir</filename> file, the following optional commands
will accomplish the task:</para>

<screen><userinput>cd /usr/share/info
rm dir
for f in *
do install-info $f dir 2&gt;/dev/null
done</userinput></screen>

</sect2>


<sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title>

<segmentedlist>
<segtitle>Installed programs</segtitle>
<seglistitem><seg>info, infokey, install-info,
makeinfo, texi2dvi and texindex</seg></seglistitem>
</segmentedlist>

<variablelist><title>Short descriptions</title>

<varlistentry id="info">
<term><command>info</command></term>
<listitem>
<indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm>
<para>is used to read Info documents. Info
documents are a bit like man pages, but often go much deeper than just
explaining all the flags. Compare for example <command>man tar</command>
and <command>info tar</command>.</para>
</listitem>
</varlistentry>

<varlistentry id="infokey">
<term><command>infokey</command></term>
<listitem>
<indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm>
<para>compiles a source file containing Info
customizations into a binary format.</para>
</listitem>
</varlistentry>

<varlistentry id="install-info">
<term><command>install-info</command></term>
<listitem>
<indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm>
<para>is used to install Info files. It updates entries in the Info index file.</para>
</listitem>
</varlistentry>

<varlistentry id="makeinfo">
<term><command>makeinfo</command></term>
<listitem>
<indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm>
<para>translates the given Texinfo source
documents into various other formats: Info files, plain text, or HTML.</para>
</listitem>
</varlistentry>

<varlistentry id="texi2dvi">
<term><command>texi2dvi</command></term>
<listitem>
<indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm>
<para>is used to format the given Texinfo
document into a device-independent file that can be printed.</para>
</listitem>
</varlistentry>

<varlistentry id="texindex">
<term><command>texindex</command></term>
<listitem>
<indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm>
<para>is used to sort Texinfo index files.</para>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>