[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 |
|
---|
| 44 | <para>The <command>info</command> program makes assumptions such as that
|
---|
| 45 | a string occupies the same number of character cells on the screen and
|
---|
| 46 | bytes in memory and that one can break the string anywhere, which fail
|
---|
| 47 | in UTF-8 based locales. The patch below makes them valid by falling back
|
---|
| 48 | to English messages when a multibyte locale is in use:</para>
|
---|
[fa21b3d] | 49 |
|
---|
| 50 | <screen><userinput>patch -Np1 -i ../&texinfo-multibyte-patch;</userinput></screen>
|
---|
| 51 |
|
---|
[ddd5542] | 52 | <para>Texinfo allows local users to overwrite arbitrary files via a symlink
|
---|
| 53 | attack on temporary files. Apply the following patch to fix this:</para>
|
---|
[50993e3] | 54 |
|
---|
| 55 | <screen><userinput>patch -Np1 -i ../&texinfo-tempfile_fix-patch;</userinput></screen>
|
---|
| 56 |
|
---|
[ddd5542] | 57 | <para>Prepare Texinfo for compilation:</para>
|
---|
[2ca7e114] | 58 |
|
---|
[73aedd1d] | 59 | <screen><userinput>./configure --prefix=/usr</userinput></screen>
|
---|
| 60 |
|
---|
[ddd5542] | 61 | <para>Compile the package:</para>
|
---|
[73aedd1d] | 62 |
|
---|
| 63 | <screen><userinput>make</userinput></screen>
|
---|
| 64 |
|
---|
[ddd5542] | 65 | <para>To test the results, issue:
|
---|
| 66 | <userinput>make check</userinput>.</para>
|
---|
[73aedd1d] | 67 |
|
---|
[ddd5542] | 68 | <para>Install the package:</para>
|
---|
[73aedd1d] | 69 |
|
---|
| 70 | <screen><userinput>make install</userinput></screen>
|
---|
| 71 |
|
---|
[ddd5542] | 72 | <para>Optionally, install the components belonging in a TeX
|
---|
| 73 | installation:</para>
|
---|
| 74 | <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->
|
---|
[73aedd1d] | 75 |
|
---|
| 76 | <screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen>
|
---|
| 77 |
|
---|
[ddd5542] | 78 | <variablelist>
|
---|
| 79 | <title>The meaning of the make parameter:</title>
|
---|
| 80 |
|
---|
| 81 | <varlistentry>
|
---|
| 82 | <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
|
---|
| 83 | <listitem>
|
---|
| 84 | <para>The <envar>TEXMF</envar> makefile variable holds the location
|
---|
| 85 | of the root of the TeX tree if, for example, a TeX package will be
|
---|
| 86 | installed later.</para>
|
---|
| 87 | </listitem>
|
---|
| 88 | </varlistentry>
|
---|
| 89 |
|
---|
| 90 | </variablelist>
|
---|
| 91 |
|
---|
| 92 | <para>The Info documentation system uses a plain text file to hold its list of
|
---|
| 93 | menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
|
---|
| 94 | Unfortunately, due to occasional problems in the Makefiles of various packages,
|
---|
| 95 | it can sometimes get out of sync with the info pages installed on the system.
|
---|
| 96 | If the <filename>/usr/share/info/dir</filename> file ever needs to be
|
---|
| 97 | recreated, the following optional commands will accomplish the task:</para>
|
---|
[554b366] | 98 |
|
---|
[de92788] | 99 | <screen role="nodump"><userinput>cd /usr/share/info
|
---|
[554b366] | 100 | rm dir
|
---|
| 101 | for f in *
|
---|
[673b0d8] | 102 | do install-info $f dir 2>/dev/null
|
---|
[554b366] | 103 | done</userinput></screen>
|
---|
| 104 |
|
---|
[ddd5542] | 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 id="contents-texinfo" role="content">
|
---|
| 108 | <title>Contents of Texinfo</title>
|
---|
| 109 |
|
---|
| 110 | <segmentedlist>
|
---|
| 111 | <segtitle>Installed programs</segtitle>
|
---|
| 112 |
|
---|
| 113 | <seglistitem>
|
---|
| 114 | <seg>info, infokey, install-info, makeinfo, texi2dvi, texi2pdf, and
|
---|
| 115 | texindex</seg>
|
---|
| 116 | </seglistitem>
|
---|
| 117 | </segmentedlist>
|
---|
| 118 |
|
---|
| 119 | <variablelist>
|
---|
| 120 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 121 | <?dbfo list-presentation="list"?>
|
---|
| 122 | <?dbhtml list-presentation="table"?>
|
---|
| 123 |
|
---|
| 124 | <varlistentry id="info">
|
---|
| 125 | <term><command>info</command></term>
|
---|
| 126 | <listitem>
|
---|
| 127 | <para>Used to read info pages which are similar to man pages, but
|
---|
| 128 | often go much deeper than just explaining all the available command
|
---|
| 129 | line options. For example, compare <command>man bison</command> and
|
---|
| 130 | <command>info bison</command>.</para>
|
---|
| 131 | <indexterm zone="ch-system-texinfo info">
|
---|
| 132 | <primary sortas="b-info">info</primary>
|
---|
| 133 | </indexterm>
|
---|
| 134 | </listitem>
|
---|
| 135 | </varlistentry>
|
---|
| 136 |
|
---|
| 137 | <varlistentry id="infokey">
|
---|
| 138 | <term><command>infokey</command></term>
|
---|
| 139 | <listitem>
|
---|
| 140 | <para>Compiles a source file containing Info customizations into a
|
---|
| 141 | binary format</para>
|
---|
| 142 | <indexterm zone="ch-system-texinfo infokey">
|
---|
| 143 | <primary sortas="b-infokey">infokey</primary>
|
---|
| 144 | </indexterm>
|
---|
| 145 | </listitem>
|
---|
| 146 | </varlistentry>
|
---|
| 147 |
|
---|
| 148 | <varlistentry id="install-info">
|
---|
| 149 | <term><command>install-info</command></term>
|
---|
| 150 | <listitem>
|
---|
| 151 | <para>Used to install info pages; it updates entries in the
|
---|
| 152 | <command>info</command> index file</para>
|
---|
| 153 | <indexterm zone="ch-system-texinfo install-info">
|
---|
| 154 | <primary sortas="b-install-info">install-info</primary>
|
---|
| 155 | </indexterm>
|
---|
| 156 | </listitem>
|
---|
| 157 | </varlistentry>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="makeinfo">
|
---|
| 160 | <term><command>makeinfo</command></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>Translates the given Texinfo source documents into
|
---|
| 163 | info pages, plain text, or HTML</para>
|
---|
| 164 | <indexterm zone="ch-system-texinfo makeinfo">
|
---|
| 165 | <primary sortas="b-makeinfo">makeinfo</primary>
|
---|
| 166 | </indexterm>
|
---|
| 167 | </listitem>
|
---|
| 168 | </varlistentry>
|
---|
| 169 |
|
---|
| 170 | <varlistentry id="texi2dvi">
|
---|
| 171 | <term><command>texi2dvi</command></term>
|
---|
| 172 | <listitem>
|
---|
| 173 | <para>Used to format the given Texinfo document into a
|
---|
| 174 | device-independent file that can be printed</para>
|
---|
| 175 | <indexterm zone="ch-system-texinfo texi2dvi">
|
---|
| 176 | <primary sortas="b-texi2dvi">texi2dvi</primary>
|
---|
| 177 | </indexterm>
|
---|
| 178 | </listitem>
|
---|
| 179 | </varlistentry>
|
---|
| 180 |
|
---|
| 181 | <varlistentry id="texi2pdf">
|
---|
| 182 | <term><command>texi2pdf</command></term>
|
---|
| 183 | <listitem>
|
---|
| 184 | <para>Used to format the given Texinfo document into a
|
---|
| 185 | Portable Document Format (PDF) file</para>
|
---|
| 186 | <indexterm zone="ch-system-texinfo texi2pdf">
|
---|
| 187 | <primary sortas="b-texi2pdf">texi2pdf</primary>
|
---|
| 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
| 192 | <varlistentry id="texindex">
|
---|
| 193 | <term><command>texindex</command></term>
|
---|
| 194 | <listitem>
|
---|
| 195 | <para>Used to sort Texinfo index files</para>
|
---|
| 196 | <indexterm zone="ch-system-texinfo texindex">
|
---|
| 197 | <primary sortas="b-texindex">texindex</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 | </listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
| 202 | </variablelist>
|
---|
| 203 |
|
---|
| 204 | </sect2>
|
---|
[673b0d8] | 205 |
|
---|
| 206 | </sect1>
|
---|