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