source: clfs-sysroot/BOOK/final-system/common/texinfo.xml @ 586feb7

Last change on this file since 586feb7 was 586feb7, checked in by Joe Ciccone <jciccone@…>, 16 years ago

Updated the bootscripts package and make LFS to CLFS updates.

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