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