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