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