source: final-system/common/texinfo.xml @ 0636f6c

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

r981@server (orig r979): jim | 2005-12-30 10:11:32 -0800

r1226@server: cstaub | 2005-12-30 08:35:37 -0800
Updated package deps, removed explanation of cross-compiling from final-system binutils, and removed note about GRUB's testsuite failure


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