source: final-system/common/texinfo.xml @ bf8c11f

Last change on this file since bf8c11f was bf8c11f, checked in by Jim Gifford <clfs@…>, 18 years ago

r627@server (orig r625): jim | 2005-10-31 12:59:34 -0800
Import of Cross-LFS Book

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