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