diff options
Diffstat (limited to 'chapter06/texinfo.xml')
-rw-r--r-- | chapter06/texinfo.xml | 99 |
1 files changed, 93 insertions, 6 deletions
diff --git a/chapter06/texinfo.xml b/chapter06/texinfo.xml index 65b0a6d9d..7560a62a0 100644 --- a/chapter06/texinfo.xml +++ b/chapter06/texinfo.xml @@ -3,13 +3,15 @@ <!ENTITY % general-entities SYSTEM "../general.ent"> %general-entities; ]> -<sect1 id="ch-system-texinfo" xreflabel="Texinfo" role="wrap"> +<sect1 id="ch-system-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> @@ -17,6 +19,11 @@ <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, and Sed</seg></seglistitem> +</segmentedlist> </sect2> <sect2 role="installation"> @@ -37,12 +44,29 @@ <screen><userinput>make install</userinput></screen> -<para>Optionally install the components belonging in a TeX installation:</para> +<para>Optionally, install the components belonging in a TeX installation:</para> <screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen> -<para>If ever you need to recreate the -<filename>/usr/share/info/dir</filename> file, run this:</para> +<para>The meaning of the make parameter:</para> + +<variablelist> +<varlistentry> +<term><parameter>TEXMF=/usr/share/texmf</parameter></term> +<listitem><para>The <envar>TEXMF</envar> makefile variable holds the location of the +root of the TeX tree if, for example, a TeX package will be installed +later.</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 installed on the +system. If the <filename>/usr/share/info/dir</filename> file ever +needs to be recreated, the following optional commands will accomplish +the task:</para> <screen><userinput>cd /usr/share/info rm dir @@ -52,11 +76,74 @@ done</userinput></screen> </sect2> - <sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title> -<para>See testing</para> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>info, infokey, install-info, +makeinfo, texi2dvi, and texindex</seg></seglistitem> +</segmentedlist> + +<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> +<?dbfo list-presentation="list"?> + +<varlistentry id="info"> +<term><command>info</command></term> +<listitem> +<para>Used to read Info documents which are similar to man +pages, but often go much deeper than just explaining all the command +line options. For example, compare <command>man bison</command> and +<command>info bison</command>.</para> +<indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="infokey"> +<term><command>infokey</command></term> +<listitem> +<para>Compiles a source file containing Info customizations into a +binary format</para> +<indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="install-info"> +<term><command>install-info</command></term> +<listitem> +<para>Used to install Info files; it updates entries in the Info index +file</para> +<indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="makeinfo"> +<term><command>makeinfo</command></term> +<listitem> +<para>Translates the given Texinfo source documents into +info files, plain text, or HTML</para> +<indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="texi2dvi"> +<term><command>texi2dvi</command></term> +<listitem> +<para>Used to format the given Texinfo document into a +device-independent file that can be printed</para> +<indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="texindex"> +<term><command>texindex</command></term> +<listitem> +<para>Used to sort Texinfo index files</para> +<indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm> +</listitem> +</varlistentry> +</variablelist> </sect2> </sect1> + |