Changeset e02afe0 for chapter06/texinfo.xml
- Timestamp:
- 02/10/2006 07:38:49 PM (19 years ago)
- Children:
- 851829a
- Parents:
- 529c103
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
chapter06/texinfo.xml
r529c103 re02afe0 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-texinfo" role="wrap"> 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> 11 12 <sect2 role="package"><title/> 13 <para>The Texinfo package contains programs for reading, writing, and 14 converting info pages.</para> 15 16 <segmentedlist> 17 <segtitle>&buildtime;</segtitle> 18 <segtitle>&diskspace;</segtitle> 19 <seglistitem><seg>0.2 SBU</seg><seg>14.7 MB</seg></seglistitem> 20 </segmentedlist> 21 22 <segmentedlist> 23 <segtitle>&dependencies;</segtitle> 24 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, 25 Glibc, Grep, Make, Ncurses, Patch, and Sed</seg></seglistitem> 26 </segmentedlist> 27 </sect2> 28 29 <sect2 role="installation"> 30 <title>Installation of Texinfo</title> 31 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> 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> 22 23 <segmentedlist> 24 <segtitle>&buildtime;</segtitle> 25 <segtitle>&diskspace;</segtitle> 26 27 <seglistitem> 28 <seg>0.2 SBU</seg> 29 <seg>14.7 MB</seg> 30 </seglistitem> 31 </segmentedlist> 32 33 <segmentedlist> 34 <segtitle>&dependencies;</segtitle> 35 36 <seglistitem> 37 <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc, 38 Grep, Make, Ncurses, Patch, and Sed</seg> 39 </seglistitem> 40 </segmentedlist> 41 42 </sect2> 43 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> 37 52 38 53 <screen><userinput>patch -Np1 -i ../&texinfo-multibyte-patch;</userinput></screen> 39 54 40 <para>Texinfo allows local users to overwrite arbitrary files via a symlink41 attack on temporary files. Apply the following patch to fix this:</para>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> 42 57 43 58 <screen><userinput>patch -Np1 -i ../&texinfo-tempfile_fix-patch;</userinput></screen> 44 59 45 <para>Prepare Texinfo for compilation:</para>60 <para>Prepare Texinfo for compilation:</para> 46 61 47 62 <screen><userinput>./configure --prefix=/usr</userinput></screen> 48 63 49 <para>Compile the package:</para>64 <para>Compile the package:</para> 50 65 51 66 <screen><userinput>make</userinput></screen> 52 67 53 <para>To test the results, issue:54 <userinput>make check</userinput>.</para>55 56 <para>Install the package:</para>68 <para>To test the results, issue: 69 <userinput>make check</userinput>.</para> 70 71 <para>Install the package:</para> 57 72 58 73 <screen><userinput>make install</userinput></screen> 59 74 60 <para>Optionally, install the components belonging in a TeX installation:</para> 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? --> 61 78 62 79 <screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen> 63 80 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>74 <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->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 80 sometimes get out of sync with the info pages installed on the 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>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> 84 101 85 102 <screen role="nodump"><userinput>cd /usr/share/info … … 89 106 done</userinput></screen> 90 107 91 </sect2> 92 93 <sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title> 94 95 <segmentedlist> 96 <segtitle>Installed programs</segtitle> 97 <seglistitem><seg>info, infokey, install-info, 98 makeinfo, texi2dvi, texi2pdf, and texindex</seg></seglistitem> 99 </segmentedlist> 100 101 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 102 <?dbfo list-presentation="list"?> 103 <?dbhtml list-presentation="table"?> 104 105 <varlistentry id="info"> 106 <term><command>info</command></term> 107 <listitem> 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> 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> 127 <para>Used to install info pages; it updates entries in the 128 <command>info</command> index file</para> 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 137 info pages, plain text, or HTML</para> 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 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 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> 168 169 </sect2> 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> 170 208 171 209 </sect1> 172
Note:
See TracChangeset
for help on using the changeset viewer.