source: chapter06/texinfo.xml@ 1f1055a

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 7.10 7.10-rc1 7.9 8.0 8.0-rc1 8.1 8.1-rc1 8.1-rc2 8.2 8.2-rc1 8.3 8.3-rc1 8.3-rc2 8.4 8.4-rc1 9.0 9.0-rc1 9.1 9.1-rc1 BOOK.old cross-chap5 ml-11.0 multilib nosym old-trunk trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since 1f1055a was 1f1055a, checked in by Bruce Dubbs <bdubbs@…>, 6 years ago

Document texinfo installed library

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@11032 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 7.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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-ch6-sbu;</seg>
35 <seg>&texinfo-ch6-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 --disable-static</userinput></screen>
47
48 <para>Compile the package:</para>
49
50<screen><userinput remap="make">make</userinput></screen>
51
52 <para>To test the results, issue:</para>
53
54<screen><userinput remap="test">make check</userinput></screen>
55
56 <para>Install the package:</para>
57
58<screen><userinput remap="install">make install</userinput></screen>
59
60 <para>Optionally, install the components belonging in a TeX
61 installation:</para>
62 <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->
63
64<screen><userinput remap="install">make TEXMF=/usr/share/texmf install-tex</userinput></screen>
65
66 <variablelist>
67 <title>The meaning of the make parameter:</title>
68
69 <varlistentry>
70 <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
71 <listitem>
72 <para>The <envar>TEXMF</envar> makefile variable holds the location
73 of the root of the TeX tree if, for example, a TeX package will be
74 installed later.</para>
75 </listitem>
76 </varlistentry>
77
78 </variablelist>
79
80 <para>The Info documentation system uses a plain text file to hold its list of
81 menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
82 Unfortunately, due to occasional problems in the Makefiles of various packages,
83 it can sometimes get out of sync with the info pages installed on the system.
84 If the <filename>/usr/share/info/dir</filename> file ever needs to be
85 recreated, the following optional commands will accomplish the task:</para>
86
87<screen role="nodump"><userinput>pushd /usr/share/info
88rm -v dir
89for f in *
90 do install-info $f dir 2&gt;/dev/null
91done
92popd</userinput></screen>
93
94 </sect2>
95
96 <sect2 id="contents-texinfo" role="content">
97 <title>Contents of Texinfo</title>
98
99 <segmentedlist>
100 <segtitle>Installed programs</segtitle>
101 <segtitle>Installed library</segtitle>
102 <segtitle>Installed directories</segtitle>
103
104 <seglistitem>
105 <seg>info, install-info, makeinfo (link to texi2any),
106 pdftexi2dvi, pod2texi, texi2any, texi2dvi, texi2pdf, and texindex</seg>
107 <seg>XSParagraph.so</seg>
108 <seg>/usr/share/texinfo and /usr/lib/texinfo</seg>
109 </seglistitem>
110 </segmentedlist>
111
112 <variablelist>
113 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
114 <?dbfo list-presentation="list"?>
115 <?dbhtml list-presentation="table"?>
116
117 <varlistentry id="info">
118 <term><command>info</command></term>
119 <listitem>
120 <para>Used to read info pages which are similar to man pages, but
121 often go much deeper than just explaining all the available command
122 line options [For example, compare <command>man bison</command> and
123 <command>info bison</command>.]</para>
124 <indexterm zone="ch-system-texinfo info">
125 <primary sortas="b-info">info</primary>
126 </indexterm>
127 </listitem>
128 </varlistentry>
129
130 <varlistentry id="install-info">
131 <term><command>install-info</command></term>
132 <listitem>
133 <para>Used to install info pages; it updates entries in the
134 <command>info</command> index file</para>
135 <indexterm zone="ch-system-texinfo install-info">
136 <primary sortas="b-install-info">install-info</primary>
137 </indexterm>
138 </listitem>
139 </varlistentry>
140
141 <varlistentry id="makeinfo">
142 <term><command>makeinfo</command></term>
143 <listitem>
144 <para>Translates the given Texinfo source documents into
145 info pages, plain text, or HTML</para>
146 <indexterm zone="ch-system-texinfo makeinfo">
147 <primary sortas="b-makeinfo">makeinfo</primary>
148 </indexterm>
149 </listitem>
150 </varlistentry>
151
152 <varlistentry id="pdftexi2dvi">
153 <term><command>pdftexi2dvi</command></term>
154 <listitem>
155 <para>Used to format the given Texinfo document into a
156 Portable Document Format (PDF) file</para>
157 <indexterm zone="ch-system-texinfo pdftexi2dvi">
158 <primary sortas="b-pdftexi2dvi">pdftexi2dvi</primary>
159 </indexterm>
160 </listitem>
161 </varlistentry>
162
163 <varlistentry id="pod2texi">
164 <term><command>pod2texi</command></term>
165 <listitem>
166 <para>Converts Pod to Texinfo format</para>
167 <indexterm zone="ch-system-texinfo pod2texi">
168 <primary sortas="b-pod2texi">pod2texi</primary>
169 </indexterm>
170 </listitem>
171 </varlistentry>
172
173 <varlistentry id="texi2any">
174 <term><command>texi2any</command></term>
175 <listitem>
176 <para>Translate Texinfo source documentation to
177 various other formats</para>
178 <indexterm zone="ch-system-texinfo texi2any">
179 <primary sortas="b-texiany">texi2any</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184 <varlistentry id="texi2dvi">
185 <term><command>texi2dvi</command></term>
186 <listitem>
187 <para>Used to format the given Texinfo document into a
188 device-independent file that can be printed</para>
189 <indexterm zone="ch-system-texinfo texi2dvi">
190 <primary sortas="b-texi2dvi">texi2dvi</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="texi2pdf">
196 <term><command>texi2pdf</command></term>
197 <listitem>
198 <para>Used to format the given Texinfo document into a
199 Portable Document Format (PDF) file</para>
200 <indexterm zone="ch-system-texinfo texi2pdf">
201 <primary sortas="b-texi2pdf">texi2pdf</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="texindex">
207 <term><command>texindex</command></term>
208 <listitem>
209 <para>Used to sort Texinfo index files</para>
210 <indexterm zone="ch-system-texinfo texindex">
211 <primary sortas="b-texindex">texindex</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 </variablelist>
217
218 </sect2>
219
220</sect1>
Note: See TracBrowser for help on using the repository browser.