source: BOOK/final-system/common/texinfo.xml @ 3373dd11

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 3373dd11 was 3373dd11, checked in by Jim Gifford <clfs@…>, 18 years ago

r668@server (orig r666): manuel | 2005-11-08 15:25:13 -0800
Removing SBUs and DUs. Chapter final-system, round 6.

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